Gateway Products

Conversions API Gateway and Signals Gateway Control Plane API: Reference

Starting from Conversions API Gateway and Signals Gateway v2.2.0, up-to-date versions of the Control Plane API reference docs, including examples with sample data, can be accessed inside your gateway UI. To find these docs:

  • Click on Settings
  • Choose API accounts
  • Click the API Reference link at the top of the API accounts page

Account Data Routing Configuration

Get Data Routing

The query to get the current data routing config of a tenant.

Schema

POST https://{capig_domain}/hub/graphql/ 
_________________________________________________________________________________________________________________
      
query DataRoutingQuery(
 $tenantId: ID!
) {
   ingressDomain(tenantId: $tenantId) {
     id
     ingress
     tenantName
     cnameResolveSuccess
  }
}

_________________________________________________________________________________________________________
tenantId: ID!

Fields

FieldDescription

tenantId
ID

Required

Unique identifier for the account


Returns

FieldDescription

IngressDomain
IngressDomain

Ingress domain object


Error Codes

CodeDescription

401

Not authorized to view the data routing

500

Internal server error


Sample Request

Query

 query DataRoutingCardQuery($tenantId: String!) {
       ingressDomain(tenantId: $tenantId) {
         id
         ingress
         tenantName
         cnameResolveSuccess
       }
     }

Variables

{
  "tenantId": "IaoreXfj"
}

Sample Response

{
  "data": {
    "ingressDomain": {
      "id": "IaoreXfj:ingress",
      "ingress": "www.example.com",
      "tenantName": "IaoreXfj",
      "cnameResolveSuccess": false
    }
  }
}

Update Data Routing

Allows defining a first-party domain for the Meta Pixel to communicate with Conversions API Gateway or Signals Gateway. More details here.

Schema

POST https://{capig_domain}/hub/graphql/ 
_________________________________________________________________________________________________________________
      
mutation IngressEditingModalMutation(
 $tenantId: ID!
 $input: IngressDomainInput
) {
   upsertIngressDomain(input: $input) {
     id
    tenantName
    ingress
    tenant1pDomain
    tenant1pDomainStatus
    cnameResolveSuccess
   }
 }

_________________________________________________________________________________________________________
tenantId: ID!
_______________________________________________________________________________________________________
input IngressDomainInput {
  ingress: String!
  targetDomain: String!
}

Fields

FieldDescription

tenantId
String

Required

Unique identifier of the account


IngressDomainInput

FieldDescription

ingress
String

Required

New subdomain that needs be updated

targetDomain
String

Required

Partner Conversions API Gateway or Signals Gateway Domain


Returns

FieldDescription

IngressDomain
IngressDomain

Ingress domain object


Error Codes

CodeDescription

401

Not authorized to upgrade ingress domain

500

Internal server error


Sample Request

Mutation

 mutation IngressEditingModalMutation(
   $tenantId: ID!
   $input: IngressDomainInput
 ) {
   upsertIngressDomain(input: $input, tenantId: $tenantId) {
     id
     ingress
     cnameResolveSuccess
   }
 }

Variables

{
  "tenantId": "IaoreXfj",
  "input": {
      "ingress": "capig.advertiser.com",
      "targetDomain": "capig.targetDomain.com"
  }
}

Sample Response

{
   "data": {
    "upsertIngressDomain": {
      "id": "admin:ingress",
      "tenantName": "Tenant for test@meta.com",
      "ingress": "capig.advertiser.com",
      "tenant1pDomain": "capig.advertiser.com",
      "tenant1pDomainStatus": "DOMAIN_NOT_SELECTED",
      "cnameResolveSuccess": false
    }
  }

See Also