Skip to content
Ads API •References / pixel-measurement / Create pixel

Create pixel

Create a new pixel.

Request

  • business_id
    string [uuid]
    Required

    A unique identifier for the entity.

    Example: ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a
  • domain
    string [uri]
    Required

    The URL you would like to track

    Example: "https://www.spotify.com"
  • name
    string
    Required

    The name of the pixel.

    Example: "Spotify"
  • 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"

Response

The pixel was created successfully.

  • 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"

Response sample