Guides

Conversions API Gateway for Multiple Accounts Control Plane API: Reference

Objects

Tenant

FieldDescription

id
String

Unique identifier of the account

name
String

Name of the account

status
Int

Account status can have 3 values indicating its state:


ValueDescription

0

Active

1

Pending Configuration

2

Deactivated

canPartnerManage
Boolean

This flag indicates whether a partner can manage this account

users
User

List of users in the account

availableRoles
Role

Available roles for the account

canEditTenantSettingsInUI
Boolean

This flag indicates whether user can modify account settings like Pixels, domains, and so on.

canViewTenantInUI
Boolean

Ths flag indicates whether the user can actually view the account detail in UI.

canEditTenantUsersInUI
Boolean

This flag indicates whether a user can add/remove users in account user list, or change their permissions.

tenantUsage
TenantUsage

Tenant Usage info.

User

FieldDescription

id
String

Unique identifier of the user

email
String

User’s email address

status
Int

User status can have 3 values indicating its state:


ValueDescription

0

Deactivated

1

Activated

2

Pending

roles
Role

List of roles of the user

tenants
Tenant

Accounts to which the user belongs

isSelf
Boolean

This indicates whether the logged in user is the same user (would be always false with api).

canBeDeleted
Boolean

This indicates that the user is the only admin of one/more of the accounts, so it can't be deleted.

userExpiry
String

Expiration date for temporary user, in the format of date string “yyyy-mm-dd”.


Role

FieldDescription

name
String

Full name of the role.


Roles can be for agency (partner) users or advertisers (account) users.


Role name follows the following format:

For partner: agency-[ROLE-ACTION]


For advertisers: advertiser-[ROLE-ACTION]-[tenantId]


[ROLE-ACTION] -- This describes the responsibility of the role. It can have one of the 3 values:

  1. admin
  2. user
  3. view

[tenantId] - The id of the account whose roles are being assigned to users

displayName
String

This is the [ROLE-ACTION] of the role

tenantName
String

Name of the tenant/account.

UserType

ValueDescription

AGENCY

This is for partners/host

ADVERTISER

This is for tenant/account.

SignalConfig

FieldDescription

id
ID

Unique identifier of the format SignalConfig:<pixel id>

connectionId
String

The Pixel ID

connectionStatus
ConnectionStatus

Connection status of the Pixel

domains
String

List of domains.

dataSetType
String

Type string of dataset:

  • PIXEL
  • PRIVATE_COMPUTE
  • INDEPENDENT_PIXEL
  • ADVERTISER_HOSTED_SDK
  • EMPTY
  • UNKNOWN

ConnectionStatus

FieldDescription

id
ID

Unique identifier of the Pixel connection ConnectionStatus:<pixel id>

connected
Boolean

Indicates whether Pixel ID and access token are present.

active
Boolean

Indicating whether Pixel is active or not.

eventBridgeActive
Boolean

Indicating whether Event Bridge is active for the Pixel.

publishingEnabled
Boolean

Indicating whether events can be published.

accessKey
String

Access Key for Event Bridge

apiErrorCode
String

Last error code from publishing to Meta Conversions API. Value will be of the format <error code>.<error subcode>. (Reference)

pixelID
String

The unique identifier of the Pixel

pixelName
String

Name of the Pixel

accessTokenAvailable
Boolean

Access token to publish to the Conversions API present or not

totalEventsPublished
Float

Total events published

lastPublished
Float

Timestamp of last event published

totalEventsReceived
Float

Total events received

lastReceived
Float

Timestamp of last event received

IngressDomain

FieldDescription

id
ID

Unique ID for the ingress

tenantName
String

Name of the account

ingress
String

Advertiser domain

cnameResolveSuccess
Boolean

Advertiser domain’s CName is verified

EventFilter

FieldDescription

eventName
String

Name of the event

pixelId
String

The Pixel that the filter applies to. It is null if the filter is applied to all the Pixels.

filterState
EventFilterState

State of the event filter

EventFilterState

Value

PUBLISH

DROP

MIXED

DomainFilter

FieldDescription

eventName
String

Name of the domain

pixelId
String

The Pixel that the filter applies to. It is null if the filter is applied to all the Pixels.

filterState
DomainFilterState

State of the event filter

DomainFilterState

Value

PUBLISH

DROP

MIXED

EventTrafficSummary

FieldDescription

id
ID

Identifier for EventTrafficSummary - always EventTrafficSummary:incoming

eventNamesCount
Int

Count of the event names received

eventsCount
Int

Total events received

ConversionsApiPublishSummary

FieldDescription

id
ID

Identifier for ConversionsApiPublishSummary - always ConversionsApiPublishSummary:global

eventNamesCount
Int

Count of the event names sent

eventsCount
Int

Total events sent

publishSuccessRate
Float

Success rate of publishing events

EventActivity

FieldDescription

id
ID

Identifier for EventActivity of the format - EventActivity:<event name>

name
String

Event name

receivedCount
Int

Total events received

publishedCount
Int

Total events published

lastUpdated
String

Last updated time

DomainActivity

FieldDescription

id
ID

Unique identifier for DomainActivity of the format - DomainActivity:<domain name>

domainName
String

Domain name

receivedCount
Int

Total events received

publishedCount
Int

Total events published

TenantUsage

FieldDescription

totalPixels
Int

Total pixels in the account

totalActivePixels
Int

Total active pixels in the account

totalInactivePixels
Int

Total inactive pixels in the account

tenantUsageByTraffic
TenantUsageByTraffic

Tenant usage by traffic

pixelIds
String

List of associated pixel ids

TenantUsageByTraffic

FieldDescription

totalEventsReceived
Long

Total events received for a Tenant for a duration

totalPixelsWithTraffic
Int

Total number of pixels with traffic for a duration

publishError
Boolean

Error publishing to CAPI for a duration

durationInHours
Int

The duration

lastUpdatedAt
String

Last updated at

See Also