Full Development Guide

  1. Home
  2. Documentation
  3. CEIC Macroeconomic Data API
  4. PHP Documentation
  5. Full Development Guide

API Clients

Namespace: Ceic\Api\Apis

Class: DictionaryApi(\Ceic\Api\ApiClient $apiClient = null)

getApiClient()

Get API client

Returns:

\Ceic\Api\ApiClient

setApiClient(\Ceic\Api\ApiClient $apiClient)

Set the API client

Returns:

DictionaryApi

Parameters:
Name Type Description
$apiClient \Ceic\Api\ApiClient set the API client
getClassificationIndicators($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

List of indicators for specific classification

Returns:

\Ceic\Api\Models\IndicatorsResult

Parameters:
Name Type Description
$id string Classification ID. (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getClassifications($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Classifications list

Returns:

\Ceic\Api\Models\ClassificationsResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getCountries($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

DEPRECATED. Please use `/dictionary/geo`. Countries list

Returns:

\Ceic\Api\Models\CountriesResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getCountrySources($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

List of sources for a specific country

Returns:

\Ceic\Api\Models\SourcesResult

Parameters:
Name Type Description
$id string Country ISO code (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getDictionaries($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Full dictionary list

Returns:

\Ceic\Api\Models\DictionaryResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getFrequencies($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Frequencies list

Returns:

\Ceic\Api\Models\FrequenciesResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getGeo($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Geo list

Returns:

\Ceic\Api\Models\GeoResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getIndicators($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Indicators list

Returns:

\Ceic\Api\Models\IndicatorsResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getLayouts($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

DEPRECATED. Please use `/layout/databases`. Database layouts list

Returns:

\Ceic\Api\Models\LayoutsResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getRegions($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Regions list

Returns:

\Ceic\Api\Models\RegionsResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getReleaseStatuses($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Release schedule statuses list

Returns:

\Ceic\Api\Models\ReleaseStatusesResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getReleaseTypes($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Release schedule types list

Returns:

\Ceic\Api\Models\ReleaseTypesResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getSources($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Sources list

Returns:

\Ceic\Api\Models\SourcesResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getStatuses($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Statuses list

Returns:

\Ceic\Api\Models\StatusesResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getUnits($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Units list

Returns:

\Ceic\Api\Models\UnitsResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getClassificationIndicatorsQuery(\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\IndicatorsResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity Query entity object which contains the search information (required)
getClassificationsQuery(\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\ClassificationsResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity Query entity object which contains the search information (required)
getCountriesQuery(\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\CountriesResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity Query entity object which contains the search information (required)
getCountrySourcesQuery(\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\SourcesResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity Query entity object which contains the search information (required)
getDictionariesQuery(\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\DictionaryResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity Query entity object which contains the search information (required)
getFrequenciesQuery(\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\FrequenciesResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity Query entity object which contains the search information (required)
getGeoQuery(\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\GeoResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity Query entity object which contains the search information (required)
getIndicatorsQuery(\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\IndicatorsResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity Query entity object which contains the search information (required)
getLayoutsQuery(\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\LayoutsResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity Query entity object which contains the search information (required)
getRegionsQuery(\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\RegionsResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity Query entity object which contains the search information (required)
getReleaseStatusesQuery(\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\ReleaseStatusesResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity Query entity object which contains the search information (required)
getReleaseTypesQuery(\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\ReleaseTypesResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity Query entity object which contains the search information (required)
getSourcesQuery(\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\SourcesResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity Query entity object which contains the search information (required)
getStatusesQuery(\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\StatusesResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity Query entity object which contains the search information (required)
getUnitsQuery(\Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\UnitsResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\DictionaryApiQueryEntity Query entity object which contains the search information (required)

Namespace: Ceic\Api\Apis

Class: DumpsApi(\Ceic\Api\ApiClient $apiClient = null)

getApiClient()

Get API client

Returns:

\Ceic\Api\ApiClient

setApiClient(\Ceic\Api\ApiClient $apiClient)

Set the API client

Returns:

DumpsApi

Parameters:
Name Type Description
$apiClient \Ceic\Api\ApiClient set the API client
cancelDump($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Cancel dump

Returns:

\Ceic\Api\Models\DumpResult

Parameters:
Name Type Description
$id string Dump ID (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
createDataDump($filterId, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $name = null, $description = null, $consolidation = null, $delivery = null, $userFtpUrl = null, $userFtpPath = null, $userFtpUsername = null, $userFtpPassword = null, $notificationEmail = null, $notificationUrl = null, $notificationHttpMethod = null)

Create dump

Returns:

\Ceic\Api\Models\DumpResult

Parameters:
Name Type Description
$filterId string Filter ID (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$name string Name of the new record. Max length 100 (optional)
$description string Description of the new record. Max length 1000 (optional)
$consolidation string Consolidation Method (optional, default to zip)
$delivery string Delivery Method (optional, default to web)
$userFtpUrl string Result delivery URL for local FTP server. Only valid when the localftp delivery method is selected. (optional)
$userFtpPath string Result delivery path for local FTP server. Only valid when the localftp delivery method is selected. (optional, default to /ceic_data_dumps/)
$userFtpUsername string Username for the local FTP server. Only valid when the localftp delivery method is selected. (optional)
$userFtpPassword string Password for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. (optional)
$notificationEmail string When set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. (optional)
$notificationUrl string URL for push notification upon dump completion. (optional)
$notificationHttpMethod string HTTP Method for push notifications. (optional, default to GET)
getDataDump($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Get dump

Returns:

\Ceic\Api\Models\DumpResult

Parameters:
Name Type Description
$id string Dump ID (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
listUserDumps($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $offset = null, $limit = null, $createdAfter = null, $createdBefore = null, $filterId = null, $createdOrder = null, $status = null, $feedId = null)

List dumps

Returns:

\Ceic\Api\Models\DumpListResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$offset float The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$limit float Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$createdAfter \DateTime Will return entries created after `created_after` date (optional)
$createdBefore \DateTime Will return entries created after `created_before` date (optional)
$filterId string Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional)
$createdOrder string Choose whether to order the entries ascending or descending. Default is Ascending (optional, default to ASC)
$status string[] Dump status (optional)
$feedId string Feed ID (optional)
cancelDumpQuery(\Ceic\Api\Models\QueryEntities\DumpsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\DumpResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\DumpsApiQueryEntity Query entity object which contains the search information (required)
createDataDumpQuery(\Ceic\Api\Models\QueryEntities\DumpsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\DumpResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\DumpsApiQueryEntity Query entity object which contains the search information (required)
getDataDumpQuery(\Ceic\Api\Models\QueryEntities\DumpsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\DumpResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\DumpsApiQueryEntity Query entity object which contains the search information (required)
listUserDumpsQuery(\Ceic\Api\Models\QueryEntities\DumpsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\DumpListResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\DumpsApiQueryEntity Query entity object which contains the search information (required)

Namespace: Ceic\Api\Apis

Class: FeedsApi(\Ceic\Api\ApiClient $apiClient = null)

getApiClient()

Get API client

Returns:

\Ceic\Api\ApiClient

setApiClient(\Ceic\Api\ApiClient $apiClient)

Set the API client

Returns:

FeedsApi

Parameters:
Name Type Description
$apiClient \Ceic\Api\ApiClient set the API client
createFeed($filterId, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $name = null, $description = null, $consolidation = null, $delivery = null, $userFtpUrl = null, $userFtpPath = null, $userFtpUsername = null, $userFtpPassword = null, $notificationEmail = null, $notificationUrl = null, $notificationHttpMethod = null, $frequency = null, $fullDump = null)

Subscribe for a feed

Returns:

\Ceic\Api\Models\FeedResult

Parameters:
Name Type Description
$filterId string Filter ID (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$name string Name of the new record. Max length 100 (optional)
$description string Description of the new record. Max length 1000 (optional)
$consolidation string Consolidation Method (optional, default to zip)
$delivery string Delivery Method (optional, default to web)
$userFtpUrl string Result delivery URL for local FTP server. Only valid when the localftp delivery method is selected. (optional)
$userFtpPath string Result delivery path for local FTP server. Only valid when the localftp delivery method is selected. (optional, default to /ceic_data_dumps/)
$userFtpUsername string Username for the local FTP server. Only valid when the localftp delivery method is selected. (optional)
$userFtpPassword string Password for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. (optional)
$notificationEmail string When set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. (optional)
$notificationUrl string URL for push notification upon dump completion. (optional)
$notificationHttpMethod string HTTP Method for push notifications. (optional, default to GET)
$frequency int Feed generation frequency (optional, default to 1440)
$fullDump bool When set to true, the feed will always generate full list of time points. This option is only available for lists that are equal or less than 3,000 series. (optional, default to false)
deleteFeed($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Delete feed

Returns:

\Ceic\Api\Models\FeedInformation

Parameters:
Name Type Description
$id string Feed ID (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getFeed($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Get feed

Returns:

\Ceic\Api\Models\FeedInformation

Parameters:
Name Type Description
$id string Feed ID (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getFeeds($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $offset = null, $limit = null, $createdAfter = null, $createdBefore = null, $filterId = null, $createdOrder = null, $status = null)

List all feed subscriptions

Returns:

\Ceic\Api\Models\FeedsResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$offset float The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$limit float Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$createdAfter \DateTime Will return entries created after `created_after` date (optional)
$createdBefore \DateTime Will return entries created after `created_before` date (optional)
$filterId string Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional)
$createdOrder string Choose whether to order the entries ascending or descending. Default is Ascending (optional, default to ASC)
$status string[] Feed status (optional)
updateFeed($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $name = null, $description = null, $consolidation = null, $delivery = null, $userFtpUrl = null, $userFtpPath = null, $userFtpUsername = null, $userFtpPassword = null, $notificationEmail = null, $notificationUrl = null, $notificationHttpMethod = null, $frequency = null, $fullDump = null, $status = null, $filterId = null)

Update feed

Returns:

\Ceic\Api\Models\FeedInformation

Parameters:
Name Type Description
$id string Feed ID (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$name string Name of the new record. Max length 100 (optional)
$description string Description of the new record. Max length 1000 (optional)
$consolidation string Consolidation Method (optional, default to zip)
$delivery string Delivery Method (optional, default to web)
$userFtpUrl string Result delivery URL for local FTP server. Only valid when the localftp delivery method is selected. (optional)
$userFtpPath string Result delivery path for local FTP server. Only valid when the localftp delivery method is selected. (optional, default to /ceic_data_dumps/)
$userFtpUsername string Username for the local FTP server. Only valid when the localftp delivery method is selected. (optional)
$userFtpPassword string Password for the local FTP server. Only valid when the localftp delivery method is selected and if local_ftp_username is specified. (optional)
$notificationEmail string When set, the user will receive notifications by the e-mail address specified. Multiple comma separated e-mail addresses could be set. (optional)
$notificationUrl string URL for push notification upon dump completion. (optional)
$notificationHttpMethod string HTTP Method for push notifications. (optional, default to GET)
$frequency int Feed generation frequency (optional, default to 1440)
$fullDump bool When set to true, the feed will always generate full list of time points. This option is only available for lists that are equal or less than 3,000 series. (optional, default to false)
$status string Feed status (optional)
$filterId string Filter ID (optional)
createFeedQuery(\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\FeedResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity Query entity object which contains the search information (required)
deleteFeedQuery(\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\FeedInformation

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity Query entity object which contains the search information (required)
getFeedQuery(\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\FeedInformation

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity Query entity object which contains the search information (required)
getFeedsQuery(\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\FeedsResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity Query entity object which contains the search information (required)
updateFeedQuery(\Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\FeedInformation

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\FeedsApiQueryEntity Query entity object which contains the search information (required)

Namespace: Ceic\Api\Apis

Class: FiltersApi(\Ceic\Api\ApiClient $apiClient = null)

getApiClient()

Get API client

Returns:

\Ceic\Api\ApiClient

setApiClient(\Ceic\Api\ApiClient $apiClient)

Set the API client

Returns:

FiltersApi

Parameters:
Name Type Description
$apiClient \Ceic\Api\ApiClient set the API client
createFilter($accept = null, $format = null, $token = null, $withModelInformation = null, $forecastOnly = null, $withReleaseOnly = null, $withReplacementsOnly = null, $withObservationsOnly = null, $series = null, $name = null, $description = null, $keyword = null, $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = null, $keyOnly = null, $newOnly = null, $nameOnly = null, $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $geo = null, $topic = null, $section = null, $table = null, $status = null, $order = null, $database = null, $direction = null)

Create a filter

Returns:

\Ceic\Api\Models\FilterResult

Parameters:
Name Type Description
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$forecastOnly bool If it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnly bool If it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnly bool If it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnly bool If it is `true` result will not contain series without observations (optional, default to false)
$series string[] List of series, comma separated. Its length cannot be more than 100000. (optional)
$name string Name of the new record. Max length 100 (optional)
$description string Description of the new record. Max length 1000 (optional)
$keyword string Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional)
$frequency string[] Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional)
$country string[] **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional)
$source string[] Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unit string[] Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicator string[] Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. (optional)
$region string[] Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnly bool Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnly bool Show only 'key' series when set to `true`. (optional, default to false)
$newOnly bool Show only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnly bool This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore \DateTime Will return series with first observation before `start_date_before` (optional)
$endDateAfter \DateTime Will return series with last observation after `end_date_after` (optional)
$createdAfter \DateTime Will return entries created after `created_after` date (optional)
$updatedAfter \DateTime Will return series last time updated after `updated_after` date (optional)
$geo string[] Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$topic string[] Topic filter. One or more comma separated topic code values. (optional)
$section string[] Section filter. One or more comma separated section code values. (optional)
$table string[] Table filter. One or more comma separated table code values. (optional)
$status string[] Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased (optional, default to [T])
$order string[] Sort order. Default is `relevance`. (optional)
$database string[] Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *IHS Markit Purchasing Managers' Index* DAILY - *Daily Database* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* OXFORD - *Asia Forecasting Service* OECD-MEI - *OECD - Main Economic Indicators* OECD-EO - *OECD - Economic Outlook* OECD-PROD - *OECD - Productivity* OECD-NA - *OECD - National Accounts* (optional)
$direction string[] Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending (optional)
deleteFilters($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Delete filters

Returns:

\Ceic\Api\Models\EmptyObject

Parameters:
Name Type Description
$id string Filter ID. Accepts one or more comma separated values. (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getFilters($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Get filter details

Returns:

\Ceic\Api\Models\FiltersResult

Parameters:
Name Type Description
$id string Filter ID. Accepts one or more comma separated values. (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getUserFilters($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Get user filters

Returns:

\Ceic\Api\Models\FiltersResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
updateFilter($id, $accept = null, $format = null, $token = null, $withModelInformation = null, $forecastOnly = null, $withReleaseOnly = null, $withReplacementsOnly = null, $withObservationsOnly = null, $series = null, $name = null, $description = null, $keyword = null, $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = null, $keyOnly = null, $newOnly = null, $nameOnly = null, $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $geo = null, $topic = null, $section = null, $table = null, $status = null, $order = null, $database = null, $direction = null)

Update filter details

Returns:

\Ceic\Api\Models\FilterResult

Parameters:
Name Type Description
$id string A single Filter ID value (required)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$forecastOnly bool If it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnly bool If it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnly bool If it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnly bool If it is `true` result will not contain series without observations (optional, default to false)
$series string[] List of series, comma separated. Its length cannot be more than 100000. (optional)
$name string Name of the new record. Max length 100 (optional)
$description string Description of the new record. Max length 1000 (optional)
$keyword string Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional)
$frequency string[] Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional)
$country string[] **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional)
$source string[] Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unit string[] Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicator string[] Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. (optional)
$region string[] Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnly bool Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnly bool Show only 'key' series when set to `true`. (optional, default to false)
$newOnly bool Show only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnly bool This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore \DateTime Will return series with first observation before `start_date_before` (optional)
$endDateAfter \DateTime Will return series with last observation after `end_date_after` (optional)
$createdAfter \DateTime Will return entries created after `created_after` date (optional)
$updatedAfter \DateTime Will return series last time updated after `updated_after` date (optional)
$geo string[] Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$topic string[] Topic filter. One or more comma separated topic code values. (optional)
$section string[] Section filter. One or more comma separated section code values. (optional)
$table string[] Table filter. One or more comma separated table code values. (optional)
$status string[] Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased (optional, default to [T])
$order string[] Sort order. Default is `relevance`. (optional)
$database string[] Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *IHS Markit Purchasing Managers' Index* DAILY - *Daily Database* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* OXFORD - *Asia Forecasting Service* OECD-MEI - *OECD - Main Economic Indicators* OECD-EO - *OECD - Economic Outlook* OECD-PROD - *OECD - Productivity* OECD-NA - *OECD - National Accounts* (optional)
$direction string[] Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending (optional)
createFilterQuery(\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\FilterResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity Query entity object which contains the search information (required)
deleteFiltersQuery(\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\EmptyObject

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity Query entity object which contains the search information (required)
getFiltersQuery(\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\FiltersResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity Query entity object which contains the search information (required)
getUserFiltersQuery(\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\FiltersResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity Query entity object which contains the search information (required)
updateFilterQuery(\Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\FilterResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\FiltersApiQueryEntity Query entity object which contains the search information (required)

Namespace: Ceic\Api\Apis

Class: InsightsApi(\Ceic\Api\ApiClient $apiClient = null)

getApiClient()

Get API client

Returns:

\Ceic\Api\ApiClient

setApiClient(\Ceic\Api\ApiClient $apiClient)

Set the API client

Returns:

InsightsApi

Parameters:
Name Type Description
$apiClient \Ceic\Api\ApiClient set the API client
downloadInsight($id, $fileFormat, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $ignoreCache = null, $adjustColumns = null, $startDate = null, $endDate = null, $count = null, $blankObservations = null, $orientation = null, $order = null, $decimalPlaces = null, $dateFormat = null)

Request a downloadable insight report

Returns:

\Ceic\Api\Models\InsightDownloadResult

Parameters:
Name Type Description
$id string Insight ID (required)
$fileFormat string Insight report file format. Available formats: `xlsx`, `pdf` (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$ignoreCache bool New file will be generated (optional, default to false)
$adjustColumns string No adjust or wrap text in XLSX cell (optional, default to no)
$startDate \DateTime Limits the start date after which the time-points will be returned. (optional)
$endDate \DateTime Limits the end date before which the time-points will be returned. (optional)
$count int Limit the amount of latest time-points returned, by the number specified. (optional)
$blankObservations string If set to true, will return empty time-points which oterwise are omitted. (optional, default to filter)
$orientation string Columns/rows orientation (optional, default to cols)
$order string Sort order - Asc/Desc (optional, default to asc)
$decimalPlaces float Decimal places for the time-points values (optional, default to 3)
$dateFormat string Time-points date format (optional)
getGalleryInsightsCategories($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Insight gallery categories

Returns:

\Ceic\Api\Models\InsightsCategoriesResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getInsight($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Insights details

Returns:

\Ceic\Api\Models\InsightsResult

Parameters:
Name Type Description
$id string Insight ID (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getInsightSeries($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $count = null, $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = null, $timePointsStatus = null, $withReplacementsMetadata = null, $forecastOnly = null, $withReleaseOnly = null, $withReplacementsOnly = null, $withObservationsOnly = null, $limit = null, $offset = null)

List of all series for a particular insight

Returns:

\Ceic\Api\Models\InsightSeriesResult

Parameters:
Name Type Description
$id string Insight ID (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$count int Limit the amount of latest time-points returned, by the number specified. (optional)
$startDate \DateTime Limits the start date after which the time-points will be returned. (optional)
$endDate \DateTime Limits the end date before which the time-points will be returned. (optional)
$updatedAfter \DateTime Returns only the updated time-points after the date specified. (optional)
$blankObservations bool If it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatus string Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadata bool If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnly bool If it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnly bool If it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnly bool If it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnly bool If it is `true` result will not contain series without observations (optional, default to false)
$limit float Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offset float The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
getInsightSeriesData($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $count = null, $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = null, $timePointsStatus = null, $limit = null, $offset = null)

List of all series time-points for a particular insight

Returns:

\Ceic\Api\Models\InsightSeriesResult

Parameters:
Name Type Description
$id string Insight ID (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$count int Limit the amount of latest time-points returned, by the number specified. (optional)
$startDate \DateTime Limits the start date after which the time-points will be returned. (optional)
$endDate \DateTime Limits the end date before which the time-points will be returned. (optional)
$updatedAfter \DateTime Returns only the updated time-points after the date specified. (optional)
$blankObservations bool If it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatus string Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$limit float Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offset float The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
getInsightSeriesList($seriesId, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $count = null, $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = null, $timePointsStatus = null, $withReplacementsMetadata = null, $forecastOnly = null, $withReleaseOnly = null, $withReplacementsOnly = null, $withObservationsOnly = null)

List of series based on their insight series ID

Returns:

\Ceic\Api\Models\InsightSeriesResult

Parameters:
Name Type Description
$seriesId string Insight Series ID (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$count int Limit the amount of latest time-points returned, by the number specified. (optional)
$startDate \DateTime Limits the start date after which the time-points will be returned. (optional)
$endDate \DateTime Limits the end date before which the time-points will be returned. (optional)
$updatedAfter \DateTime Returns only the updated time-points after the date specified. (optional)
$blankObservations bool If it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatus string Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadata bool If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnly bool If it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnly bool If it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnly bool If it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnly bool If it is `true` result will not contain series without observations (optional, default to false)
getInsightSeriesListData($seriesId, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $count = null, $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = null, $timePointsStatus = null)

List of series time-points based on their insight series ID

Returns:

\Ceic\Api\Models\InsightSeriesResult

Parameters:
Name Type Description
$seriesId string Insight Series ID (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$count int Limit the amount of latest time-points returned, by the number specified. (optional)
$startDate \DateTime Limits the start date after which the time-points will be returned. (optional)
$endDate \DateTime Limits the end date before which the time-points will be returned. (optional)
$updatedAfter \DateTime Returns only the updated time-points after the date specified. (optional)
$blankObservations bool If it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatus string Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
getInsightSeriesListMetadata($seriesId, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $withReplacementsMetadata = null, $forecastOnly = null, $withReleaseOnly = null, $withReplacementsOnly = null, $withObservationsOnly = null)

List of series metadata based on their insight series ID

Returns:

\Ceic\Api\Models\InsightSeriesResult

Parameters:
Name Type Description
$seriesId string Insight Series ID (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$withReplacementsMetadata bool If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnly bool If it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnly bool If it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnly bool If it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnly bool If it is `true` result will not contain series without observations (optional, default to false)
getInsightSeriesMetadata($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $withReplacementsMetadata = null, $forecastOnly = null, $withReleaseOnly = null, $withReplacementsOnly = null, $withObservationsOnly = null, $limit = null, $offset = null)

List of all series metadata for a particular insight

Returns:

\Ceic\Api\Models\InsightSeriesResult

Parameters:
Name Type Description
$id string Insight ID (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$withReplacementsMetadata bool If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnly bool If it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnly bool If it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnly bool If it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnly bool If it is `true` result will not contain series without observations (optional, default to false)
$limit float Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offset float The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
getInsights($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

List of User Created Insights

Returns:

\Ceic\Api\Models\InsightsResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getInsightsCategories($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Insight categories

Returns:

\Ceic\Api\Models\InsightsCategoriesResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
searchInsights($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $group = null, $limit = null, $offset = null, $keyword = null, $order = null, $direction = null, $tags = null, $categories = null)

Insights search

Returns:

\Ceic\Api\Models\InsightsSearchResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$group string Insights group. Default is `my`. (optional, default to my)
$limit float Number of records to return (optional, default to 30)
$offset float The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$keyword string Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional)
$order string Sort order (optional, default to edit_date)
$direction string Sort order direction (optional, default to asc)
$tags string[] List of insight tags to search by tag (optional)
$categories string[] List of insights categories to search by category (optional)
downloadInsightQuery(\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\InsightDownloadResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity Query entity object which contains the search information (required)
getGalleryInsightsCategoriesQuery(\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\InsightsCategoriesResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity Query entity object which contains the search information (required)
getInsightQuery(\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\InsightsResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity Query entity object which contains the search information (required)
getInsightSeriesQuery(\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\InsightSeriesResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity Query entity object which contains the search information (required)
getInsightSeriesDataQuery(\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\InsightSeriesResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity Query entity object which contains the search information (required)
getInsightSeriesListQuery(\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\InsightSeriesResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity Query entity object which contains the search information (required)
getInsightSeriesListDataQuery(\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\InsightSeriesResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity Query entity object which contains the search information (required)
getInsightSeriesListMetadataQuery(\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\InsightSeriesResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity Query entity object which contains the search information (required)
getInsightSeriesMetadataQuery(\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\InsightSeriesResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity Query entity object which contains the search information (required)
getInsightsQuery(\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\InsightsResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity Query entity object which contains the search information (required)
getInsightsCategoriesQuery(\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\InsightsCategoriesResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity Query entity object which contains the search information (required)
searchInsightsQuery(\Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\InsightsSearchResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\InsightsApiQueryEntity Query entity object which contains the search information (required)

Namespace: Ceic\Api\Apis

Class: InternalApi(\Ceic\Api\ApiClient $apiClient = null)

getApiClient()

Get API client

Returns:

\Ceic\Api\ApiClient

setApiClient(\Ceic\Api\ApiClient $apiClient)

Set the API client

Returns:

InternalApi

Parameters:
Name Type Description
$apiClient \Ceic\Api\ApiClient set the API client
getInternalRemarks($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $withReplacementsMetadata = null, $forecastOnly = null, $withReleaseOnly = null, $withReplacementsOnly = null, $withObservationsOnly = null)

Returns list of internal remarks

Returns:

\Ceic\Api\Models\SeriesInternalRemarksResult

Parameters:
Name Type Description
$id string Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$withReplacementsMetadata bool If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnly bool If it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnly bool If it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnly bool If it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnly bool If it is `true` result will not contain series without observations (optional, default to false)
getInternalRemarksQuery(\Ceic\Api\Models\QueryEntities\InternalApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\SeriesInternalRemarksResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\InternalApiQueryEntity Query entity object which contains the search information (required)

Namespace: Ceic\Api\Apis

Class: LayoutApi(\Ceic\Api\ApiClient $apiClient = null)

getApiClient()

Get API client

Returns:

\Ceic\Api\ApiClient

setApiClient(\Ceic\Api\ApiClient $apiClient)

Set the API client

Returns:

LayoutApi

Parameters:
Name Type Description
$apiClient \Ceic\Api\ApiClient set the API client
getLayoutDatabases($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $keyword = null, $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = null, $keyOnly = null, $newOnly = null, $nameOnly = null, $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $geo = null, $status = null, $filterId = null)

List of databases

Returns:

\Ceic\Api\Models\LayoutItemsResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$keyword string Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional)
$frequency string[] Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional)
$country string[] **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional)
$source string[] Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unit string[] Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicator string[] Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. (optional)
$region string[] Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnly bool Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnly bool Show only 'key' series when set to `true`. (optional, default to false)
$newOnly bool Show only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnly bool This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore \DateTime Will return series with first observation before `start_date_before` (optional)
$endDateAfter \DateTime Will return series with last observation after `end_date_after` (optional)
$createdAfter \DateTime Will return entries created after `created_after` date (optional)
$updatedAfter \DateTime Will return series last time updated after `updated_after` date (optional)
$geo string[] Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$status string[] Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased (optional, default to [T, C, B])
$filterId string[] Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional)
getLayoutFootnoteMetadata($nodeCode, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Returns footnote metadata for a node

Returns:

\Ceic\Api\Models\LayoutFootnoteMetadataResult

Parameters:
Name Type Description
$nodeCode string Node Code - Database ID, Topic ID, Section ID or Table ID (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getLayoutSections($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $keyword = null, $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = null, $keyOnly = null, $newOnly = null, $nameOnly = null, $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $geo = null, $status = null, $filterId = null)

List of Sections

Returns:

\Ceic\Api\Models\LayoutItemsResult

Parameters:
Name Type Description
$id string Topic ID (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$keyword string Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional)
$frequency string[] Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional)
$country string[] **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional)
$source string[] Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unit string[] Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicator string[] Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. (optional)
$region string[] Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnly bool Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnly bool Show only 'key' series when set to `true`. (optional, default to false)
$newOnly bool Show only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnly bool This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore \DateTime Will return series with first observation before `start_date_before` (optional)
$endDateAfter \DateTime Will return series with last observation after `end_date_after` (optional)
$createdAfter \DateTime Will return entries created after `created_after` date (optional)
$updatedAfter \DateTime Will return series last time updated after `updated_after` date (optional)
$geo string[] Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$status string[] Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased (optional, default to [T, C, B])
$filterId string[] Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional)
getLayoutSeries($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $keyword = null, $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = null, $keyOnly = null, $newOnly = null, $nameOnly = null, $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $geo = null, $status = null, $filterId = null)

List of Series

Returns:

\Ceic\Api\Models\SeriesResult

Parameters:
Name Type Description
$id string Table ID (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$keyword string Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional)
$frequency string[] Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional)
$country string[] **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional)
$source string[] Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unit string[] Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicator string[] Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. (optional)
$region string[] Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnly bool Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnly bool Show only 'key' series when set to `true`. (optional, default to false)
$newOnly bool Show only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnly bool This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore \DateTime Will return series with first observation before `start_date_before` (optional)
$endDateAfter \DateTime Will return series with last observation after `end_date_after` (optional)
$createdAfter \DateTime Will return entries created after `created_after` date (optional)
$updatedAfter \DateTime Will return series last time updated after `updated_after` date (optional)
$geo string[] Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$status string[] Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased (optional, default to [T, C, B])
$filterId string[] Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional)
getLayoutTables($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $keyword = null, $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = null, $keyOnly = null, $newOnly = null, $nameOnly = null, $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $geo = null, $status = null, $filterId = null)

List of Tables

Returns:

\Ceic\Api\Models\LayoutItemsResult

Parameters:
Name Type Description
$id string Section ID (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$keyword string Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional)
$frequency string[] Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional)
$country string[] **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional)
$source string[] Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unit string[] Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicator string[] Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. (optional)
$region string[] Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnly bool Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnly bool Show only 'key' series when set to `true`. (optional, default to false)
$newOnly bool Show only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnly bool This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore \DateTime Will return series with first observation before `start_date_before` (optional)
$endDateAfter \DateTime Will return series with last observation after `end_date_after` (optional)
$createdAfter \DateTime Will return entries created after `created_after` date (optional)
$updatedAfter \DateTime Will return series last time updated after `updated_after` date (optional)
$geo string[] Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$status string[] Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased (optional, default to [T, C, B])
$filterId string[] Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional)
getLayoutTopics($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $keyword = null, $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = null, $keyOnly = null, $newOnly = null, $nameOnly = null, $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $geo = null, $status = null, $filterId = null)

List of Topics

Returns:

\Ceic\Api\Models\LayoutItemsResult

Parameters:
Name Type Description
$id string Database ID (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$keyword string Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional)
$frequency string[] Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional)
$country string[] **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional)
$source string[] Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unit string[] Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicator string[] Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. (optional)
$region string[] Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnly bool Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnly bool Show only 'key' series when set to `true`. (optional, default to false)
$newOnly bool Show only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnly bool This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore \DateTime Will return series with first observation before `start_date_before` (optional)
$endDateAfter \DateTime Will return series with last observation after `end_date_after` (optional)
$createdAfter \DateTime Will return entries created after `created_after` date (optional)
$updatedAfter \DateTime Will return series last time updated after `updated_after` date (optional)
$geo string[] Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$status string[] Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased (optional, default to [T, C, B])
$filterId string[] Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional)
getLayoutDatabasesQuery(\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\LayoutItemsResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity Query entity object which contains the search information (required)
getLayoutFootnoteMetadataQuery(\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\LayoutFootnoteMetadataResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity Query entity object which contains the search information (required)
getLayoutSectionsQuery(\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\LayoutItemsResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity Query entity object which contains the search information (required)
getLayoutSeriesQuery(\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\SeriesResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity Query entity object which contains the search information (required)
getLayoutTablesQuery(\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\LayoutItemsResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity Query entity object which contains the search information (required)
getLayoutTopicsQuery(\Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\LayoutItemsResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\LayoutApiQueryEntity Query entity object which contains the search information (required)

Namespace: Ceic\Api\Apis

Class: ReleasesApi(\Ceic\Api\ApiClient $apiClient = null)

getApiClient()

Get API client

Returns:

\Ceic\Api\ApiClient

setApiClient(\Ceic\Api\ApiClient $apiClient)

Set the API client

Returns:

ReleasesApi

Parameters:
Name Type Description
$apiClient \Ceic\Api\ApiClient set the API client
getReleaseSeries($code, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $limit = null, $offset = null)

List release code series.

Returns:

\Ceic\Api\Models\ReleaseSeriesResult

Parameters:
Name Type Description
$code string Release identifier code for a group of series with the same release schedule. Accepts only one release identifier code. (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$limit float Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offset float The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
getSeriesReleases($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $releaseDateFrom = null, $releaseDateTo = null, $releaseStatus = null, $offset = null, $limit = null, $offset2 = null)

List of releases for a single series id

Returns:

\Ceic\Api\Models\SeriesReleaseScheduleSearchResult

Parameters:
Name Type Description
$id string Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$releaseDateFrom \DateTime Will return releases with first observation before `release_date_from` (optional)
$releaseDateTo \DateTime Will return releases with last observation after `release_date_to` (optional)
$releaseStatus string[] List of release statuses to return (optional, default to Released)
$offset float The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$limit float Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offset float
searchSeriesReleases($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $limit = null, $offset = null, $layout = null, $database = null, $keyword = null, $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = null, $keyOnly = null, $newOnly = null, $nameOnly = null, $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $geo = null, $status = null, $series = null, $topic = null, $section = null, $table = null, $order = null, $direction = null, $filterId = null, $withReplacementsMetadata = null, $forecastOnly = null, $withReleaseOnly = null, $withReplacementsOnly = null, $withObservationsOnly = null, $facet = null, $releaseDateFrom = null, $releaseDateTo = null, $releaseStatus = null, $offset2 = null)

Released schedule search

Returns:

\Ceic\Api\Models\SeriesReleaseScheduleSearchResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$limit float Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offset float The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$layout string[] **DEPRECATED. Please use `database` parameter.** Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *IHS Markit Purchasing Managers' Index* DAILY - *Daily Database* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* OXFORD - *Asia Forecasting Service* OECD-MEI - *OECD - Main Economic Indicators* OECD-EO - *OECD - Economic Outlook* OECD-PROD - *OECD - Productivity* OECD-NA - *OECD - National Accounts* (optional)
$database string[] Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *IHS Markit Purchasing Managers' Index* DAILY - *Daily Database* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* OXFORD - *Asia Forecasting Service* OECD-MEI - *OECD - Main Economic Indicators* OECD-EO - *OECD - Economic Outlook* OECD-PROD - *OECD - Productivity* OECD-NA - *OECD - National Accounts* (optional)
$keyword string Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional)
$frequency string[] Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional)
$country string[] **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional)
$source string[] Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unit string[] Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicator string[] Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. (optional)
$region string[] Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnly bool Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnly bool Show only 'key' series when set to `true`. (optional, default to false)
$newOnly bool Show only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnly bool This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore \DateTime Will return series with first observation before `start_date_before` (optional)
$endDateAfter \DateTime Will return series with last observation after `end_date_after` (optional)
$createdAfter \DateTime Will return entries created after `created_after` date (optional)
$updatedAfter \DateTime Will return series last time updated after `updated_after` date (optional)
$geo string[] Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$status string[] Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased (optional, default to [T])
$series string[] List of series (optional)
$topic string[] Topic filter. One or more comma separated topic code values. (optional)
$section string[] Section filter. One or more comma separated section code values. (optional)
$table string[] Table filter. One or more comma separated table code values. (optional)
$order string[] Sort order. Default is `relevance`. (optional)
$direction string[] Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending (optional)
$filterId string[] Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional)
$withReplacementsMetadata bool If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnly bool If it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnly bool If it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnly bool If it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnly bool If it is `true` result will not contain series without observations (optional, default to false)
$facet string[] List of facets to return (optional)
$releaseDateFrom \DateTime Will return releases with first observation before `release_date_from` (optional)
$releaseDateTo \DateTime Will return releases with last observation after `release_date_to` (optional)
$releaseStatus string[] List of release statuses to return (optional, default to Released)
$offset float
getReleaseSeriesQuery(\Ceic\Api\Models\QueryEntities\ReleasesApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\ReleaseSeriesResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\ReleasesApiQueryEntity Query entity object which contains the search information (required)
getSeriesReleasesQuery(\Ceic\Api\Models\QueryEntities\ReleasesApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\SeriesReleaseScheduleSearchResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\ReleasesApiQueryEntity Query entity object which contains the search information (required)
searchSeriesReleasesQuery(\Ceic\Api\Models\QueryEntities\ReleasesApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\SeriesReleaseScheduleSearchResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\ReleasesApiQueryEntity Query entity object which contains the search information (required)

Namespace: Ceic\Api\Apis

Class: SeriesApi(\Ceic\Api\ApiClient $apiClient = null)

getApiClient()

Get API client

Returns:

\Ceic\Api\ApiClient

setApiClient(\Ceic\Api\ApiClient $apiClient)

Set the API client

Returns:

SeriesApi

Parameters:
Name Type Description
$apiClient \Ceic\Api\ApiClient set the API client
getSeries($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $count = null, $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = null, $timePointsStatus = null, $withReplacementsMetadata = null, $forecastOnly = null, $withReleaseOnly = null, $withReplacementsOnly = null, $withObservationsOnly = null)

Returns full series data

Returns:

\Ceic\Api\Models\SeriesResult

Parameters:
Name Type Description
$id string Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$count int Limit the amount of latest time-points returned, by the number specified. (optional)
$startDate \DateTime Limits the start date after which the time-points will be returned. (optional)
$endDate \DateTime Limits the end date before which the time-points will be returned. (optional)
$updatedAfter \DateTime Returns only the updated time-points after the date specified. (optional)
$blankObservations bool If it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatus string Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
$withReplacementsMetadata bool If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnly bool If it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnly bool If it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnly bool If it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnly bool If it is `true` result will not contain series without observations (optional, default to false)
getSeriesMetadata($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $withReplacementsMetadata = null, $forecastOnly = null, $withReleaseOnly = null, $withReplacementsOnly = null, $withObservationsOnly = null)

Returns list of metadata items

Returns:

\Ceic\Api\Models\SeriesResult

Parameters:
Name Type Description
$id string Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$withReplacementsMetadata bool If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnly bool If it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnly bool If it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnly bool If it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnly bool If it is `true` result will not contain series without observations (optional, default to false)
getSeriesStatistics($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Returns list of items' statistics

Returns:

\Ceic\Api\Models\SeriesStatisticsResult

Parameters:
Name Type Description
$id string Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
getSeriesTimePoints($id, $acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $count = null, $startDate = null, $endDate = null, $updatedAfter = null, $blankObservations = null, $timePointsStatus = null)

Returns series time-points

Returns:

\Ceic\Api\Models\SeriesResult

Parameters:
Name Type Description
$id string Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$count int Limit the amount of latest time-points returned, by the number specified. (optional)
$startDate \DateTime Limits the start date after which the time-points will be returned. (optional)
$endDate \DateTime Limits the end date before which the time-points will be returned. (optional)
$updatedAfter \DateTime Returns only the updated time-points after the date specified. (optional)
$blankObservations bool If it's set to true, empty time-points will be returned (optional, default to false)
$timePointsStatus string Time points filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active X - Deleted (optional, default to active)
getSeriesVisual($id, $accept = null, $format = null, $acceptLanguage = null, $lang = null, $token = null, $startDate = null, $endDate = null, $forecastOnly = null, $withReleaseOnly = null, $withReplacementsOnly = null, $withObservationsOnly = null, $width = null, $height = null, $period = null, $type = null)

Returns visual image

Returns:

string

Parameters:
Name Type Description
$id string Series ID or Series Code to return. Accepts only one series ID or series Code. (required)
$accept string Response data format. Default is `image/png`. (optional, default to image/png)
$format string Response data format. Default is `png` (optional, default to png)
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$token string Access API key. (optional)
$startDate \DateTime Limits the start date after which the time-points will be returned. (optional)
$endDate \DateTime Limits the end date before which the time-points will be returned. (optional)
$forecastOnly bool If it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnly bool If it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnly bool If it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnly bool If it is `true` result will not contain series without observations (optional, default to false)
$width float Image width (optional)
$height float Image height (optional)
$period float Series time-pints mask. Example: 10y, 20m, 12d, 4w (optional)
$type string Visual type (optional, default to chart)
searchSeries($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null, $limit = null, $offset = null, $layout = null, $database = null, $keyword = null, $frequency = null, $country = null, $source = null, $unit = null, $indicator = null, $region = null, $subscribedOnly = null, $keyOnly = null, $newOnly = null, $nameOnly = null, $startDateBefore = null, $endDateAfter = null, $createdAfter = null, $updatedAfter = null, $geo = null, $status = null, $series = null, $topic = null, $section = null, $table = null, $order = null, $direction = null, $filterId = null, $withReplacementsMetadata = null, $forecastOnly = null, $withReleaseOnly = null, $withReplacementsOnly = null, $withObservationsOnly = null, $facet = null)

Series search

Returns:

\Ceic\Api\Models\SearchSeriesResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
$limit float Number of records to return in the range 1 - 100. Default is 100. (optional, default to 100)
$offset float The offset from which the records will be returned. Used to get the next set of records when the limit is reached. (optional, default to 0)
$layout string[] **DEPRECATED. Please use `database` parameter.** Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *IHS Markit Purchasing Managers' Index* DAILY - *Daily Database* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* OXFORD - *Asia Forecasting Service* OECD-MEI - *OECD - Main Economic Indicators* OECD-EO - *OECD - Economic Outlook* OECD-PROD - *OECD - Productivity* OECD-NA - *OECD - National Accounts* (optional)
$database string[] Database filter. One or more comma separated database code values. Use `/dictionary/databases` to get an up to date list of available databases. WORLD - *World Trend Plus* WGEM - *Economic Monitor* WAEM - *ASEAN Economic Monitor* WFOR - *Forecast* WCOM - *Commodity Market* WCOC - *Country Competitiveness* WAGR - *Aggregates* WASS - *International Associations* WIT10 - *Industry Top Companies* GLOBAL - *Global Database* AA - *Asia* ECA - *Europe and Central Asia* MEA - *Middle East and Africa* NSA - *North and South America* CEICGLBKS - *Global Key Series Database* PMI - *IHS Markit Purchasing Managers' Index* DAILY - *Daily Database* BRAZIL - *Brazil Premium Database* RUSSIA - *Russia Premium Database* INDIA - *India Premium Database* INDONESIA - *Indonesia Premium Database* CN - *China Premium Database* OXFORD - *Asia Forecasting Service* OECD-MEI - *OECD - Main Economic Indicators* OECD-EO - *OECD - Economic Outlook* OECD-PROD - *OECD - Productivity* OECD-NA - *OECD - National Accounts* (optional)
$keyword string Search term. One or more keywords. May contain special words further controlling the search results. Keyword search tips: `Retail Sales` - Show series with both keywords while the sequence of keywords is irrelevant. Equivalent to search Sales Retail `Retail AND Sales` - Show results: series with terms of Retail AND Sales, regardless of the sequence. E. g. Retail Sales, Automobile Sales Retail `Retail;Sales` - Show series with either keyword and series with both keywords while the sequence of keywords is irrelevant, equivalent to search: Sales;Retail `Retail OR Sales` - Show results: series with terms of Retail OR Sales, regardless of the sequence. E. g. Retail Sales, Retail Trade, Sales Price, Motor Vehicle Sales `Retail NOT Sales` - Narrow a search by excluding specific terms while the sequence of keywords is relevant. Show results: series with terms that include Retail, but NOT Sales. E. g. Retail Trade, Retail Price, Retail Bank `Retail Sales NOT (Hong Kong)` - Narrow a search by excluding a set of words in parentheses while the sequence of keywords in parentheses is irrelevant, equivalent to search: Retail Sales NOT (Hong Kong). Show results: series with terms that include Retail Sales, but NOT Hong Kong, such as Retail Sales YoY: China, Retail Sales YoY: United States (optional)
$frequency string[] Frequency filter. One or more comma separated frequency code values. D - Daily W - Weekly M - Monthly Q - Quarterly H - Semi-annual Y - Annual Z - Quinquennially T - Decadal (optional)
$country string[] **DEPRECATED. Please use `geo` parameter.** Country filter. One or more comma separated country code values. See related Dictionary function to get the full list of accepted countries. (optional)
$source string[] Source filter. One or more comma separated source code values. See related Dictionary function to get the full list of accepted sources. (optional)
$unit string[] Unit filter. One or more comma separated unit code values. See related Dictionary function to get the full list of accepted units. (optional)
$indicator string[] Indicator filter. One or more comma separated indicator code values. See related Dictionary function to get full list of accepted indicators. (optional)
$region string[] Region filter. One or more comma separated region code values. See related Dictionary function to get the full list of accepted regions. (optional)
$subscribedOnly bool Show only results for subscribed series when set to `true`. By default show results for all the series found. (optional, default to false)
$keyOnly bool Show only 'key' series when set to `true`. (optional, default to false)
$newOnly bool Show only series created less than 1 month ago when set to `true`. (optional, default to false)
$nameOnly bool This filter related with the `keyword` filter. If it's `true` keyword search will be searched only in series name instead of all series attributes. (optional, default to false)
$startDateBefore \DateTime Will return series with first observation before `start_date_before` (optional)
$endDateAfter \DateTime Will return series with last observation after `end_date_after` (optional)
$createdAfter \DateTime Will return entries created after `created_after` date (optional)
$updatedAfter \DateTime Will return series last time updated after `updated_after` date (optional)
$geo string[] Geo filter. One or more comma separated geo id values. See related Dictionary function to get the full list of accepted geo ids. (optional)
$status string[] Status filter. One or more comma separated status code values. When not explicitly set, defaults to T. T - Active C - Discontinued B - Rebased (optional, default to [T])
$series string[] List of series (optional)
$topic string[] Topic filter. One or more comma separated topic code values. (optional)
$section string[] Section filter. One or more comma separated section code values. (optional)
$table string[] Table filter. One or more comma separated table code values. (optional)
$order string[] Sort order. Default is `relevance`. (optional)
$direction string[] Sort order direction. Default is `asc`. Accepted values: `asc` - ascending `desc` - descending (optional)
$filterId string[] Filter ID used to define a subset of data over which the search will be executed. When combined with additional search criterion, the result will be an intesection of both. (optional)
$withReplacementsMetadata bool If it is `true` result will contain replacements metadata not only list of id`s (optional, default to false)
$forecastOnly bool If it is `true` result will only contain series with forecast (optional, default to false)
$withReleaseOnly bool If it is `true` result will only contain series with released schedule (optional, default to false)
$withReplacementsOnly bool If it is `true` result will only contain series with suggestions (optional, default to false)
$withObservationsOnly bool If it is `true` result will not contain series without observations (optional, default to false)
$facet string[] List of facets to return (optional)
getSeriesQuery(\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\SeriesResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity Query entity object which contains the search information (required)
getSeriesMetadataQuery(\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\SeriesResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity Query entity object which contains the search information (required)
getSeriesStatisticsQuery(\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\SeriesStatisticsResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity Query entity object which contains the search information (required)
getSeriesTimePointsQuery(\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\SeriesResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity Query entity object which contains the search information (required)
getSeriesVisualQuery(\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity)

Returns:

string

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity Query entity object which contains the search information (required)
searchSeriesQuery(\Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\SearchSeriesResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\SeriesApiQueryEntity Query entity object which contains the search information (required)

Namespace: Ceic\Api\Apis

Class: SessionsApi(\Ceic\Api\ApiClient $apiClient = null)

getApiClient()

Get API client

Returns:

\Ceic\Api\ApiClient

setApiClient(\Ceic\Api\ApiClient $apiClient)

Set the API client

Returns:

SessionsApi

Parameters:
Name Type Description
$apiClient \Ceic\Api\ApiClient set the API client
generateImpersonateToken($employeeToken, $userId, $application, $expireAfter = null)

Generate impersonate token

Returns:

\Ceic\Api\Models\ImpersonateAPIKeyResult

Parameters:
Name Type Description
$employeeToken string Impersonate API token generated on CAS service (required)
$userId string User Id (required)
$application string Application ID (required)
$expireAfter float Token will be expired after `expire_after` in seconds (optional, default to 86400)
getSubscriptions($acceptLanguage = null, $accept = null, $lang = null, $format = null, $token = null, $withModelInformation = null)

Get user subscriptions

Returns:

\Ceic\Api\Models\UserSubscriptionsResult

Parameters:
Name Type Description
$acceptLanguage string Preferred language code in which data shall be returned. Defaults to `English` if no translation in the specified language is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$accept string Response data format. Default is `application/json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$lang string Preferred language code in which data will be returned. Defaults to `English` if no translation in the language specified is available. Can be used through the query parameter `query` or using the header `Accept-Language`. `en` - English `zh` - Chinese `ru` - Russian `id` - Indonesian `jp` - Japanese (optional, default to en)
$format string Response data format. Default is `json`. Can be used through the query parameter `format` or using the header `Accept`. (optional, default to json)
$token string Access API key. (optional)
$withModelInformation bool If set to `true` returns the model names as part of the response. (optional, default to false)
login($login, $password, $application, $applicationVersion = null)

Authenticates the user, creating a new session.

Returns:

\Ceic\Api\Models\UserSessionResult

Parameters:
Name Type Description
$login string Username (required)
$password string Password (required)
$application string Application ID (required)
$applicationVersion string Application Version (optional)
logout($session)

Close existing API session.

Returns:

\Ceic\Api\Models\SessionStatusResult

Parameters:
Name Type Description
$session string User session (required)
validateCredentials($login, $password)

Check if user's login/password are valid

Returns:

\Ceic\Api\Models\UserCredentialsValidationResult

Parameters:
Name Type Description
$login string Username (required)
$password string Password (required)
generateImpersonateTokenQuery(\Ceic\Api\Models\QueryEntities\SessionsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\ImpersonateAPIKeyResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\SessionsApiQueryEntity Query entity object which contains the search information (required)
getSubscriptionsQuery(\Ceic\Api\Models\QueryEntities\SessionsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\UserSubscriptionsResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\SessionsApiQueryEntity Query entity object which contains the search information (required)
loginQuery(\Ceic\Api\Models\QueryEntities\SessionsApiQueryEntity $queryEntity)

Returns:

\Ceic\Api\Models\UserSessionResult

Parameters:
Name Type Description
$queryEntity \Ceic\Api\Models\QueryEntities\SessionsApiQueryEntity Query entity object which contains the search information (required)

Result Types

Ceic\Api\Models.BaseSeriesInformation(array $data = null)
Ceic\Api\Models.Classification(array $data = null)
Ceic\Api\Models.ClassificationsResult(array $data = null)
Ceic\Api\Models.CountriesResult(array $data = null)
Ceic\Api\Models.Country(array $data = null)
Ceic\Api\Models.DictionaryData(array $data = null)
Ceic\Api\Models.DictionaryResult(array $data = null)
Ceic\Api\Models.DumpInformation(array $data = null)
Ceic\Api\Models.DumpResult(array $data = null)
Ceic\Api\Models.EmptyObject(array $data = null)
Ceic\Api\Models.Facet(array $data = null)
Ceic\Api\Models.FacetEntry(array $data = null)
Ceic\Api\Models.FeedInformation(array $data = null)
Ceic\Api\Models.FeedResult(array $data = null)
Ceic\Api\Models.FeedsResult(array $data = null)
Ceic\Api\Models.FilterDetails(array $data = null)
Ceic\Api\Models.FilterDetailsSearch(array $data = null)
Ceic\Api\Models.FiltersResult(array $data = null)
Ceic\Api\Models.FrequenciesResult(array $data = null)
Ceic\Api\Models.Frequency(array $data = null)
Ceic\Api\Models.Geo(array $data = null)
Ceic\Api\Models.GeoInfo(array $data = null)
Ceic\Api\Models.GeoInfoInner(array $data = null)
Ceic\Api\Models.GeoResult(array $data = null)
Ceic\Api\Models.ImpersonateAPIKey(array $data = null)
Ceic\Api\Models.ImpersonateAPIKeyResult(array $data = null)
Ceic\Api\Models.Indicator(array $data = null)
Ceic\Api\Models.IndicatorsResult(array $data = null)
Ceic\Api\Models.InsightDownload(array $data = null)
Ceic\Api\Models.InsightDownloadResult(array $data = null)
Ceic\Api\Models.InsightDownloadResultData(array $data = null)
Ceic\Api\Models.InsightSeries(array $data = null)
Ceic\Api\Models.InsightSeriesInformation(array $data = null)
Ceic\Api\Models.InsightSeriesResult(array $data = null)
Ceic\Api\Models.Insights(array $data = null)
Ceic\Api\Models.InsightsCategoriesResult(array $data = null)
Ceic\Api\Models.InsightsCategory(array $data = null)
Ceic\Api\Models.InsightsResult(array $data = null)
Ceic\Api\Models.InsightsSearch(array $data = null)
Ceic\Api\Models.InsightsSearchResult(array $data = null)
Ceic\Api\Models.InternalSeriesRemarks(array $data = null)
Ceic\Api\Models.Layout(array $data = null)
Ceic\Api\Models.LayoutFootnoteMetadata(array $data = null)
Ceic\Api\Models.LayoutFootnoteMetadataItem(array $data = null)
Ceic\Api\Models.LayoutFootnoteMetadataResult(array $data = null)
Ceic\Api\Models.LayoutFootnoteResourceMetadataItem(array $data = null)
Ceic\Api\Models.LayoutInformation(array $data = null)
Ceic\Api\Models.LayoutInformationList(array $data = null)
Ceic\Api\Models.LayoutItem(array $data = null)
Ceic\Api\Models.LayoutItemMetadata(array $data = null)
Ceic\Api\Models.LayoutItemsResult(array $data = null)
Ceic\Api\Models.LayoutsResult(array $data = null)
Ceic\Api\Models.Province(array $data = null)
Ceic\Api\Models.Region(array $data = null)
Ceic\Api\Models.RegionsResult(array $data = null)
Ceic\Api\Models.ReleaseScheduleStatus(array $data = null)
Ceic\Api\Models.ReleaseScheduleType(array $data = null)
Ceic\Api\Models.ReleaseSeries(array $data = null)
Ceic\Api\Models.ReleaseSeriesList(array $data = null)
Ceic\Api\Models.ReleaseSeriesResult(array $data = null)
Ceic\Api\Models.ReleaseStatusesResult(array $data = null)
Ceic\Api\Models.ReleaseTypesResult(array $data = null)
Ceic\Api\Models.ResponseError(array $data = null)
Ceic\Api\Models.SearchSeries(array $data = null)
Ceic\Api\Models.SearchSeriesResult(array $data = null)
Ceic\Api\Models.Series(array $data = null)
Ceic\Api\Models.SeriesData(array $data = null)
Ceic\Api\Models.SeriesFilter(array $data = null)
Ceic\Api\Models.SeriesGrouping(array $data = null)
Ceic\Api\Models.SeriesInformation(array $data = null)
Ceic\Api\Models.SeriesInternalRemarksResult(array $data = null)
Ceic\Api\Models.SeriesMetadata(array $data = null)
Ceic\Api\Models.SeriesMetadataLastChange(array $data = null)
Ceic\Api\Models.SeriesReleaseScheduleItem(array $data = null)
Ceic\Api\Models.SeriesReleaseScheduleResult(array $data = null)
Ceic\Api\Models.SeriesReleaseScheduleSearchResult(array $data = null)
Ceic\Api\Models.SeriesReleases(array $data = null)
Ceic\Api\Models.SeriesReleasesSearch(array $data = null)
Ceic\Api\Models.SeriesReplacements(array $data = null)
Ceic\Api\Models.SeriesResult(array $data = null)
Ceic\Api\Models.SeriesStatistics(array $data = null)
Ceic\Api\Models.SeriesStatisticsItem(array $data = null)
Ceic\Api\Models.SeriesStatisticsResult(array $data = null)
Ceic\Api\Models.SeriesUISettings(array $data = null)
Ceic\Api\Models.SessionStatus(array $data = null)
Ceic\Api\Models.SessionStatusResult(array $data = null)
Ceic\Api\Models.Source(array $data = null)
Ceic\Api\Models.SourcesResult(array $data = null)
Ceic\Api\Models.Status(array $data = null)
Ceic\Api\Models.StatusesResult(array $data = null)
Ceic\Api\Models.SubscriptionItem(array $data = null)
Ceic\Api\Models.TimePoint(array $data = null)
Ceic\Api\Models.Unit(array $data = null)
Ceic\Api\Models.UnitsResult(array $data = null)
Ceic\Api\Models.UserCredentialsValidationResult(array $data = null)
Ceic\Api\Models.UserCredentialsValidationResultData(array $data = null)
Ceic\Api\Models.UserInformation(array $data = null)
Ceic\Api\Models.UserSession(array $data = null)
Ceic\Api\Models.UserSessionResult(array $data = null)
Ceic\Api\Models.UserSubscriptionsResult(array $data = null)
Ceic\Api\Models.DumpListInformation(array $data = null)
Ceic\Api\Models.DumpListResult(array $data = null)
Ceic\Api\Models.FilterResult(array $data = null)
Ceic\Api\Models.LayoutItemUI(array $data = null)
Ceic\Api\Models.WatchlistGetResult(array $data = null)
Ceic\Api\Models.WatchlistItem(array $data = null)
Ceic\Api\Models.WatchlistProcessedInformation(array $data = null)
Ceic\Api\Models.WatchlistProcessedResult(array $data = null)
Ceic\Api\Models\QueryEntities.DictionaryApiQueryEntity()
Ceic\Api\Models\QueryEntities.DumpsApiQueryEntity()
Ceic\Api\Models\QueryEntities.FeedsApiQueryEntity()
Ceic\Api\Models\QueryEntities.FiltersApiQueryEntity()
Ceic\Api\Models\QueryEntities.InsightsApiQueryEntity()
Ceic\Api\Models\QueryEntities.InternalApiQueryEntity()
Ceic\Api\Models\QueryEntities.LayoutApiQueryEntity()
Ceic\Api\Models\QueryEntities.ReleasesApiQueryEntity()
Ceic\Api\Models\QueryEntities.SeriesApiQueryEntity()
Ceic\Api\Models\QueryEntities.SessionsApiQueryEntity()