Conversions API Gateway for Multiple Accounts Control Plane API: Reference

Control Plane APIs refer to accounts by its legacy name “tenant”. Both are used interchangeably in the sections below.

Once integrated, this set of APIs allow actions from advertisers such as:

  • Manage data sources, for example, create, view and delete Pixel connections
  • Activate/deactivate Pixel from receiving and publishing events
  • Read event counts by, for example, timeframe and event type
  • Manage other account settings, for example, define their own Gateway subdomains and block/unblock domains from receiving/publishing events

capig_domain in the API Reference section refers to AdminDomainName which is specified during stack configuration.

Get API Access Token

Provide the API account name and API secret key obtained in Step 2 of the prerequisites to get a short-lived access token for making subsequent control plane API calls. Note that the token expires in 10 hours and will need to be obtained again by calling this API.

Sample Request

curl -X POST \
-F 'client_id={client_id}' \
-F 'client_secret={client_secret}' \
-F 'grant_type=client_credentials' \

Sample Response

    "token": <token>

Available Parameters




API account name obtained in Step 2 of prerequisites


API secret key obtained in Step 2 of prerequisites