Ads API •References / pixel-measurement / Get all pixels for a business account

Get all pixels for a business account

Get all pixels for the business account.

Request

business_idstring [uuid]
Required
A unique identifier for the entity.
Example: ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a
include_eventsboolean
When true, the response will include events that have been set up, such as page view, purchase, and lead events.
Default: include_events=falseExample: include_events=false
include_historical_eventsboolean
When true, the response will include historical events in the response. Historical events are hourly aggregates of counts of events, intended for debugging use, i.e. verifying that a Javascript hook has been installed correctly and is firing events. There may be up to 20 minutes of delay. If true, historical_events_start_date and historical_events_end_date become required fields. Note: Including historical events can add several seconds to the response time.
Default: include_historical_events=falseExample: include_historical_events=false
historical_events_start_datestring
When include_historical_events is true, the first date of historical events to include. Date should be in ISO 8601 format: yyyy-MM-dd.
Example: historical_events_start_date=2023-07-27
historical_events_end_datestring
When include_historical_events is true, the last date of historical events to include. Date should be in ISO 8601 format: yyyy-MM-dd.
Example: historical_events_end_date=2023-08-02
limitinteger
Limit or page size for a given response.
Default: limit=50Range: 1 - 50Example: limit=50
offsetinteger
Starting position of the next record to assist in data pagination.
Default: offset=0Example: offset=0

Response

Pixels response.

- page_sizeinteger [int32]
- total_resultsinteger [int32]
- offsetinteger [int32]
- current_pageinteger [int32]
- idstring
  Read only
  A unique identifier for a pixel.
  Supported content-type(s): Example: "cd2f1480ba3d4f9b9c5a39893c0def91"
- integration_idstring [uuid]
  Read only
  A unique identifier for the integration.
  Supported content-type(s): Example: "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
- domainstring [uri]
  The URL you would like to track. Only HTTP and HTTPS schemes are allowed.
  Example: "https://www.spotify.com"
- namestring
  The name of the pixel.
  Example: "Spotify"
- created_atstring [date-time]
  Read only
  Date the entity was created. Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ
  Supported content-type(s): Example: "2026-01-23T04:56:07Z"
- Read only
  idstring
  Read only
  A unique identifier for an event.
  Supported content-type(s): Example: "23815327f0c64cf9811516c53c465f37"
  typestring
  The type of event.
  Allowed values: "PAGE_VIEW", "LEAD", "PURCHASE", "ADD_TO_CART"Example: "LEAD"
  created_atstring [date-time]
  Read only
  Date the entity was created. Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ
  Supported content-type(s): Example: "2026-01-23T04:56:07Z"
  last_activity_atstring [date-time]
  Read only
  Date the event was last used. Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ
  Example: "2021-01-23T04:56:07Z"
- Read only
  typestring
  The type of event.
  Allowed values: "PAGE_VIEW", "LEAD", "PURCHASE", "ADD_TO_CART"Example: "LEAD"
  hour_partitionstring [date-time]
  Read only
  The hour the event counts pertain to, in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ
  Example: "2023-08-02T10:00:00Z"
  countinteger
  Read only
  Count of historical events, aggregated for the hour.
  Example: 42
- dataset_idstring [uuid]
  A unique identifier for the dataset.
  Example: "0d86b9e9-70f0-4700-a725-3417ba8786f6"
- aam_opt_inboolean
  Whether AAM is enabled for this pixel. If false, no fields will be used for matching, even if they are present in the AamFields column.
  Example: false
- aam_fieldsarray of strings
  List of AAM fields to enable for matching.
  Array length between 0 and 11Example: ["EMAIL","PHONE","FIRST_NAME"]
  User info field for advanced matching.
  Allowed values: "EMAIL", "PHONE", "FIRST_NAME", "LAST_NAME", "DATE_OF_BIRTH", "GENDER", "CITY", "STATE", "ZIP", "COUNTRY", "EXTERNAL_ID"

Response sample

{  "paging": {    "page_size": 0,    "total_results": 0,    "offset": 0,    "current_page": 0  },  "pixels": [    {      "id": "cd2f1480ba3d4f9b9c5a39893c0def91",      "integration_id": "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a",      "domain": "https://www.spotify.com",      "name": "Spotify",      "created_at": "2026-01-23T04:56:07Z",      "events": [        {          "id": "23815327f0c64cf9811516c53c465f37",          "type": "LEAD",          "created_at": "2026-01-23T04:56:07Z",          "last_activity_at": "2021-01-23T04:56:07Z"        }      ],      "historical_events": [        {          "type": "LEAD",          "hour_partition": "2023-08-02T10:00:00Z",          "count": 42        }      ],      "dataset_id": "0d86b9e9-70f0-4700-a725-3417ba8786f6",      "aam_opt_in": false,      "aam_fields": ["EMAIL", "PHONE", "FIRST_NAME"]    }  ]}