Ads API •References / reports / Get Insight Report by Ad Account ID

Get Insight Report by Ad Account ID

Returns ad campaign metrics broken out by audience (i.e., targeting) insights based on requested fields and dimensions.

Request

ad_account_id
string [uuid]
Required
A unique identifier for an Ad Account.
Example: ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a
insight_dimension
string
A reporting dimension for insight breakdowns. This field is required if continuation_token is not set.
Allowed values: "AGE", "COUNTRY", "GENDER", "GENRE", "PLATFORM"Example: insight_dimension=GENRE
fields
array of strings
A list of fields requested in the report. This field is required if continuation_token is not set. Refer to the Metrics Glossary for definitions: https://developer.spotify.com/documentation/ads-api/guides#metrics-glossary
Example: fields=IMPRESSIONS&fields=CLICKS&fields=SPEND
Users can define a set of fields that they would like populated in the report. This enum defines the global list of available fields. However, not all fields are applicable to both report types. This is validated at request time. The following fields are not allowed for insight reports:

COMPLETES

E_CPCL

FIRST_QUARTILES

FREQUENCY

MIDPOINTS

OFF_SPOTIFY_IMPRESSIONS

PAID_LISTENS_FREQUENCY

SKIPS

SPEND

STARTS

THIRD_QUARTILES
Allowed values: "CLICKS", "COMPLETES", "CONVERSION_RATE", "CTR", "E_CPM", "E_CPCL", "FIRST_QUARTILES", "FREQUENCY", "IMPRESSIONS", "INTENT_RATE", "LISTENERS", "MIDPOINTS", "NEW_LISTENERS", "NEW_LISTENER_CONVERSION_RATE", "NEW_LISTENER_STREAMS", "OFF_SPOTIFY_IMPRESSIONS", "PAID_LISTENS", "PAID_LISTENS_FREQUENCY", "PAID_LISTENS_REACH", "REACH", "SKIPS", "SPEND", "STARTS", "STREAMS", "STREAMS_PER_NEW_LISTENER", "STREAMS_PER_USER", "THIRD_QUARTILES", "VIDEO_VIEWS", "VIDEO_EXPANDS", "VIDEO_EXPAND_RATE"
entity_ids
array of strings
A list of one or more campaign, ad set, or ad IDs by which to filter reporting. If this field is set, the entity_ids_type field is required.

Aggregate Report:
- A maximum of 50 entities can be requested.
Insight Report:
- Only one ID at a time is currently supported.
Restrictions:
1. This parameter is not valid for AD_ACCOUNT entity_type requests, since the ID is derived from the ad_account_id.
Example: entity_ids=ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a
entity_ids_type
string
The entity type of IDs contained in the entity_ids field. If entity_ids is set, this field is required. Furthermore, the only acceptable value for insight reports is AD_SET.

When using a granularity that is not LIFETIME, entity id types must match the type of the entity requested

Restrictions:
1. This parameter is not valid for AD_ACCOUNT entity_type requests, as the ID is derived from ad_account_id and the type is always considered AD_ACCOUNT.
Allowed values: "AD", "AD_SET", "CAMPAIGN", "AD_ACCOUNT"Example: entity_ids_type=AD_SET
entity_status_type
string
The entity type of statuses contained in the statuses field. If statuses is set, this field is required. Furthermore, the only acceptable value for insight reports is AD_SET.

Restrictions:
1. This parameter is not valid for AD_ACCOUNT entity_type requests.
Allowed values: "AD", "AD_SET", "CAMPAIGN", "AD_ACCOUNT"Example: entity_status_type=AD_SET
statuses
array of strings
A list of one or more campaign, ad set, or ad statuses by which to filter reporting. If this field is set, the entity_status_type field is required.

Restrictions:
1. This parameter is not valid for AD_ACCOUNT entity_type requests.
Example: statuses=ACTIVE
Ad, Ad Set, and Campaign statuses that are used in report requests as well as responses. Not every status is valid for each entity type. The valid statuses for each entity are the following: Ad: APPROVED, ARCHIVED, PENDING, PENDING_APPROVAL, REJECTED Ad Set: ACTIVE, APPROVED, ARCHIVED, COMPLETED, PENDING_APPROVAL, READY, REJECTED Campaign: ACTIVE, ARCHIVED, PAUSED
Allowed values: "ACTIVE", "APPROVED", "ARCHIVED", "PENDING_APPROVAL", "REJECTED", "PAUSED", "COMPLETED", "READY", "PENDING"
continuation_token
string
Nullable
A base64 encoded and encrypted string used for paging. If null, no more pages are available.
Example: continuation_token=AMC-fuxpGRIqFcOUEzDEdWQsM5Iy7mkRThKFo94mEys6RF1lzeKyq1sOlWU4RsdjSsgDWR2D7An1nFgLXNBU9hocKnWQ9jRsps6kCLqKd7Q77zNEhHm_Xlb6J_Fci6kK7tXVM3U6H8OajjcTA18eFcr-kv0etZJZBWlMhtP84xj4WiVDZnPWaMo7AL3jRrHH32grJ3eRA2PAoZmhg80%3D
limit
integer
Limit or page size for a given response.
Default: limit=50Range: 1 - 50Example: limit=50

Response

An ad campaign report broken down by requested dimensions.

continuation_token
string
Example: "AMC-fuxpGRIqFcOUEzDEdWQsM5Iy7mkRThKFo94mEys6RF1lzeKyq1sOlWU4RsdjSsgDWR2D7An1nFgLXNBU9hocKnWQ9jRsps6kCLqKd7Q77zNEhHm_Xlb6J_Fci6kK7tXVM3U6H8OajjcTA18eFcr-kv0etZJZBWlMhtP84xj4WiVDZnPWaMo7AL3jRrHH32grJ3eRA2PAoZmhg80="
granularity
string
Example: "LIFETIME"
entity
string
EntityDimensionType describes the top-level entity in the ad hierarchy that a particular report will be based off of. Both Aggregate and Insight Reports require an EntityDimensionType.
Allowed values: "AD", "AD_SET", "CAMPAIGN", "AD_ACCOUNT"Example: "AD_SET"
insight
string
InsightDimensionType describes the "second-level" insight that a particular report request is interested in. For example, passing the PLATFORM parameter in a request will generate a LIFETIME report of all requested metrics across IOS, ANDROID, and WEB.
Allowed values: "AGE", "COUNTRY", "GENDER", "GENRE", "PLATFORM"Example: "PLATFORM"
- name
  string
  The name associated with the ad set.
  Example: "My First Ad Set"
- id
  string [uuid]
  ID of the ad set.
  Supported content-type(s): Example: "7f4c1cc9-9a1d-4b65-b05c-46e5e33b6705"
- status
  string
  Status of the ad set.
  Allowed values: "ACTIVE", "APPROVED", "ARCHIVED", "PENDING_APPROVAL", "REJECTED", "PAUSED", "COMPLETED", "READY", "PENDING"Supported content-type(s): Example: "ACTIVE"
- insight_value
  string
  Value of the insight associated with this row. For example, if the requested insight is AGE, then a potential value is "18-25"; alternatively, if COUNTRY was requested, a value could be "US".
  Example: "IOS"
- Array of Report Fields that were requested for this particular insight value. Note: the report fields in this array are LIFETIME values.
  A report field type and its value.
  field_type
  string
  Type of the field that is being requested, i.e., CLICKS, CTR, IMPRESSIONS, etc.
  Allowed values: "CLICKS", "COMPLETES", "CONVERSION_RATE", "CTR", "E_CPM", "E_CPCL", "FIRST_QUARTILES", "FREQUENCY", "IMPRESSIONS", "INTENT_RATE", "LISTENERS", "MIDPOINTS", "NEW_LISTENERS", "NEW_LISTENER_CONVERSION_RATE", "NEW_LISTENER_STREAMS", "OFF_SPOTIFY_IMPRESSIONS", "PAID_LISTENS", "PAID_LISTENS_FREQUENCY", "PAID_LISTENS_REACH", "REACH", "SKIPS", "SPEND", "STARTS", "STREAMS", "STREAMS_PER_NEW_LISTENER", "STREAMS_PER_USER", "THIRD_QUARTILES", "VIDEO_VIEWS", "VIDEO_EXPANDS", "VIDEO_EXPAND_RATE"Supported content-type(s): Example: "CLICKS"
  field_value
  number
  The value for the specified field. This value can be an integer (CLICKS) or float (CTR).
  Example: 500

Response sample

{  "continuation_token": "AMC-fuxpGRIqFcOUEzDEdWQsM5Iy7mkRThKFo94mEys6RF1lzeKyq1sOlWU4RsdjSsgDWR2D7An1nFgLXNBU9hocKnWQ9jRsps6kCLqKd7Q77zNEhHm_Xlb6J_Fci6kK7tXVM3U6H8OajjcTA18eFcr-kv0etZJZBWlMhtP84xj4WiVDZnPWaMo7AL3jRrHH32grJ3eRA2PAoZmhg80=",  "granularity": "LIFETIME",  "entity": "AD_SET",  "insight": "PLATFORM",  "rows": [    {      "name": "Ad Set One",      "id": "7f4c1cc9-9a1d-4b65-b05c-46e5e33b6705",      "status": "ACTIVE",      "insight_value": "IOS",      "stats": [        {          "field_type": "CLICKS",          "field_value": 100        },        {          "field_type": "CTR",          "field_value": 0.56        }      ]    }  ]}