Skip to content
Ads API •References / capi-measurement / Get CAPI Integration

Get CAPI Integration

Get a CAPI Integration by ID

Request

  • business_idstring [uuid]
    Required

    A unique identifier for the entity.

    Example: ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a
  • capi_connection_idstring [uuid]
    Required

    A unique identifier for the CAPI integration.

    Example: 2fd920ed-a111-43d4-bee2-74d078c479a5

Response

The requested CAPI integration.

  • capi_connection_idstring [uuid]
    Read only

    A unique identifier for the CAPI integration.

    Supported content-type(s): Example: "2fd920ed-a111-43d4-bee2-74d078c479a5"
  • integration_idstring [uuid]
    Read only

    A unique identifier for the integration.

    Supported content-type(s): Example: "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
  • namestring

    The name of the CAPI integration.

    Example: "Retail Sales"
  • dataset_idstring [uuid]

    A unique identifier for the dataset.

    Example: "0d86b9e9-70f0-4700-a725-3417ba8786f6"
  • Read only
    • event_typestring

      Type of signal event.

      Allowed values: "VIEW", "PRODUCT", "CHECKOUT", "ADDTOCART", "PURCHASE", "LEAD", "ALIAS", "SIGNUP", "CLICK", "CUSTOM_EVENT_1", "CUSTOM_EVENT_2", "CUSTOM_EVENT_3", "CUSTOM_EVENT_4", "CUSTOM_EVENT_5"
    • first_event_timestring [date-time]
      Read only

      Time when event type was first received. Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ example: "2026-01-23T04:56:07Z"

Response sample

{  "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",  "events_received": [    {      "event_type": "VIEW",      "first_event_time": "string"    }  ]}