Ads API •References / measurement-datasets / Update Dataset

Update Dataset

Request

business_id
string [uuid]
Required
A unique identifier for the entity.
Example: ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a
dataset_id
string [uuid]
Required
A unique identifier for the dataset.
Example: 0d86b9e9-70f0-4700-a725-3417ba8786f6

name
string
The name of the dataset.
Example: "US Advertising"

Response

The updated Dataset.

id
string [uuid]
Read only
A unique identifier for the dataset.
Supported content-type(s): Example: "0d86b9e9-70f0-4700-a725-3417ba8786f6"
name
string
The name of the dataset.
Example: "US Advertising"
- id
  string
  Read only
  A unique identifier for a pixel.
  Supported content-type(s): Example: "cd2f1480ba3d4f9b9c5a39893c0def91"
- integration_id
  string [uuid]
  Read only
  A unique identifier for the integration.
  Supported content-type(s): Example: "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
- domain
  string [uri]
  The URL you would like to track
  Example: "https://www.spotify.com"
- name
  string
  The name of the pixel.
  Example: "Spotify"
- created_at
  string [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
  id
  string
  Read only
  A unique identifier for an event.
  Supported content-type(s): Example: "23815327f0c64cf9811516c53c465f37"
  type
  string
  The type of event.
  Allowed values: "PAGE_VIEW", "LEAD", "PURCHASE", "ADD_TO_CART"Example: "LEAD"
  created_at
  string [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_at
  string [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
  type
  string
  The type of event.
  Allowed values: "PAGE_VIEW", "LEAD", "PURCHASE", "ADD_TO_CART"Example: "LEAD"
  hour_partition
  string [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"
  count
  integer
  Read only
  Count of historical events, aggregated for the hour.
  Example: 42
- dataset_id
  string [uuid]
  A unique identifier for the dataset.
  Example: "0d86b9e9-70f0-4700-a725-3417ba8786f6"
- aam_opt_in
  boolean
  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_fields
  array 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"
- capi_connection_id
  string [uuid]
  Read only
  A unique identifier for the CAPI integration.
  Supported content-type(s): Example: "2fd920ed-a111-43d4-bee2-74d078c479a5"
- integration_id
  string [uuid]
  Read only
  A unique identifier for the integration.
  Supported content-type(s): Example: "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
- name
  string
  The name of the CAPI integration.
  Example: "Retail Sales"
- dataset_id
  string [uuid]
  A unique identifier for the dataset.
  Example: "0d86b9e9-70f0-4700-a725-3417ba8786f6"
ad_set_count
integer
The number of active or scheduled ad sets using the dataset.
Example: 0
is_archived
boolean
Whether the dataset has been archived.
Default: false
is_receiving_events
boolean
Whether any integrations in the dataset are currently sending events.
Default: false
An ad account a dataset has been shared to.
- id
  string [uuid]
  A unique identifier for an Ad Account.
  Example: "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
- name
  string
  Name of the Ad Account.
  Example: "Spotify"
is_receiving_lead_events
boolean
Whether any integrations in the dataset are currently sending lead events.
Default: false

Response sample

{  "id": "0d86b9e9-70f0-4700-a725-3417ba8786f6",  "name": "US Advertising",  "pixel": {    "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"]  },  "capi_integration": {    "capi_connection_id": "2fd920ed-a111-43d4-bee2-74d078c479a5",    "integration_id": "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a",    "name": "Retail Sales",    "dataset_id": "0d86b9e9-70f0-4700-a725-3417ba8786f6"  },  "ad_set_count": 0,  "is_archived": false,  "is_receiving_events": false,  "shared_ad_accounts": [    {      "id": "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a",      "name": "Spotify"    }  ],  "is_receiving_lead_events": false}