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

Get CAPI Integration

Get a CAPI Integration by ID

Request

  • business_id
    string [uuid]
    Required

    A unique identifier for the entity.

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

    A unique identifier for the CAPI integration.

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

Response

The requested CAPI integration.

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

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