Lookup

Get Entities

List tracked entities (e.g., brands, products, public figures, issues).

get/entities

Request

Query parameters

data_source_idstring uuid
Example:00de2081-e013-411d-823c-cd483283e38d

A data source UUID to filter results. When omitted, results include records across every data source you have access to.

country_codestring

Two letter ISO 3166-1 alpha-2 country code. This can be used in the country_code query parameter of multiple endpoints to limit results to the specific country.

Example:us

The two-letter ISO 3166-1 alpha-2 country code used to filter results. When omitted, results include records across every country you have access to. The available countries for each data source can be retrieved from the /data_sources endpoint.

category_idstring
Example:brand

A category ID to filter results. Available categories can be retrieved from the /surveys/syndicated/categories endpoint.

entity_type_idstring
Example:favorability

An entity type ID to filter results.

page_sizeinteger
Example:50

The number of results to return per request. Additional results past the page size can be retrieved using a pagination token, if one is returned in the response.

querystring
Example:Morning Consult

Terms to search. This parameter supports partial matching, normalization, and other common search features.

pagination_tokenstring base64

A pagination token to use to get paginated results. For more details, see the section on Pagination.

Example:eyJxdWVyeSI6ImRvZ3MifQ==

Pagination token returned from previous calls to an endpoint. When provided, no other query parameters can be specified. For more details, please see the Pagination section.

Response

Entities

pagination_tokenstring base64

A pagination token to use to get paginated results. For more details, see the section on Pagination.

Example response

{
  "entities": [
    {
      "id": "autotrader",
      "label": "Autotrader"
    }
  ],
  "pagination_token": "eyJxdWVyeSI6ImRvZ3MifQ=="
}

Changes

No recorded changes to this operation across all 1 revision of this API.