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

Get Account Event Metrics by Time Frame

Gets account specific event metrics at pixel and event level, provided admin has access to manage the account.

Schema

POST https://{capig_domain}/capig/graphql/ 
_________________________________________________________________________________________________________________
      
query HomeViewQuery($tenantId: ID!, $pixelIds: [String!], $timeWindow: Int) {
  tenantQueries(tenantId: $tenantId) {
    eventMetrics(pixelIds: $pixelIds, timeWindowMin: $timeWindow) {
      activity {
        name
        receivedCount
        publishedCount
        lastUpdated
      }
      incoming {
        eventNamesCount
        eventsCount
      }
      outgoing {
        eventNamesCount
        eventsCount
        publishSuccessRate
      }
    }
  }
}
_________________________________________________________________________________________________________
tenantId: ID!
_______________________________________________________________________________________________________
pixelIds: [String!]
_______________________________________________________________________________________________________      
timeWindow: Int

Fields

Field Description

Field	Description
`tenantId` ID	Required Unique identifier of the account
`pixelIds` String	Optional List of Pixel IDs for which event metrics needs to be fetched
`timeWindow` Int	Optional Time window in minutes (Default value is 60 minutes)

tenantId
ID

Required

Unique identifier of the account

pixelIds
String

Optional

List of Pixel IDs for which event metrics needs to be fetched

timeWindow
Int

Optional

Time window in minutes (Default value is 60 minutes)

Returns

EventMetricsSnapshot

Field	Description
`id` ID	Identifier for EventMetricsSnapshot -- always EventTrafficSummary:incoming
`incoming` EventTrafficSummary	Incoming events summary data
`outgoing` ConversionsApiPublishSummary	Outgoing events data
`activity` EventActivity	List of event activity
`domainActivity` DomainActivity	List of domain activity

Error Codes

Code	Description
401	Not authorized to view event metrics
500	Internal server error

Sample Request

Query

query HomeViewQuery($tenantId: ID!, $pixelIds: [String!], $timeWindow: Int) {
 tenantQueries(tenantId: $tenantId) {
   eventMetrics(pixelIds: $pixelIds, timeWindowMin: $timeWindow) {
     activity {
       name
       receivedCount
       publishedCount
       lastUpdated
     }
     incoming {
       eventNamesCount
       eventsCount
     }
     outgoing {
       eventNamesCount
       eventsCount
       publishSuccessRate
     }
   }
 }
}

Variables

{
 "tenantId": "IaoreXfj",
 "pixelIds": ["18904456377094531"]
}

Sample Response

{
   "data": {
       "tenantQueries": {
           "eventMetrics": {
               "activity": [
                   {
                       "name": "Purchase_PN_Mar22_Events",
                       "receivedCount": 4,
                       "publishedCount": 0,
                       "lastUpdated": "1678753252000"
                   }
               ],
               "incoming": {
                   "eventNamesCount": 1,
                   "eventsCount": 4
               },
               "outgoing": {
                   "eventNamesCount": 0,
                   "eventsCount": 0,
                   "publishSuccessRate": 0.0
               }
           }
       }
   }
}