Signals Gateway Control Plane API: Data Pipeline and Signals Gateway Pixel

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

Once integrated, this set of APIs allows advertisers to perform actions such as:

• Manage data sources, for example, create, view and delete ixel 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 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.

API and UI Parity

We are enforcing API and UI parity by exposing the same API endpoints used in the Gateway Product UI. However, any API endpoint not covered in the API Reference is subject to change in future development. In order to limit the unexpected impact to the minimum, those uncovered API endpoints return Error code: 418. You can still use the API but at your own risk.

APIs

Account Management

• Create Account
• Get Account
• Update Account
• Delete Account
• Account Usage

User Management

• Add User With Role
• Change User Roles
• Generate and Send Invitation

Pixel Management

• Create Pixel Connection
• Delete Pixel Connection
• Get List of Meta Pixel Connections
• Activate / Deactivate Gateway from receiving Pixel events
• Activate / Deactivate Pixel event publishing status
• Activate / Deactivate Pixel event publishing status by event name
• Block / Unblock websites permitted to receive and publish events

Account Data Routing Configuration

• Get Data Routing
• Update Data Routing

Account Event Metrics

• Get Account Event Metrics by Time Frame

Objects

• The set of objects used by the APIs.

APIs for Data Pipelines

• Create Gateway Data Pipeline
• Connect Meta Pixel
• Get Data Pipeline
• Update Pipeline
• Delete Pipeline
• Update Pipeline Filter
• Update Pipeline Destination Filter

APIs for Data Sources

• Create Data Source
• Get Data Sources
• Update Data Source
• Delete Data Source
• Generate Gateway Pixel Header Code
• Update Gateway Pixel Data Source Config

APIs for Data Destinations

• Create Data Destination
• Get Data Destination
• Update Data Destination
• Delete Data Destination
• Update Meta Conversions API Data Destination Config
• Update HTTP Custom Connect Data Destination Config

Data Pipelines Objects

• The set of objects used by the Data Pipelines APIs.