Ads API •References / capi-measurement / Get CAPI Integrations for Business

Get CAPI Integrations for Business

Get all CAPI integrations for a business

Request

business_id
string [uuid]
Required
A unique identifier for the entity.
Example: ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a

Response

CAPI integrations response.

- page_size
  integer [int32]
- total_results
  integer [int32]
- offset
  integer [int32]
- current_page
  integer [int32]
- 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

{  "paging": {    "page_size": 0,    "total_results": 0,    "offset": 0,    "current_page": 0  },  "integrations": [    {      "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"    }  ]}