GraphQL Reporting API Schema¶
Note
You can browse the schema and experiment with building queries using the GraphQL Reporting API console.
Objects¶
Objects represent a set of fields.
List¶
Descriptions¶
-
Ad¶ Fields:
-
hasFutureCampaigns: Boolean!¶ Whether or not this ad has the possibility of serving based on the adgroups and campaigns in which it inhabits.
DEPRECATED: this field will stop being supported in the near future.
-
status: String!¶ One of ‘running’, ‘paused’, ‘review’, ‘draft’, ‘rejected’, ‘suspended’ or ‘deleted’.
-
actualStatus: JSON¶ The effective status of the campaign. Details the reasons why it is not running, if applicable.
-
actualStatusString: String!¶ Minimal string representation of the actual status. One of ‘running’, ‘notRunning’ ,’ended’, ‘paused’, ‘review’, ‘draft’, ‘rejected’ or ‘deleted’.
-
hasEdits: Boolean!¶ Whether or not this ad has been edited such that another ad has it’s original ad parameter set to this ad’s EID.
-
hasPendingEdits: Boolean!¶ Whether or not this ad has edits that must be reviewed by an AdRoll administrator.
-
isDynamic: Boolean!¶ Whether or not this is an ad that is dynamically composed when it is served to the user.
-
isOutlined: Boolean!¶ Whether or not an outline has been applied to the ad to satisfy network compliancy.
-
validClicktag: Boolean!¶ If the ad is in flash format, this is the flag showing whether or not the clickTAG is compliant.
-
syncStatus: String!¶ Only for Connected Campaigns’ ads, indicates the status of the sync’ing with the external service. When available, can be one of “pending”, “synced” or “error”
-
syncError: String!¶ Only for Connected Campaigns’ ads, shows the error that caused the sync’ing with the external service to fail. Provided if the syncStatus field is “error”.
-
remoteStatus: String!¶ The status of the Ad on the inventory network NextRoll has sync’ed it to (ex: Facebook)
-
disapprovalReason: String!¶ The reason why an Ad has been rejected on the inventory network NextRoll has sync’ed it to (ex: Facebook)
-
channel: String!¶ The channel for the campaign this ad belongs to. This is only available when loading the ads through a campaign.
-
campaignType: String!¶ The type for the campaign this ad belongs to. This is only available when loading the ads through a campaign.
-
inAdgroupEID: String!¶ The AdGroup’s EID in the AdGroupAd relationship, if listed inside an AdGroup.
-
inAdgroupIsActive: Boolean!¶ True of the AdGroupAd relationship is active, if listed inside an AdGroup.
-
inAdgroupRelationshipEID: String!¶ The the internal EID of the AdGroupAd relationship, if such a EID exists and if the ad is listed inside an AdGroup.
-
metrics(start: Date, end: Date, pastDays: Int, currency: String, duration: Int): MetricResult!¶ Metrics for the entity.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
conversions(start: Date, end: Date, pastDays: Int, currency: String): ConversionResult!¶ Metrics for the entity broken down by conversion audiences.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
metricsTotal: MetricAggregateResult¶ Provides aggregation for any metrics in the current and child nodes.
Note that this will not load the metrics by itself, instead it aggregates loaded metrics fields in its scope.
For details see the documentation of MetricAggregateResult.
-
-
AdGroupData¶ Fields:
-
hasFutureCampaigns: Boolean!¶ Whether or not this ad has the possibility of serving based on the adgroups and campaigns in which it inhabits.
DEPRECATED: this field will stop being supported in the near future.
-
status: String!¶ One of ‘running’, ‘paused’, ‘review’, ‘draft’, ‘rejected’, ‘suspended’ or ‘deleted’.
-
actualStatus: JSON¶ The effective status of the campaign. Details the reasons why it is not running, if applicable.
-
actualStatusString: String!¶ Minimal string representation of the actual status. One of ‘running’, ‘notRunning’ ,’ended’, ‘paused’, ‘review’, ‘draft’, ‘rejected’ or ‘deleted’.
-
hasEdits: Boolean!¶ Whether or not this ad has been edited such that another ad has it’s original ad parameter set to this ad’s EID.
-
hasPendingEdits: Boolean!¶ Whether or not this ad has edits that must be reviewed by an AdRoll administrator.
-
isDynamic: Boolean!¶ Whether or not this is an ad that is dynamically composed when it is served to the user.
-
isOutlined: Boolean!¶ Whether or not an outline has been applied to the ad to satisfy network compliancy.
-
validClicktag: Boolean!¶ If the ad is in flash format, this is the flag showing whether or not the clickTAG is compliant.
-
syncStatus: String!¶ Only for Connected Campaigns’ ads, indicates the status of the sync’ing with the external service. When available, can be one of “pending”, “synced” or “error”
-
syncError: String!¶ Only for Connected Campaigns’ ads, shows the error that caused the sync’ing with the external service to fail. Provided if the syncStatus field is “error”.
-
remoteStatus: String!¶ The status of the Ad on the inventory network NextRoll has sync’ed it to (ex: Facebook)
-
disapprovalReason: String!¶ The reason why an Ad has been rejected on the inventory network NextRoll has sync’ed it to (ex: Facebook)
-
channel: String!¶ The channel for the campaign this ad belongs to. This is only available when loading the ads through a campaign.
-
campaignType: String!¶ The type for the campaign this ad belongs to. This is only available when loading the ads through a campaign.
-
inAdgroupEID: String!¶ The AdGroup’s EID in the AdGroupAd relationship, if listed inside an AdGroup.
-
-
AdQuery¶ Fields:
-
byEID(ad: String!): Ad¶ Resolves an Ad by its EID.
[WARNING] Fetching Ads directly through this operation will ignore the overrides and state provided by its relationship to an AdGroup. For a complete state fetch ads as children of Adgroups.
Arguments:
-
byEIDs(eids: [String!]!): [Ad]!¶ Resolves Ads by their EIDs.
[WARNING] Fetching Ads directly through this operation will ignore the overrides and state provided by its relationship to an AdGroup. For a complete state fetch ads as children of Adgroups.
Arguments:
-
byAdvertisable(advertisable: String!, isActive: Boolean, statuses: [String!], types: [String!], width: Int, height: Int, createdDateAfterOrOn: String, createdDateBefore: String, updatedDateAfterOrOn: String, updatedDateBefore: String): [Ad]!¶ Resolves all Ads for an Advertisable.
[WARNING] Fetching Ads directly through this operation will ignore the overrides and state provided by its relationship to an AdGroup. For a complete state fetch ads as children of Adgroups.
Arguments:
-
isActive: Boolean¶ If True, only active ads will be returned, and vice versa (Optional; default: True)
-
statuses: [String!]¶ Only ads that match one of these statuses will be returned (Optional; default: None)
- Default
[ ]
-
types: [String!]¶ Only ads that match one of these types will be returned (Optional; default: None)
- Default
[ ]
-
width: Int¶ Only ads having the specified width will be returned (Optional; default: None)
- Default
0
-
height: Int¶ Only ads having the specified height will be returned (Optional; default: None)
- Default
0
-
createdDateAfterOrOn: String¶ Only ads that were created after on on the given date. String in ISO Date + Time format. (Optional; default: None)
- Default
“”
-
createdDateBefore: String¶ Only ads that were created before on on the given date. It will do a less than or equal to string comparison. Reminder that startDate is a ISO timestamp. (Optional; default: None)
- Default
“”
-
-
byAdgroup(adgroup: String!, isActive: Boolean, statuses: [String!], types: [String!], width: Int, height: Int, createdDateAfterOrOn: String, createdDateBefore: String, updatedDateAfterOrOn: String, updatedDateBefore: String): [Ad]!¶ Resolves all Ads for an AdGroup.
Arguments:
-
isActive: Boolean¶ If True, only active ads will be returned, and vice versa (Optional; default: True)
-
statuses: [String!]¶ Only ads that match one of these statuses will be returned (Optional; default: None)
- Default
[ ]
-
types: [String!]¶ Only ads that match one of these types will be returned (Optional; default: None)
- Default
[ ]
-
width: Int¶ Only ads having the specified width will be returned (Optional; default: None)
- Default
0
-
height: Int¶ Only ads having the specified height will be returned (Optional; default: None)
- Default
0
-
createdDateAfterOrOn: String¶ Only ads that were created after on on the given date string. It will do a greater than or equal to string comparison. Reminder that startDate is a ISO timestamp. (Optional; default: None)
- Default
“”
-
createdDateBefore: String¶ Only ads that were created before on on the given date string. It will do a less than or equal to string comparison. Reminder that startDate is a ISO timestamp. (Optional; default: None)
- Default
“”
-
-
metricsTotal: MetricAggregateResult¶ Provides aggregation for any metrics in the current and child nodes.
Note that this will not load the metrics by itself, instead it aggregates loaded metrics fields in its scope.
For details see the documentation of MetricAggregateResult.
-
-
Adgroup¶ Fields:
-
actualStatus: JSON¶ The effective status of the adgroup. Details the reasons why it is not running, if applicable.
-
actualStatusString: String!¶ Minimal string representation of the actual status. One of ‘running’, ‘notRunning’ ,’ended’, ‘paused’, ‘review’, ‘draft’, ‘rejected’ or ‘deleted’.
-
processingStatus: String!¶ The processing status of the campaign inside the AdRoll. It may have a transient value other than “created” while the AdGroup is being processed by an internal job.
-
significantFlightStartDate: DateTime¶ Start date for the active or most recent flight period in the adgroup.
-
significantFlightEndDate: DateTime¶ End date for the active or most recent flight period in the adgroup.
-
advertisable: String!¶ Advertisable for this Adgroup. NOTE/FIXME: the advertisable information is not usually available, so querying this will cause an additional request to be made.
-
kpiGoal: Decimal¶ Goal -for the kpiMetric- that drives the campaign’s bid strategy. Null for automatic.
-
kpiCurrency: String!¶ ISO 4217 currency code for kpiGoal. If not provided assume the currency provided at the Advertisable level.
-
adType: String!¶ Ad type restriction for this adgroup. Empty if there is no explicit restriction. Currently one of “static”or “dynamic.
-
syncStatus: String!¶ Only for Connected Campaigns’ adgroups, indicates the status of the sync’ing with the external service. When available, can be one of “pending”, “synced” or “error”
-
syncError: String!¶ Only for Connected Campaigns’ adgroups, shows the error that caused the sync’ing with the external service to fail. Provided if the syncStatus field is “error”.
-
ads(isActive: Boolean, statuses: [String!], types: [String!], width: Int, height: Int, createdDateAfterOrOn: String, createdDateBefore: String, updatedDateAfterOrOn: String, updatedDateBefore: String): [Ad]!¶ Ads for this Adgroup.
Arguments:
-
isActive: Boolean¶ If True, only active ads will be returned, and vice versa (Optional; default: True)
-
statuses: [String!]¶ Only ads that match one of these statuses will be returned (Optional; default: None)
- Default
[ ]
-
types: [String!]¶ Only ads that match one of these types will be returned (Optional; default: None)
- Default
[ ]
-
width: Int¶ Only ads having the specified width will be returned (Optional; default: None)
- Default
0
-
height: Int¶ Only ads having the specified height will be returned (Optional; default: None)
- Default
0
-
createdDateAfterOrOn: String¶ Only ads that were created after on on the given date string. It will do a greater than or equal to string comparison. Reminder that startDate is a ISO timestamp. (Optional; default: None)
- Default
“”
-
createdDateBefore: String¶ Only ads that were created before on on the given date string. It will do a less than or equal to string comparison. Reminder that startDate is a ISO timestamp. (Optional; default: None)
- Default
“”
-
-
metrics(start: Date, end: Date, pastDays: Int, currency: String, duration: Int): MetricResult!¶ Metrics for the entity.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
placements(start: Date, end: Date, pastDays: Int, currency: String): PlacementResult!¶ Metrics for the AdGroup broken down by conversion audiences. This breakdown will only be provided for Facebook campaigns.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
keywords(start: Date, end: Date, pastDays: Int, currency: String): KeywordResult!¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Currently Fetching Keywords and keyword metrics without also requesting metrics for parent adgroup or campaign will return empty result.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
conversions(start: Date, end: Date, pastDays: Int, currency: String): ConversionResult!¶ Metrics for the entity broken down by conversion audiences.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
metricsTotal: MetricAggregateResult¶ Provides aggregation for any metrics in the current and child nodes.
Note that this will not load the metrics by itself, instead it aggregates loaded metrics fields in its scope.
For details see the documentation of MetricAggregateResult.
-
-
AdgroupGroupData¶ Fields:
-
actualStatus: JSON¶ The effective status of the adgroup. Details the reasons why it is not running, if applicable.
-
actualStatusString: String!¶ Minimal string representation of the actual status. One of ‘running’, ‘notRunning’ ,’ended’, ‘paused’, ‘review’, ‘draft’, ‘rejected’ or ‘deleted’.
-
processingStatus: String!¶ The processing status of the campaign inside the AdRoll. It may have a transient value other than “created” while the AdGroup is being processed by an internal job.
-
significantFlightStartDate: DateTime¶ Start date for the active or most recent flight period in the adgroup.
-
significantFlightEndDate: DateTime¶ End date for the active or most recent flight period in the adgroup.
-
advertisable: String!¶ Advertisable for this Adgroup. NOTE/FIXME: the advertisable information is not usually available, so querying this will cause an additional request to be made.
-
kpiGoal: Decimal¶ Goal -for the kpiMetric- that drives the campaign’s bid strategy. Null for automatic.
-
kpiCurrency: String!¶ ISO 4217 currency code for kpiGoal. If not provided assume the currency provided at the Advertisable level.
-
adType: String!¶ Ad type restriction for this adgroup. Empty if there is no explicit restriction. Currently one of “static”or “dynamic.
-
-
AdgroupQuery¶ Fields:
-
byAdvertisable(advertisable: String!): [Adgroup]!¶ Resolves all Adgroups for a Advertisable.
Arguments:
-
metricsTotal: MetricAggregateResult¶ Provides aggregation for any metrics in the current and child nodes.
Note that this will not load the metrics by itself, instead it aggregates loaded metrics fields in its scope.
For details see the documentation of MetricAggregateResult.
-
-
Advertisable¶ Fields:
-
isB2B: Boolean!¶ Whether or not the advertisable is a B2B customer. Deprecated field: use businessUnit instead.
-
status: String!¶ The status of the advertisable. One of [‘admin_review’, ‘approved’, ‘rejected’, ‘suspended’].
-
clickThroughConversionWindow: Int!¶ Duration of this advertisable’s click through conversion window in days.
-
viewThroughConversionWindow: Int!¶ Duration of this advertisable’s view through conversion window in days.
-
campaigns(isActive: Boolean, statuses: [String!], excludeStatuses: [String!], blacklistStatuses: [String!], useCases: [String!], types: [String!], targetingTypes: [String!], channels: [String!], sources: [String!], funnelStages: [String!], excludeUseCases: [String!], excludeTypes: [String!], excludeTargetingTypes: [String!], excludeChannels: [String!], excludeSources: [String!], excludeFunnelStages: [String!], tagPrefixes: [String!]): [Campaign]!¶ Campaigns for this Advertisable.
Arguments:
-
isActive: Boolean¶ If True, only active campaigns will be returned, and vice versa (Optional; default: True)
-
statuses: [String!]¶ Only campaigns that match one of these statuses will be returned (Optional; default: None)
- Default
[ ]
-
excludeStatuses: [String!]¶ Only campaigns whose status is not one of these will be returned (Optional; default: None)
- Default
[ ]
-
useCases: [String!]¶ Only campaigns that match one of these use cases will be returned (Optional; default: None)
- Default
[ ]
-
types: [String!]¶ Only campaigns that match one of these types will be returned (Optional; default: None)
- Default
[ ]
-
targetingTypes: [String!]¶ Only campaigns that match one of these targeting types will be returned (Optional; default: None)
- Default
[ ]
-
channels: [String!]¶ Only campaigns that match one of these channels will be returned (Optional; default: None)
- Default
[ ]
-
sources: [String!]¶ Only campaigns that match one of these sources will be returned (Optional; default: None)
- Default
[ ]
-
funnelStages: [String!]¶ Only campaigns that match one of these funnel stages will be returned (Optional; default: None)
- Default
[ ]
-
excludeUseCases: [String!]¶ Exclude campaigns that match one of the given use cases (Optional; default: None)
- Default
[ ]
-
excludeTypes: [String!]¶ Exclude campaigns that match one of the given types. (Optional; default: None)
- Default
[ ]
-
excludeTargetingTypes: [String!]¶ Exclude campaigns that match one of the given targeting types. (Optional; default: None)
- Default
[ ]
-
excludeChannels: [String!]¶ Exclude campaigns that match one of the given channels. (Optional; default: None)
- Default
[ ]
-
excludeSources: [String!]¶ Exclude campaigns that match one of the given sources. (Optional; default: None)
- Default
[ ]
-
-
automations: [Automation]!¶ Automations for this Advertisable.
-
smsMessages: [SMSMessage]!¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
SMS Messages for this Advertisable.
-
ads(isActive: Boolean, statuses: [String!], types: [String!], width: Int, height: Int, createdDateAfterOrOn: String, createdDateBefore: String, updatedDateAfterOrOn: String, updatedDateBefore: String): [Ad]!¶ Ads for this Advertisable.
Arguments:
-
isActive: Boolean¶ If True, only active ads will be returned, and vice versa (Optional; default: False)
-
statuses: [String!]¶ Only ads that match one of these statuses will be returned (Optional; default: None)
- Default
[ ]
-
types: [String!]¶ Only ads that match one of these types will be returned (Optional; default: None)
- Default
[ ]
-
width: Int¶ Only ads having the specified width will be returned (Optional; default: None)
- Default
0
-
height: Int¶ Only ads having the specified height will be returned (Optional; default: None)
- Default
0
-
createdDateAfterOrOn: String¶ Only ads that were created after on on the given date string. It will do a greater than or equal to string comparison. Reminder that startDate is a ISO timestamp. (Optional; default: None)
- Default
“”
-
createdDateBefore: String¶ Only ads that were created before on on the given date string. It will do a less than or equal to string comparison. Reminder that startDate is a ISO timestamp. (Optional; default: None)
- Default
“”
-
-
segments(isActive: Boolean, isConversion: Boolean): [Segment]!¶ Segments for this Advertisable.
Arguments:
-
metrics(start: Date, end: Date, pastDays: Int, currency: String, duration: Int): AdvertisableMetricResult!¶ Metrics for the Advertisable.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
conversions(start: Date, end: Date, pastDays: Int, currency: String): ConversionResult!¶ Metrics for the entity broken down by conversion audiences.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
metricsTotal: MetricAggregateResult¶ Provides aggregation for any metrics in the current and child nodes.
Note that this will not load the metrics by itself, instead it aggregates loaded metrics fields in its scope.
For details see the documentation of MetricAggregateResult.
-
granularConversions(start: Date, end: Date, pastDays: Int, currency: String): [GranularConversion!]!¶ The granular conversions help understand the channels, campaigns, and ads that influence conversions. Lists the details about a conversion and the data points that determined the decision about its attribution. Limited to 90 days.
Arguments:
-
start: Date¶ The start date for the conversions period (inclusive). The date range will be: [start, end)
-
end: Date¶ The end date for the conversions period (exclusive). The date range will be: [start, end)
-
-
utmBasedConversions(start: Date, end: Date, pastDays: Int, currency: String, model: String!): [UtmBasedConversionsForAdvertisable!]!¶ UTM based conversions for the Advertisable.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
-
AdvertisableGroupData¶ Fields:
-
isB2B: Boolean!¶ Whether or not the advertisable is a B2B customer. Deprecated field: use businessUnit instead.
-
status: String!¶ The status of the advertisable. One of [‘admin_review’, ‘approved’, ‘rejected’, ‘suspended’].
-
clickThroughConversionWindow: Int!¶ Duration of this advertisable’s click through conversion window in days.
-
viewThroughConversionWindow: Int!¶ Duration of this advertisable’s view through conversion window in days.
-
-
AdvertisableMetricResult¶ Groups reporting metric data in summary, by date and by domain format.
Fields:
-
summary: MetricForAdvertisable!¶ Summarizes the reporting data for the given date range.
-
byDate: [MetricForAdvertisable!]!¶ Reporting data by date in the given range.
-
byDomain: [MetricDomainResult!]!¶ Reporting data by domain.
-
-
AdvertisableQuery¶ Fields:
-
byEID(advertisable: String!): Advertisable¶ Obtain an Advertisable by its unique identifier (EID).
Arguments:
-
byEIDs(eids: [String!]!): [Advertisable]!¶ Obtain a list of Advertisables by their unique identifiers (EID).
Arguments:
-
byOrganization(organization: String!): [Advertisable]!¶ Obtain a list Advertisables owned by an Organization.
Arguments:
-
forUser: [Advertisable]!¶ All the advertisables for the current user.
-
metricsTotal: MetricAggregateResult¶ Provides aggregation for any metrics in the current and child nodes.
Note that this will not load the metrics by itself, instead it aggregates loaded metrics fields in its scope.
For details see the documentation of MetricAggregateResult.
-
-
Audience¶ Fields:
-
type: String!¶ The type of the segment. One of: - “url”: URL - “crm”: crm - “pages_viewed”: Pages Viewed - “products_viewed”: Products Viewed - “arbitrary_data”: External Data - “app_install”: App Install - “facebook_prospecting”: Facebook Prospecting - “custom”: Partner - “intent”: Intent - “impression”: Impression - “user_attributes”: Attributes - “user_events”: Events - “lead_generation”: Lead Generation - “composite”: Composite - “event_match”: Event JS Match - “js_match”: Explicit JS Match - “ipixel_match”: IPixel Match - “css_selector”: CSS Selector - “email_list”: Email List in AdRoll Email. - “email_domain”: Email Address Domain Match.
Tags explicitly assigned to the segment.
-
currency: String!¶ The value of a conversion from this segment. Default to the Advertisable’s currency.
-
-
AudienceGroupData¶ Fields:
-
type: String!¶ The type of the segment. One of: - “url”: URL - “crm”: crm - “pages_viewed”: Pages Viewed - “products_viewed”: Products Viewed - “arbitrary_data”: External Data - “app_install”: App Install - “facebook_prospecting”: Facebook Prospecting - “custom”: Partner - “intent”: Intent - “impression”: Impression - “user_attributes”: Attributes - “user_events”: Events - “lead_generation”: Lead Generation - “composite”: Composite - “event_match”: Event JS Match - “js_match”: Explicit JS Match - “ipixel_match”: IPixel Match - “css_selector”: CSS Selector - “email_list”: Email List in AdRoll Email. - “email_domain”: Email Address Domain Match.
Tags explicitly assigned to the segment.
-
-
AudienceMetric¶ Groups reporting metric audience data in summary and by date format.
Fields:
-
audienceSizeCurrent: Decimal!¶ Total number of unique visitors within the duration of the segment. i.e. [TODAY - DURATION, TODAY).
This is the total number of visitors who can be retargeted using this segment.
-
audienceSizeNew: Decimal!¶ [DEPRECATED] Please use the other metrics in this node instead. Count of unique new visitors who visited the entities between the specified date range.
-
-
AudienceMetricResult¶ Groups reporting metric audience data in summary and by date format.
Fields:
-
summary: AudienceMetric!¶ Summarizes the reporting data for the given date range and duration.
-
-
Automation¶ Fields:
-
firstLaunchDate: DateTime¶ The timestamp for the first time that a node was successfully launched from this automation
-
entrySegmentEID: String!¶ EID of the base internal segment that includes contacts in the automation.
-
classification: String!¶ Classification for the automation. A non-localized constant identifying the automation’s type.
-
funnelStage: String!¶ Funnel stage for the automation. One of ‘awareness’, ‘consideration’, ‘conversion’, or ‘other’.
-
smsCampaignEID: String¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
EID of the SMS campaign that backs the SMS in this automation.
-
smsCampaign: Campaign¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
nodes: [AutomationNode]!¶
-
metrics(start: Date, end: Date, pastDays: Int, currency: String, duration: Int): CampaignMetricResult!¶ Metrics for the Campaign.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
conversions(start: Date, end: Date, pastDays: Int, currency: String): ConversionResult!¶ Metrics for the entity broken down by conversion audiences.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
metricsTotal: MetricAggregateResult¶ Provides aggregation for any metrics in the current and child nodes.
Note that this will not load the metrics by itself, instead it aggregates loaded metrics fields in its scope.
For details see the documentation of MetricAggregateResult.
-
-
AutomationNode¶ Fields:
-
isRoot: Boolean!¶ True if this node is one of the tree’s roots.
If this is false and parentNodeEID is null, the node is considered detached.
-
delayHours: Float!¶ Additional time to wait—since the completion of the previous node—before the contact reaches this node.
-
audienceAdditionalRules: String¶ Additional rules to be layered on top of the baseline established by the Automation’s trigger & exclusion plus the node position on the flow.
-
durationHours: Float¶ For Ad campaigns, maximum time that the user would be served this campaign.
For delay nodes, the time before the flow can continue.
-
extensionEntrySegmentEIDs: JSON¶ Additional segment EIDs that extend the reach of the campaign;’s entry audience
-
extensionExitSegmentEIDs: JSON¶ Additional segment EIDs that extend the reach of the campaign;’s exit audience
-
smsMessageEID: String¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
smsMessage: SMSMessage¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
metrics(start: Date, end: Date, pastDays: Int, currency: String, duration: Int): CampaignMetricResult!¶ Metrics for the Campaign.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
conversions(start: Date, end: Date, pastDays: Int, currency: String): ConversionResult!¶ Metrics for the entity broken down by conversion audiences.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
metricsTotal: MetricAggregateResult¶ Provides aggregation for any metrics in the current and child nodes.
Note that this will not load the metrics by itself, instead it aggregates loaded metrics fields in its scope.
For details see the documentation of MetricAggregateResult.
-
-
AutomationQuery¶ Fields:
-
byEID(automation: String!): Automation¶ Arguments:
-
byEIDs(eids: [String!]!): [Automation!]!¶ Arguments:
-
-
Campaign¶ Fields:
-
budget: Decimal!¶ The daily budget of the campaign. Note that this can be an approximation, for example when budgetType = “lifetime” it is: budget = budgetGoal / numberOfDays(budgetStartDate, budgetEndDate)
-
budgetGoal: Decimal!¶ The budget of the campaign, considered for the whole extent of its budgetType. When budgetType = “lifetime”, it will be applied in the period since budgetStartDate until budgetEndDate.
-
budgetType: String!¶ The type of budget of the campaign (daily, lifetime…). If this includes -auto (i.e. daily-auto), then it is the inventory campaign of a proxy strategy that is auto-balancing the budget for this campaign
-
budgetSettingsString: String!¶ Serialized budget settings as a string. “budgetType,budgetStartDate,budgetEndDate,budgetGoal”
-
status: String!¶ The status of the campaign. One of ‘running’, ‘ended’, ‘paused’, ‘review’, ‘draft’, ‘rejected’ or ‘deleted’. Result is ‘billingFailedPermanent’ or ‘billingFailedRecoverable’ when BillingAuthStatus is ‘failed’.
-
actualStatus: JSON¶ The effective status of the campaign. Details the reasons why it is not running, if applicable.
-
actualStatusString: String!¶ Minimal string representation of the actual status. One of ‘running’, ‘notRunning’ ,’ended’, ‘paused’, ‘review’, ‘draft’, ‘rejected’ or ‘deleted’.
-
targetingType: String!¶ The type of targeting that is used to pick which customers will be reached by this campaign.
-
kpiGoal: Decimal!¶ Goal -for the kpiMetric- that drives the campaign’s bid strategy. Null for automatic.
-
kpiCurrency: String!¶ ISO 4217 currency code for kpiGoal. If not provided assume the currency provided at the Advertisable level.
-
processingStatus: String!¶ The processing status of the campaign inside the AdRoll. It may have a transient value other than “created” while the campaign is being processed by an internal job.
-
billingAuthStatus: String¶ The billing auth status of the campaign inside the AdRoll. Will default to empty string when API BillingAuthStatus not present. Result is “failed” when the billing authorization did not complete.
-
inVoltronStrategyEID: String!¶ The EID of this campaign as referenced from its Voltron strategy. Only available for inventory campaigns of Universal Campaigns.
-
proxyStrategyEID: String!¶ The eid of the Proxy Strategy that contains this campaign. Only for Inventory campaigns.
-
proxyStrategyStatus: String!¶ The status of the Proxy Strategy that contains this campaign. Only for Inventory campaigns.
-
proxyStrategyName: String!¶ The name of the Proxy Strategy that contains this campaign. Only for Inventory campaigns.
If this is an Email Newsletter campaign, the number of potential recipients.
If this is an Email Newsletter campaign, the number of emails sent.
If this is an Email Newsletter campaign, the scheduled date for delivery. Only if the delivery is scheduled to happen or of it has already occurred. Omitted if in draft, paused or cancelled.
-
isBillable: Boolean!¶ True if the campaign is run by NextRoll and will be directly billed to the advertisable’s account. False if it is run by a third party.
-
syncStatus: String!¶ Only for Connected Campaigns, indicates the status of the sync’ing with the external service. When available, can be one of “pending”, “synced” or “error”
-
syncError: String!¶ Only for Connected Campaigns, shows the error that caused the sync’ing with the external service to fail. Provided if the syncStatus field is “error”.
-
funnelStage: String¶ Funnel stage for the campaign. One of “awareness”, “consideration”, “conversion”, or “other”.
-
isBudgetBalancingAutomated: Boolean!¶ Indicates if this campaign is a strategy that balances the budget automatically across its inventory campaigns. False means that inventory campaign budgets are manually set.
-
performanceTargets: [PerformanceTarget]¶ PerformanceTargets
Internal tags set on creation.
-
automationNodeEID: String¶ If managed by an Automation, the EID of the Automation Node that references this entity.
-
disabled: Boolean!¶ Indicates if the campaign is disabled. Currently applies only to Automation-managed campaigns that have been disabled by subscription downgrade action.
-
campaignGroupEID: String!¶ EID for the parent Universal/Proxy campaign group for an inventory campaign.
This is only available if Universal or Proxy campaign are enabled in the query.
-
campaignGroupName: String!¶ Name for the parent Universal/Proxy campaign group for an inventory campaign.
This is only available if Universal or Proxy campaign are enabled in the query.
-
smsMessages: [SMSMessage]!¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
SMS Messages for this Campaign.
-
metrics(start: Date, end: Date, pastDays: Int, currency: String, duration: Int): CampaignMetricResult!¶ Metrics for the Campaign.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
conversions(start: Date, end: Date, pastDays: Int, currency: String): ConversionResult!¶ Metrics for the entity broken down by conversion audiences.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
metricsTotal: MetricAggregateResult¶ Provides aggregation for any metrics in the current and child nodes.
Note that this will not load the metrics by itself, instead it aggregates loaded metrics fields in its scope.
For details see the documentation of MetricAggregateResult.
-
inventoryCampaigns: [InventoryCampaign]!¶ Inventory Campaigns that compose this campaign in the case of Proxy Campaigns.
-
-
CampaignGroupData¶ Fields:
-
budget: Decimal!¶ The daily budget of the campaign. Note that this can be an approximation, for example when budgetType = “lifetime” it is: budget = budgetGoal / numberOfDays(budgetStartDate, budgetEndDate)
-
budgetGoal: Decimal!¶ The budget of the campaign, considered for the whole extent of its budgetType. When budgetType = “lifetime”, it will be applied in the period since budgetStartDate until budgetEndDate.
-
budgetType: String!¶ The type of budget of the campaign (daily, lifetime…). If this includes -auto (i.e. daily-auto), then it is the inventory campaign of a proxy strategy that is auto-balancing the budget for this campaign
-
budgetSettingsString: String!¶ Serialized budget settings as a string. “budgetType,budgetStartDate,budgetEndDate,budgetGoal”
-
status: String!¶ The status of the campaign. One of ‘running’, ‘ended’, ‘paused’, ‘review’, ‘draft’, ‘rejected’ or ‘deleted’. Result is ‘billingFailedPermanent’ or ‘billingFailedRecoverable’ when BillingAuthStatus is ‘failed’.
-
actualStatus: JSON¶ The effective status of the campaign. Details the reasons why it is not running, if applicable.
-
actualStatusString: String!¶ Minimal string representation of the actual status. One of ‘running’, ‘notRunning’ ,’ended’, ‘paused’, ‘review’, ‘draft’, ‘rejected’ or ‘deleted’.
-
targetingType: String!¶ The type of targeting that is used to pick which customers will be reached by this campaign.
-
kpiGoal: Decimal!¶ Goal -for the kpiMetric- that drives the campaign’s bid strategy. Null for automatic.
-
kpiCurrency: String!¶ ISO 4217 currency code for kpiGoal. If not provided assume the currency provided at the Advertisable level.
-
processingStatus: String!¶ The processing status of the campaign inside the AdRoll. It may have a transient value other than “created” while the campaign is being processed by an internal job.
-
billingAuthStatus: String¶ The billing auth status of the campaign inside the AdRoll. Will default to empty string when API BillingAuthStatus not present. Result is “failed” when the billing authorization did not complete.
-
inVoltronStrategyEID: String!¶ The EID of this campaign as referenced from its Voltron strategy. Only available for inventory campaigns of Universal Campaigns.
-
proxyStrategyEID: String!¶ The eid of the Proxy Strategy that contains this campaign. Only for Inventory campaigns.
-
proxyStrategyStatus: String!¶ The status of the Proxy Strategy that contains this campaign. Only for Inventory campaigns.
-
proxyStrategyName: String!¶ The name of the Proxy Strategy that contains this campaign. Only for Inventory campaigns.
If this is an Email Newsletter campaign, the number of potential recipients.
If this is an Email Newsletter campaign, the number of emails sent.
If this is an Email Newsletter campaign, the scheduled date for delivery. Only if the delivery is scheduled to happen or of it has already occurred. Omitted if in draft, paused or cancelled.
-
isBillable: Boolean!¶ True if the campaign is run by NextRoll and will be directly billed to the advertisable’s account. False if it is run by a third party.
-
syncStatus: String!¶ Only for Connected Campaigns, indicates the status of the sync’ing with the external service. When available, can be one of “pending”, “synced” or “error”
-
syncError: String!¶ Only for Connected Campaigns, shows the error that caused the sync’ing with the external service to fail. Provided if the syncStatus field is “error”.
-
funnelStage: String¶ Funnel stage for the campaign. One of “awareness”, “consideration”, “conversion”, or “other”.
-
isBudgetBalancingAutomated: Boolean!¶ Indicates if this campaign is a strategy that balances the budget automatically across its inventory campaigns. False means that inventory campaign budgets are manually set.
-
performanceTargets: [PerformanceTarget]¶ PerformanceTargets
Internal tags set on creation.
-
automationNodeEID: String¶ If managed by an Automation, the EID of the Automation Node that references this entity.
-
-
CampaignMetricResult¶ Groups reporting metric data in summary and by date.
Fields:
-
byDate: [MetricForCampaign!]!¶ Reporting data by date in the given range.
-
-
CampaignQuery¶ Fields:
-
byEIDs(eids: [String!]!): [Campaign]!¶ Obtain a list of campaigns by their unique identifiers (EID).
Arguments:
-
byAdvertisable(advertisable: String!, isActive: Boolean, statuses: [String!], excludeStatuses: [String!], blacklistStatuses: [String!], useCases: [String!], types: [String!], targetingTypes: [String!], channels: [String!], sources: [String!], funnelStages: [String!], excludeUseCases: [String!], excludeTypes: [String!], excludeTargetingTypes: [String!], excludeChannels: [String!], excludeSources: [String!], excludeFunnelStages: [String!], tagPrefixes: [String!]): [Campaign]!¶ Obtain a list advertisables owned by an Advertisable.
Arguments:
-
isActive: Boolean¶ If True, only active campaigns will be returned, and vice versa (Optional; default: True)
-
statuses: [String!]¶ Only campaigns that match one of these statuses will be returned (Optional; default: None)
- Default
[ ]
-
excludeStatuses: [String!]¶ Only campaigns whose status is not one of these will be returned (Optional; default: None)
- Default
[ ]
-
useCases: [String!]¶ Only campaigns that match one of these use cases will be returned (Optional; default: None)
- Default
[ ]
-
types: [String!]¶ Only campaigns that match one of these types will be returned (Optional; default: None)
- Default
[ ]
-
targetingTypes: [String!]¶ Only campaigns that match one of these targeting types will be returned (Optional; default: None)
- Default
[ ]
-
channels: [String!]¶ Only campaigns that match one of these channels will be returned (Optional; default: None)
- Default
[ ]
-
sources: [String!]¶ Only campaigns that match one of these sources will be returned (Optional; default: None)
- Default
[ ]
-
funnelStages: [String!]¶ Only campaigns that match one of these funnel stages will be returned (Optional; default: None)
- Default
[ ]
-
excludeUseCases: [String!]¶ Exclude campaigns that match one of the given use cases (Optional; default: None)
- Default
[ ]
-
excludeTypes: [String!]¶ Exclude campaigns that match one of the given types. (Optional; default: None)
- Default
[ ]
-
excludeTargetingTypes: [String!]¶ Exclude campaigns that match one of the given targeting types. (Optional; default: None)
- Default
[ ]
-
excludeChannels: [String!]¶ Exclude campaigns that match one of the given channels. (Optional; default: None)
- Default
[ ]
-
excludeSources: [String!]¶ Exclude campaigns that match one of the given sources. (Optional; default: None)
- Default
[ ]
-
-
byOrganization(organization: String!, isActive: Boolean, statuses: [String!], excludeStatuses: [String!], blacklistStatuses: [String!], useCases: [String!], types: [String!], targetingTypes: [String!], channels: [String!], sources: [String!], excludeUseCases: [String!], excludeTypes: [String!], excludeTargetingTypes: [String!], excludeChannels: [String!], excludeSources: [String!], tagPrefixes: [String!]): [Campaign]!¶ Obtain a list advertisables owned by an Organization.
Arguments:
-
isActive: Boolean¶ If True, only active campaigns will be returned, and vice versa (Optional; default: True)
-
statuses: [String!]¶ Only campaigns that match one of these statuses will be returned (Optional; default: None)
- Default
[ ]
-
excludeStatuses: [String!]¶ Only campaigns whose status is not one of these will be returned (Optional; default: None)
- Default
[ ]
-
useCases: [String!]¶ Only campaigns that match one of these use cases will be returned (Optional; default: None)
- Default
[ ]
-
types: [String!]¶ Only campaigns that match one of these types will be returned (Optional; default: None)
- Default
[ ]
-
targetingTypes: [String!]¶ Only campaigns that match one of these targeting types will be returned (Optional; default: None)
- Default
[ ]
-
channels: [String!]¶ Only campaigns that match one of these channels will be returned (Optional; default: None)
- Default
[ ]
-
sources: [String!]¶ Only campaigns that match one of these sources will be returned (Optional; default: None)
- Default
[ ]
-
excludeUseCases: [String!]¶ Exclude campaigns that match one of the given use cases (Optional; default: None)
- Default
[ ]
-
excludeTypes: [String!]¶ Exclude campaigns that match one of the given types. (Optional; default: None)
- Default
[ ]
-
excludeTargetingTypes: [String!]¶ Exclude campaigns that match one of the given targeting types. (Optional; default: None)
- Default
[ ]
-
excludeChannels: [String!]¶ Exclude campaigns that match one of the given channels. (Optional; default: None)
- Default
[ ]
-
-
metricsTotal: MetricAggregateResult¶ Provides aggregation for any metrics in the current and child nodes.
Note that this will not load the metrics by itself, instead it aggregates loaded metrics fields in its scope.
For details see the documentation of MetricAggregateResult.
-
-
ConversionResult¶ Groups reporting metric data for conversions.
Fields:
-
byAudience(isActive: Boolean): [Conversions!]!¶ Summarizes by conversion the reporting data for the given date range.
Arguments:
-
-
Conversions¶ Contains reporting metric data for attributions, deliveries
by audience conversion.
Fields:
-
summary: ConversionsSummary!¶ Summarizes the reporting data for the given date range.
-
byDate: [ConversionsByDate!]!¶ Reporting data by date in the given range.
-
clickThroughs: Decimal¶ Click-through conversion (CTC). A goal completion that happens after someone clicks your ad.
-
viewThroughs: Decimal¶ View-through conversion (VTC). A goal completion that happens after someone views your ad, but does not click.
-
clickRevenue: Decimal¶ Click-Attributed Revenue. Total earnings when someone clicks your ad and converts.
-
viewRevenue: Decimal¶ View-Attributed Revenue. Total earnings when someone views your ad and converts.
-
ctr: Decimal¶ Click-through rate. The percentage of ad serves that were clicked.
CTR (%) = Clicks / Impression * 100
-
cpa: Decimal¶ Cost per acquisition. Your average spend per conversion.
CPA ($) = Spend / Conversions
-
clickCPA: Decimal¶ Cost-per-click acquisition. Your average spend for a conversion that happens after someone clicks your ad.
Click CPA ($) = Spend / Click Conversions
-
viewCPA: Decimal¶ Cost-per-view acquisition: Your average spend for a conversion that happens after someone views your ad.
View CPA ($) = Cost / View Throughs
-
averageOrderValue: Decimal¶ Average Order Value Average revenue per attributed conversion.
Average Order Value ($) = Attributed Revenue / Conversions
-
ctcRate: Decimal¶ Click-through conversion rate. The percentage of clicks that resulted in a click-through conversion.
CTC Rate (%) = Click Conversions / Clicks * 100
-
vtcRate: Decimal¶ View-through conversion rate: The percentage of impressions that resulted in a view-through conversion.
VTC Rate (%) = View Throughs / Impressions * 100
-
roas: Decimal¶ Return on advertising spend: Your profit per dollar spent on ads.
ROAS (x) = (Click Revenue + View Revenue) / Cost
-
clickROAS: Decimal¶ Click return on advertising spend: Your profit per dollar spent, generated from conversions that happen after someone clicks your ad.
Click ROAS (x) = Click Revenue / Cost
-
viewROAS: Decimal¶ View return on advertising spend: Your profit per dollar spent, generated from conversions that happen after someone views your ad.
View ROAS (x) = View Revenue / Cost
-
-
ConversionsByDate¶ Fields:
-
clickThroughs: Decimal¶ Click-through conversion (CTC). A goal completion that happens after someone clicks your ad.
-
viewThroughs: Decimal¶ View-through conversion (VTC). A goal completion that happens after someone views your ad, but does not click.
-
clickRevenue: Decimal¶ Click-Attributed Revenue. Total earnings when someone clicks your ad and converts.
-
viewRevenue: Decimal¶ View-Attributed Revenue. Total earnings when someone views your ad and converts.
-
ctr: Decimal¶ Click-through rate. The percentage of ad serves that were clicked.
CTR (%) = Clicks / Impression * 100
-
cpa: Decimal¶ Cost per acquisition. Your average spend per conversion.
CPA ($) = Spend / Conversions
-
clickCPA: Decimal¶ Cost-per-click acquisition. Your average spend for a conversion that happens after someone clicks your ad.
Click CPA ($) = Spend / Click Conversions
-
viewCPA: Decimal¶ Cost-per-view acquisition: Your average spend for a conversion that happens after someone views your ad.
View CPA ($) = Cost / View Throughs
-
averageOrderValue: Decimal¶ Average Order Value Average revenue per attributed conversion.
Average Order Value ($) = Attributed Revenue / Conversions
-
ctcRate: Decimal¶ Click-through conversion rate. The percentage of clicks that resulted in a click-through conversion.
CTC Rate (%) = Click Conversions / Clicks * 100
-
vtcRate: Decimal¶ View-through conversion rate: The percentage of impressions that resulted in a view-through conversion.
VTC Rate (%) = View Throughs / Impressions * 100
-
roas: Decimal¶ Return on advertising spend: Your profit per dollar spent on ads.
ROAS (x) = (Click Revenue + View Revenue) / Cost
-
clickROAS: Decimal¶ Click return on advertising spend: Your profit per dollar spent, generated from conversions that happen after someone clicks your ad.
Click ROAS (x) = Click Revenue / Cost
-
viewROAS: Decimal¶ View return on advertising spend: Your profit per dollar spent, generated from conversions that happen after someone views your ad.
View ROAS (x) = View Revenue / Cost
-
-
ConversionsSummary¶ Fields:
-
clickThroughs: Decimal¶ Click-through conversion (CTC). A goal completion that happens after someone clicks your ad.
-
viewThroughs: Decimal¶ View-through conversion (VTC). A goal completion that happens after someone views your ad, but does not click.
-
clickRevenue: Decimal¶ Click-Attributed Revenue. Total earnings when someone clicks your ad and converts.
-
viewRevenue: Decimal¶ View-Attributed Revenue. Total earnings when someone views your ad and converts.
-
ctr: Decimal¶ Click-through rate. The percentage of ad serves that were clicked.
CTR (%) = Clicks / Impression * 100
-
cpa: Decimal¶ Cost per acquisition. Your average spend per conversion.
CPA ($) = Spend / Conversions
-
clickCPA: Decimal¶ Cost-per-click acquisition. Your average spend for a conversion that happens after someone clicks your ad.
Click CPA ($) = Spend / Click Conversions
-
viewCPA: Decimal¶ Cost-per-view acquisition: Your average spend for a conversion that happens after someone views your ad.
View CPA ($) = Cost / View Throughs
-
averageOrderValue: Decimal¶ Average Order Value Average revenue per attributed conversion.
Average Order Value ($) = Attributed Revenue / Conversions
-
ctcRate: Decimal¶ Click-through conversion rate. The percentage of clicks that resulted in a click-through conversion.
CTC Rate (%) = Click Conversions / Clicks * 100
-
vtcRate: Decimal¶ View-through conversion rate: The percentage of impressions that resulted in a view-through conversion.
VTC Rate (%) = View Throughs / Impressions * 100
-
roas: Decimal¶ Return on advertising spend: Your profit per dollar spent on ads.
ROAS (x) = (Click Revenue + View Revenue) / Cost
-
clickROAS: Decimal¶ Click return on advertising spend: Your profit per dollar spent, generated from conversions that happen after someone clicks your ad.
Click ROAS (x) = Click Revenue / Cost
-
viewROAS: Decimal¶ View return on advertising spend: Your profit per dollar spent, generated from conversions that happen after someone views your ad.
View ROAS (x) = View Revenue / Cost
-
-
Email¶ Fields:
-
sequencePosition: Int!¶ The position of this email in the campaign’s sequence. (0 for the first email).
-
actualStatus: JSON¶ The effective status of the campaign. Details the reasons why it is not running, if applicable.
-
actualStatusString: String!¶ Minimal string representation of the actual status. One of ‘running’, ‘notRunning’ ,’ended’, ‘paused’, ‘draft’ or ‘deleted’.
-
delayHours: Float!¶ Delay in hours between the previous event in the drip sequence and when this email is scheduled to be sent.
-
advertisable: String!¶ Advertisable for this Email.
[WARNING] The advertisable information is not usually available, so querying this will cause an additional request to be made.
-
metrics(start: Date, end: Date, pastDays: Int, currency: String, duration: Int): MetricResult!¶ Metrics for the entity.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
metricsTotal: MetricAggregateResult¶ Provides aggregation for any metrics in the current and child nodes.
Note that this will not load the metrics by itself, instead it aggregates loaded metrics fields in its scope.
For details see the documentation of MetricAggregateResult.
-
-
EmailGroupData¶ Fields:
-
sequencePosition: Int!¶ The position of this email in the campaign’s sequence. (0 for the first email).
-
actualStatus: JSON¶ The effective status of the campaign. Details the reasons why it is not running, if applicable.
-
actualStatusString: String!¶ Minimal string representation of the actual status. One of ‘running’, ‘notRunning’ ,’ended’, ‘paused’, ‘draft’ or ‘deleted’.
-
-
EmailQuery¶ Fields:
-
byAdvertisable(advertisable: String!): [Email]!¶ Resolves all Emails for an Advertisable.
Arguments:
-
metricsTotal: MetricAggregateResult¶ Provides aggregation for any metrics in the current and child nodes.
Note that this will not load the metrics by itself, instead it aggregates loaded metrics fields in its scope.
For details see the documentation of MetricAggregateResult.
-
-
FieldAccountMetrics¶ Fields:
-
adjustedViewThroughs: Decimal¶ A goal completion that happens after someone views your ad, but does not click.
-
pageViews: Decimal¶ The number of page views on your site from cookie attached to the domain (at the advertisable level, not campaigns level)
-
engagedVisitors: Decimal¶ The number of unique engaged visitors to your site from cookie attached to the domain (at the advertisable level, not campaigns level)
-
-
FieldAccountMetricsSummary¶ Fields:
-
FieldConversions¶ Fields:
-
conversions(start: Date, end: Date, pastDays: Int, currency: String): ConversionResult!¶ Metrics for the entity broken down by conversion audiences.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
-
FieldGranularConversions¶ Fields:
-
granularConversions(start: Date, end: Date, pastDays: Int, currency: String): [GranularConversion!]!¶ The granular conversions help understand the channels, campaigns, and ads that influence conversions. Lists the details about a conversion and the data points that determined the decision about its attribution. Limited to 90 days.
Arguments:
-
start: Date¶ The start date for the conversions period (inclusive). The date range will be: [start, end)
-
end: Date¶ The end date for the conversions period (exclusive). The date range will be: [start, end)
-
-
-
FieldMetrics¶ Fields:
-
metrics(start: Date, end: Date, pastDays: Int, currency: String, duration: Int): MetricResult!¶ Metrics for the entity.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
-
FieldMetricsForAdvertisable¶ Fields:
-
metrics(start: Date, end: Date, pastDays: Int, currency: String, duration: Int): AdvertisableMetricResult!¶ Metrics for the Advertisable.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
-
FieldMetricsForCampaign¶ Fields:
-
metrics(start: Date, end: Date, pastDays: Int, currency: String, duration: Int): CampaignMetricResult!¶ Metrics for the Campaign.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
-
FieldMetricsTotal¶ Fields:
-
metricsTotal: MetricAggregateResult¶ Provides aggregation for any metrics in the current and child nodes.
Note that this will not load the metrics by itself, instead it aggregates loaded metrics fields in its scope.
For details see the documentation of MetricAggregateResult.
-
-
FieldUtmBasedConversionsForAdvertisable¶ Fields:
-
utmBasedConversions(start: Date, end: Date, pastDays: Int, currency: String, model: String!): [UtmBasedConversionsForAdvertisable!]!¶ UTM based conversions for the Advertisable.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
-
FieldsARAAttributionMetrics¶ Fields:
-
araViewThroughs: Decimal¶ A goal completion that happens after someone views your ad, but does not click. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araClickThroughs: Decimal¶ A goal completion that happens after someone clicks your ad. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araViewThroughsVariance: Decimal¶ Variance of the view-through conversions. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araClickThroughsVariance: Decimal¶ Variance of the click-through conversions. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araViewRevenueMin: Decimal¶ Lower bound on total earnings when someone views your ad and converts. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araViewRevenueMax: Decimal¶ Upper bound on total earnings when someone views your ad and converts. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
-
FieldsAd¶ Fields:
-
hasFutureCampaigns: Boolean!¶ Whether or not this ad has the possibility of serving based on the adgroups and campaigns in which it inhabits.
DEPRECATED: this field will stop being supported in the near future.
-
status: String!¶ One of ‘running’, ‘paused’, ‘review’, ‘draft’, ‘rejected’, ‘suspended’ or ‘deleted’.
-
actualStatus: JSON¶ The effective status of the campaign. Details the reasons why it is not running, if applicable.
-
actualStatusString: String!¶ Minimal string representation of the actual status. One of ‘running’, ‘notRunning’ ,’ended’, ‘paused’, ‘review’, ‘draft’, ‘rejected’ or ‘deleted’.
-
hasEdits: Boolean!¶ Whether or not this ad has been edited such that another ad has it’s original ad parameter set to this ad’s EID.
-
hasPendingEdits: Boolean!¶ Whether or not this ad has edits that must be reviewed by an AdRoll administrator.
-
isDynamic: Boolean!¶ Whether or not this is an ad that is dynamically composed when it is served to the user.
-
isOutlined: Boolean!¶ Whether or not an outline has been applied to the ad to satisfy network compliancy.
-
validClicktag: Boolean!¶ If the ad is in flash format, this is the flag showing whether or not the clickTAG is compliant.
-
syncStatus: String!¶ Only for Connected Campaigns’ ads, indicates the status of the sync’ing with the external service. When available, can be one of “pending”, “synced” or “error”
-
syncError: String!¶ Only for Connected Campaigns’ ads, shows the error that caused the sync’ing with the external service to fail. Provided if the syncStatus field is “error”.
-
remoteStatus: String!¶ The status of the Ad on the inventory network NextRoll has sync’ed it to (ex: Facebook)
-
disapprovalReason: String!¶ The reason why an Ad has been rejected on the inventory network NextRoll has sync’ed it to (ex: Facebook)
-
channel: String!¶ The channel for the campaign this ad belongs to. This is only available when loading the ads through a campaign.
-
campaignType: String!¶ The type for the campaign this ad belongs to. This is only available when loading the ads through a campaign.
-
inAdgroupEID: String!¶ The AdGroup’s EID in the AdGroupAd relationship, if listed inside an AdGroup.
-
-
FieldsAdMetrics¶ Fields:
-
clickThroughs: Decimal¶ Click-through conversion (CTC). A goal completion that happens after someone clicks your ad.
-
viewThroughs: Decimal¶ View-through conversion (VTC). A goal completion that happens after someone views your ad, but does not click.
-
clickRevenue: Decimal¶ Click-Attributed Revenue. Total earnings when someone clicks your ad and converts.
-
viewRevenue: Decimal¶ View-Attributed Revenue. Total earnings when someone views your ad and converts.
-
ctr: Decimal¶ Click-through rate. The percentage of ad serves that were clicked.
CTR (%) = Clicks / Impression * 100
-
cpa: Decimal¶ Cost per acquisition. Your average spend per conversion.
CPA ($) = Spend / Conversions
-
clickCPA: Decimal¶ Cost-per-click acquisition. Your average spend for a conversion that happens after someone clicks your ad.
Click CPA ($) = Spend / Click Conversions
-
viewCPA: Decimal¶ Cost-per-view acquisition: Your average spend for a conversion that happens after someone views your ad.
View CPA ($) = Cost / View Throughs
-
averageOrderValue: Decimal¶ Average Order Value Average revenue per attributed conversion.
Average Order Value ($) = Attributed Revenue / Conversions
-
ctcRate: Decimal¶ Click-through conversion rate. The percentage of clicks that resulted in a click-through conversion.
CTC Rate (%) = Click Conversions / Clicks * 100
-
vtcRate: Decimal¶ View-through conversion rate: The percentage of impressions that resulted in a view-through conversion.
VTC Rate (%) = View Throughs / Impressions * 100
-
roas: Decimal¶ Return on advertising spend: Your profit per dollar spent on ads.
ROAS (x) = (Click Revenue + View Revenue) / Cost
-
clickROAS: Decimal¶ Click return on advertising spend: Your profit per dollar spent, generated from conversions that happen after someone clicks your ad.
Click ROAS (x) = Click Revenue / Cost
-
-
FieldsAdgroup¶ Fields:
-
actualStatus: JSON¶ The effective status of the adgroup. Details the reasons why it is not running, if applicable.
-
actualStatusString: String!¶ Minimal string representation of the actual status. One of ‘running’, ‘notRunning’ ,’ended’, ‘paused’, ‘review’, ‘draft’, ‘rejected’ or ‘deleted’.
-
processingStatus: String!¶ The processing status of the campaign inside the AdRoll. It may have a transient value other than “created” while the AdGroup is being processed by an internal job.
-
significantFlightStartDate: DateTime¶ Start date for the active or most recent flight period in the adgroup.
-
significantFlightEndDate: DateTime¶ End date for the active or most recent flight period in the adgroup.
-
advertisable: String!¶ Advertisable for this Adgroup. NOTE/FIXME: the advertisable information is not usually available, so querying this will cause an additional request to be made.
-
kpiGoal: Decimal¶ Goal -for the kpiMetric- that drives the campaign’s bid strategy. Null for automatic.
-
kpiCurrency: String!¶ ISO 4217 currency code for kpiGoal. If not provided assume the currency provided at the Advertisable level.
-
adType: String!¶ Ad type restriction for this adgroup. Empty if there is no explicit restriction. Currently one of “static”or “dynamic.
-
-
FieldsAdvertisable¶ Fields:
-
isB2B: Boolean!¶ Whether or not the advertisable is a B2B customer. Deprecated field: use businessUnit instead.
-
status: String!¶ The status of the advertisable. One of [‘admin_review’, ‘approved’, ‘rejected’, ‘suspended’].
-
clickThroughConversionWindow: Int!¶ Duration of this advertisable’s click through conversion window in days.
-
viewThroughConversionWindow: Int!¶ Duration of this advertisable’s view through conversion window in days.
-
-
FieldsAudience¶ Fields:
-
type: String!¶ The type of the segment. One of: - “url”: URL - “crm”: crm - “pages_viewed”: Pages Viewed - “products_viewed”: Products Viewed - “arbitrary_data”: External Data - “app_install”: App Install - “facebook_prospecting”: Facebook Prospecting - “custom”: Partner - “intent”: Intent - “impression”: Impression - “user_attributes”: Attributes - “user_events”: Events - “lead_generation”: Lead Generation - “composite”: Composite - “event_match”: Event JS Match - “js_match”: Explicit JS Match - “ipixel_match”: IPixel Match - “css_selector”: CSS Selector - “email_list”: Email List in AdRoll Email. - “email_domain”: Email Address Domain Match.
Tags explicitly assigned to the segment.
-
-
FieldsBrandAwarenessForAdvertisables¶ Fields:
-
siteBounceRate: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteNewVisitors: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteNewVisitorsNot: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteEngaged: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteEngagedNot: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteEngagedNewVisitors: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteEngagedNewVisitorsNot: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteAddToCart: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteAddToCartNot: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteConverters: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteConvertersNot: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
-
FieldsBrandAwarenessForCampaigns¶ Fields:
-
siteBounceRate: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteNewVisitors: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteEngaged: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
-
FieldsCampaign¶ Fields:
-
budget: Decimal!¶ The daily budget of the campaign. Note that this can be an approximation, for example when budgetType = “lifetime” it is: budget = budgetGoal / numberOfDays(budgetStartDate, budgetEndDate)
-
budgetGoal: Decimal!¶ The budget of the campaign, considered for the whole extent of its budgetType. When budgetType = “lifetime”, it will be applied in the period since budgetStartDate until budgetEndDate.
-
budgetType: String!¶ The type of budget of the campaign (daily, lifetime…). If this includes -auto (i.e. daily-auto), then it is the inventory campaign of a proxy strategy that is auto-balancing the budget for this campaign
-
budgetSettingsString: String!¶ Serialized budget settings as a string. “budgetType,budgetStartDate,budgetEndDate,budgetGoal”
-
status: String!¶ The status of the campaign. One of ‘running’, ‘ended’, ‘paused’, ‘review’, ‘draft’, ‘rejected’ or ‘deleted’. Result is ‘billingFailedPermanent’ or ‘billingFailedRecoverable’ when BillingAuthStatus is ‘failed’.
-
actualStatus: JSON¶ The effective status of the campaign. Details the reasons why it is not running, if applicable.
-
actualStatusString: String!¶ Minimal string representation of the actual status. One of ‘running’, ‘notRunning’ ,’ended’, ‘paused’, ‘review’, ‘draft’, ‘rejected’ or ‘deleted’.
-
targetingType: String!¶ The type of targeting that is used to pick which customers will be reached by this campaign.
-
kpiGoal: Decimal!¶ Goal -for the kpiMetric- that drives the campaign’s bid strategy. Null for automatic.
-
kpiCurrency: String!¶ ISO 4217 currency code for kpiGoal. If not provided assume the currency provided at the Advertisable level.
-
processingStatus: String!¶ The processing status of the campaign inside the AdRoll. It may have a transient value other than “created” while the campaign is being processed by an internal job.
-
billingAuthStatus: String¶ The billing auth status of the campaign inside the AdRoll. Will default to empty string when API BillingAuthStatus not present. Result is “failed” when the billing authorization did not complete.
-
inVoltronStrategyEID: String!¶ The EID of this campaign as referenced from its Voltron strategy. Only available for inventory campaigns of Universal Campaigns.
-
proxyStrategyEID: String!¶ The eid of the Proxy Strategy that contains this campaign. Only for Inventory campaigns.
-
proxyStrategyStatus: String!¶ The status of the Proxy Strategy that contains this campaign. Only for Inventory campaigns.
-
proxyStrategyName: String!¶ The name of the Proxy Strategy that contains this campaign. Only for Inventory campaigns.
If this is an Email Newsletter campaign, the number of potential recipients.
If this is an Email Newsletter campaign, the number of emails sent.
If this is an Email Newsletter campaign, the scheduled date for delivery. Only if the delivery is scheduled to happen or of it has already occurred. Omitted if in draft, paused or cancelled.
-
isBillable: Boolean!¶ True if the campaign is run by NextRoll and will be directly billed to the advertisable’s account. False if it is run by a third party.
-
syncStatus: String!¶ Only for Connected Campaigns, indicates the status of the sync’ing with the external service. When available, can be one of “pending”, “synced” or “error”
-
syncError: String!¶ Only for Connected Campaigns, shows the error that caused the sync’ing with the external service to fail. Provided if the syncStatus field is “error”.
-
funnelStage: String¶ Funnel stage for the campaign. One of “awareness”, “consideration”, “conversion”, or “other”.
-
isBudgetBalancingAutomated: Boolean!¶ Indicates if this campaign is a strategy that balances the budget automatically across its inventory campaigns. False means that inventory campaign budgets are manually set.
-
performanceTargets: [PerformanceTarget]¶ PerformanceTargets
Internal tags set on creation.
-
automationNodeEID: String¶ If managed by an Automation, the EID of the Automation Node that references this entity.
-
-
FieldsCustomMetrics¶ Fields:
-
customMetric(formula: String): Decimal!¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Usage: - Operators: ‘+’, ‘-‘, ‘*’, ‘/’ and parentheses () are valid Requires formula to have space-seperated operand and operators.
e.g. costPerImpression: customMetric(formula: “cost / impressions”)
Arguments:
-
-
FieldsEmail¶ Fields:
-
sequencePosition: Int!¶ The position of this email in the campaign’s sequence. (0 for the first email).
-
actualStatus: JSON¶ The effective status of the campaign. Details the reasons why it is not running, if applicable.
-
actualStatusString: String!¶ Minimal string representation of the actual status. One of ‘running’, ‘notRunning’ ,’ended’, ‘paused’, ‘draft’ or ‘deleted’.
-
-
FieldsEmailMetrics¶ Fields:
-
opens: Decimal¶ Number of unique-by-session email opens collected for a campaign.
WARNING: this field is deprecated, please use “emailUniqueOpen” instead. To ease up the transition this field will still be available, but always return null.
-
openRate: Decimal¶ WARNING: this field is deprecated, please use “emailUniqueOpenRate”. To ease up the transition this field will still be available, but always return null.
-
emailSentConfirmed: Decimal!¶ Total emails confirmed to have been sent by the Email Service Provider.
-
emailDeliveryRate: Decimal!¶ The percent of emails that have been confirmed to be delivered, over the send attempts.
-
emailUniqueOpenRate: Decimal!¶ The percent of sent emails that are opened once in a user’s lifetime.
-
emailUniqueClick: Decimal!¶ The number of times a link in an email was clicked once in a user’s lifetime.
-
emailUniqueClickRate: Decimal!¶ The percentage of emails opened that were clicked once in a user’s lifetime.
-
emailUniqueUnsubscribeRate: Decimal!¶ The percent of recipients that have unsubscribers (unique) over the number of confirmed to be deliveries.
-
emailUniqueClicksByCountry: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times an email was clicked once in a user’s lifetime broken out by ISO-2 country code
-
emailUniqueOpensByCountry: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times an email is opened by a user in its lifetime, broken out by ISO-2 country code
-
emailUniqueClicksByDeviceType: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times a link in an email was clicked once in a user’s lifetime, broken out by device type One of ‘pc’, ‘mobile’, ‘tablet’, ‘other’.
-
emailUniqueOpensByDeviceType: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times an email is opened by a user in its lifetime, broken out by device type One of ‘pc’, ‘mobile’, ‘tablet’, ‘other’.
-
emailUniqueClicksByXpathUrl: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Unique clicks by xpath;url present in an email message The key <xpath>;<url or macro> consists in 2 parts: 1. A XPath locator to the individual element that was clicked in the email message, based on a HTML5-compliant tree. 2. URL or macro: either a static URL that was clicked present in the email template or, the macro used to generate the URL. Eg.: {{product.url}}. Useful to identify links generated for the same intent, but it might show differently for emailed contacts.
In the future we may break this out to seperate metrics
-
-
FieldsForUtmBasedConversions¶ Fields:
-
FieldsInfluencedAttributionMetrics¶ Fields:
-
FieldsOrganization¶ Fields:
-
FieldsProspectingMetrics¶ Fields:
-
newVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyNewVisitors instead.
The number of unique new visitors who came to your site after viewing a prospecting ad.
-
engagedVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyEngagedVisitors instead.
The number of unique new visitors who have viewed at least 3 pages on your site after viewing a prospecting ad.
-
bouncedVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL.
Visitors who have only viewed one page and left your site after viewing a prospecting ad.
-
nonBouncedVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL.
Visitors who have only viewed more than one page after viewing a prospecting ad.
-
newVisitorCost: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyNewVisitorCost instead.
The cost for each unique new visitor that came to your site after viewing a prospecting ad.
New Visitor Cost = cost / newVisitors
-
engagedVisitorCost: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyEngagedVisitorCost instead.
The cost for each unique new visitor that has viewed at least 3 pages on your site after viewing a prospecting ad
Engaged Visitor Cost = cost / engagedVisitors
-
bounceRate: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL.
The percentage of new visitors who have only viewed one page and left your site after viewing a prospecting ad.
Bounce Rate (%) = bouncedVisitors / newVisitors * 100.
-
dailyNewVisitors: Decimal¶ The number of daily new visitors who came to your site after viewing a prospecting ad.
-
dailyReturnVisitors: Decimal¶ The number of daily new visitors who return to your site after viewing a prospecting ad.
-
dailyEngagedVisitors: Decimal¶ The number of daily new visitors who have viewed at least 3 pages on your site after viewing a prospecting ad.
-
dailyBounceRate: Decimal¶ The percentage of daily new visitors who have only viewed one page and left your site after viewing a prospecting ad.
-
-
FieldsReachFrequencyMetrics¶ Fields:
-
convCountImpRate01: Decimal!¶ Number of converters who saw an average of 0-1 ads/day in the last 30 days.
-
convCountImpRate12: Decimal!¶ Number of converters who saw an average of 1-2 ads/day in the last 30 days.
-
convCountImpRate23: Decimal!¶ Number of converters who saw an average of 2-3 ads/day in the last 30 days.
-
convCountImpRate34: Decimal!¶ Number of converters who saw an average of 3-4 ads/day in the last 30 days.
-
convCountImpRate4: Decimal!¶ Number of converters who saw an average of 4+ ads/day in the last 30 days.
-
nonConvCountImpRate01: Decimal!¶ Number of non-converters who saw an average of 0-1 ads/day in the last 30 days.
-
nonConvCountImpRate12: Decimal!¶ Number of non-converters who saw an average of 1-2 ads/day in the last 30 days.
-
nonConvCountImpRate23: Decimal!¶ Number of non-converters who saw an average of 2-3 ads/day in the last 30 days.
-
-
FieldsReachMetrics¶ Fields:
-
FieldsSMSMessage¶ Fields:
-
sequencePosition: Int!¶ The position of this SMS Message in the campaign’s sequence. (0 for the first message).
-
actualStatus: JSON¶ The effective status of the campaign. Details the reasons why it is not running, if applicable.
-
-
FieldsSMSMetrics¶ Fields:
-
smsSentUnconfirmed: Decimal!¶ Total number of SMS messages that were sent, but still unconfirmed on their delivery.
-
smsSentDelivered: Decimal!¶ Total number of SMS messages that were delivered (and confirmed by the recipient)
-
smsSentUndelivered: Decimal!¶ Total number of SMS messages that were marked as undelivered. This can happen for many reasons including carrier content filtering and the availability of the destination handset.
-
-
FieldsSegment¶ Fields:
Tags explicitly assigned to the segment.
-
FieldsVideoMetrics¶ Fields:
-
GranularConversion¶ A row describing a granular conversion.
Fields:
-
type: String!¶ There are two types of conversions: “Click through” (CTC), “View through” (VTC) or “Influenced”.
-
touchpointTimestamp: DateTime¶ The last preceding AdRoll touchpoint, such as an impression or click.
-
attributedConversions: Decimal!¶ The number of conversions attributed to your AdRoll ads based on your selected attribution model. If the impression or click is attributed the conversion, the value will be 1. If the impression or click influenced the conversion, the value will be 0.
-
attributedRevenue: Decimal!¶ Revenue for the attributed conversions (only populates if you either specify a fixed conversion value or have [enhanced conversion tracking](https://help.adroll.com/hc/en-us/articles/212629938) set up).
-
country: String!¶ If available (provided by the network, unavailable on Facebook): the country where the conversion happened.
-
city: String!¶ If available (provided by the network, unavailable on Facebook): the city where the conversion happened.
The AdRoll cookie that was used to track this conversion’s journey. This field is for internal use only, it will always return an empty string for external users.
-
-
GroupListRow¶ [BETA] This GraphQL node is currently under development.
Avoid its use in production until it has passed some thorough QA.
Row returned for each row in a group by query from
‘group.loadByList’.
The available data depends on the arguments to the group by:
Entity data is only available when grouping by entity and
only for the entity being grouped by.
Date is only available when grouping by date.
Only columns specified in the group by are available for a
particular group.
Groups are returned as a flat list but should be interpret as a
hierarchy:
There is always one ‘root’ group that has no entity data. The
metrics in this root group are the total aggregate.
Children groups have a ‘parentId’ field that is the ‘id’ of
their parent (e.g. children of the root group will have a
parentId of ‘root’).
The final level of groups in the query have the ‘leaf’ field
as true. This is made for easy filtering when only the leaf
nodes are required.
Each group in the ‘groups’ parameter for the query creates
a level of sub-groups in order. So the first group parameter
will correspond to children of the ‘root’ group, while the
last group parameter will correspond to the ‘leaf’ groups.
Fields:
-
leaf: Boolean!¶ Leaf is true for the leaf groups (groups with no children). This corresponds to the last ‘groups’ parameter in the GroupBy.
-
date: String!¶ When grouping by date, this is the metric date for this group. The format depends on the ‘date’ argument of the GroupBy:
day: “2018-12-30”
week: “2018-W52”
month: “2018-12”
year: “2018”
dayofweek: “sun”
-
dateKey: String!¶ This is a sortable value for the ‘date’ argument. It is equal to ‘date’ except for when using ‘dayofweek’ when it is the number corresponding to the week day order.
-
columns: JSON!¶ When grouping by columns, this will return a JSON object whose keys are the group column names (as specified in the GroupBy argument) and the values are the column values for the current group.
-
organization: OrganizationGroupData¶ Organization data for the group. This is only available when grouping by organizations (e.g. ‘entity’ = ‘organization’).
-
advertisable: AdvertisableGroupData¶ Advertisable data for the group. This is only available when grouping by advertisables (e.g. ‘entity’ = ‘advertisable’).
-
campaign: CampaignGroupData¶ Campaign data for the group. This is only available when grouping by campaigns (e.g. ‘entity’ = ‘campaign’).
-
adgroup: AdgroupGroupData¶ Adgroup data for the group. This is only available when grouping by adgroups (e.g. ‘entity’ = ‘adgroup’).
-
ad: AdGroupData¶ Ad data for the group. This is only available when grouping by ads (e.g. ‘entity’ = ‘ad’).
-
segment: SegmentGroupData¶ Segment data for the group. This is only available when grouping by segments (e.g. ‘entity’ = ‘segment’).
-
email: EmailGroupData¶ Email data for the group. This is only available when grouping by emails (e.g. ‘entity’ = ‘email’).
-
smsMessage: SMSMessageGroupData¶ SMS data for the group. This is only available when grouping by sms messages (e.g. ‘entity’ = ‘smsMessage’).
-
audience: AudienceGroupData¶ Audience data for the group. This is only available when grouping by audiences (e.g. ‘entity’ = ‘audience’).
-
clickThroughs: Decimal¶ Click-through conversion (CTC). A goal completion that happens after someone clicks your ad.
-
viewThroughs: Decimal¶ View-through conversion (VTC). A goal completion that happens after someone views your ad, but does not click.
-
clickRevenue: Decimal¶ Click-Attributed Revenue. Total earnings when someone clicks your ad and converts.
-
viewRevenue: Decimal¶ View-Attributed Revenue. Total earnings when someone views your ad and converts.
-
ctr: Decimal¶ Click-through rate. The percentage of ad serves that were clicked.
CTR (%) = Clicks / Impression * 100
-
cpa: Decimal¶ Cost per acquisition. Your average spend per conversion.
CPA ($) = Spend / Conversions
-
clickCPA: Decimal¶ Cost-per-click acquisition. Your average spend for a conversion that happens after someone clicks your ad.
Click CPA ($) = Spend / Click Conversions
-
viewCPA: Decimal¶ Cost-per-view acquisition: Your average spend for a conversion that happens after someone views your ad.
View CPA ($) = Cost / View Throughs
-
averageOrderValue: Decimal¶ Average Order Value Average revenue per attributed conversion.
Average Order Value ($) = Attributed Revenue / Conversions
-
ctcRate: Decimal¶ Click-through conversion rate. The percentage of clicks that resulted in a click-through conversion.
CTC Rate (%) = Click Conversions / Clicks * 100
-
vtcRate: Decimal¶ View-through conversion rate: The percentage of impressions that resulted in a view-through conversion.
VTC Rate (%) = View Throughs / Impressions * 100
-
roas: Decimal¶ Return on advertising spend: Your profit per dollar spent on ads.
ROAS (x) = (Click Revenue + View Revenue) / Cost
-
clickROAS: Decimal¶ Click return on advertising spend: Your profit per dollar spent, generated from conversions that happen after someone clicks your ad.
Click ROAS (x) = Click Revenue / Cost
-
viewROAS: Decimal¶ View return on advertising spend: Your profit per dollar spent, generated from conversions that happen after someone views your ad.
View ROAS (x) = View Revenue / Cost
-
influencedThroughs: Decimal¶ Influenced Conversions.
A conversion touched or assisted by an ad but not attributed due to the current attribution model.
-
influencedRevenue: Decimal¶ Influenced Revenue.
Revenue touched or assisted by an ad but not attributed due to the current attribution model.
-
newVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyNewVisitors instead.
The number of unique new visitors who came to your site after viewing a prospecting ad.
-
engagedVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyEngagedVisitors instead.
The number of unique new visitors who have viewed at least 3 pages on your site after viewing a prospecting ad.
-
bouncedVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL.
Visitors who have only viewed one page and left your site after viewing a prospecting ad.
-
nonBouncedVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL.
Visitors who have only viewed more than one page after viewing a prospecting ad.
-
newVisitorCost: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyNewVisitorCost instead.
The cost for each unique new visitor that came to your site after viewing a prospecting ad.
New Visitor Cost = cost / newVisitors
-
engagedVisitorCost: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyEngagedVisitorCost instead.
The cost for each unique new visitor that has viewed at least 3 pages on your site after viewing a prospecting ad
Engaged Visitor Cost = cost / engagedVisitors
-
bounceRate: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL.
The percentage of new visitors who have only viewed one page and left your site after viewing a prospecting ad.
Bounce Rate (%) = bouncedVisitors / newVisitors * 100.
-
dailyNewVisitors: Decimal¶ The number of daily new visitors who came to your site after viewing a prospecting ad.
-
dailyReturnVisitors: Decimal¶ The number of daily new visitors who return to your site after viewing a prospecting ad.
-
dailyEngagedVisitors: Decimal¶ The number of daily new visitors who have viewed at least 3 pages on your site after viewing a prospecting ad.
-
dailyBounceRate: Decimal¶ The percentage of daily new visitors who have only viewed one page and left your site after viewing a prospecting ad.
-
dailyNewVisitorCost: Decimal¶ The cost for each daily new visitor that came to your site after viewing a prospecting ad.
New Visitor Cost = cost / dailyNewVisitors
-
dailyEngagedVisitorCost: Decimal¶ The cost for each daily new visitor that has viewed at least 3 pages on your site after viewing a prospecting ad
Engaged Visitor Cost = cost / dailyEngagedVisitors
-
opens: Decimal¶ Number of unique-by-session email opens collected for a campaign.
WARNING: this field is deprecated, please use “emailUniqueOpen” instead. To ease up the transition this field will still be available, but always return null.
-
openRate: Decimal¶ WARNING: this field is deprecated, please use “emailUniqueOpenRate”. To ease up the transition this field will still be available, but always return null.
-
emailSentConfirmed: Decimal!¶ Total emails confirmed to have been sent by the Email Service Provider.
-
emailDeliveryRate: Decimal!¶ The percent of emails that have been confirmed to be delivered, over the send attempts.
-
emailUniqueOpenRate: Decimal!¶ The percent of sent emails that are opened once in a user’s lifetime.
-
emailUniqueClick: Decimal!¶ The number of times a link in an email was clicked once in a user’s lifetime.
-
emailUniqueClickRate: Decimal!¶ The percentage of emails opened that were clicked once in a user’s lifetime.
-
emailUniqueUnsubscribeRate: Decimal!¶ The percent of recipients that have unsubscribers (unique) over the number of confirmed to be deliveries.
-
emailUniqueClicksByCountry: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times an email was clicked once in a user’s lifetime broken out by ISO-2 country code
-
emailUniqueOpensByCountry: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times an email is opened by a user in its lifetime, broken out by ISO-2 country code
-
emailUniqueClicksByDeviceType: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times a link in an email was clicked once in a user’s lifetime, broken out by device type One of ‘pc’, ‘mobile’, ‘tablet’, ‘other’.
-
emailUniqueOpensByDeviceType: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times an email is opened by a user in its lifetime, broken out by device type One of ‘pc’, ‘mobile’, ‘tablet’, ‘other’.
-
emailUniqueClicksByXpathUrl: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Unique clicks by xpath;url present in an email message The key <xpath>;<url or macro> consists in 2 parts: 1. A XPath locator to the individual element that was clicked in the email message, based on a HTML5-compliant tree. 2. URL or macro: either a static URL that was clicked present in the email template or, the macro used to generate the URL. Eg.: {{product.url}}. Useful to identify links generated for the same intent, but it might show differently for emailed contacts.
In the future we may break this out to seperate metrics
-
smsSentUnconfirmed: Decimal!¶ Total number of SMS messages that were sent, but still unconfirmed on their delivery.
-
smsSentDelivered: Decimal!¶ Total number of SMS messages that were delivered (and confirmed by the recipient)
-
smsSentUndelivered: Decimal!¶ Total number of SMS messages that were marked as undelivered. This can happen for many reasons including carrier content filtering and the availability of the destination handset.
-
smsSentFailed: Decimal!¶ Total number of SMS messages that were considered as failed. This can happen for various reasons including queue overflows, Account suspensions and media errors.
-
smsUnsubscribers: Decimal!¶ Total number of recipients that responded to the message with a request to unsubscribe them.
-
videoCompletionRate: Decimal¶ Video completion rate
Video Completion Rate (x) = Video Viewed To 100% / Video Impressions
-
siteBounceRate: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteNewVisitors: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteNewVisitorsNot: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteEngaged: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteEngagedNot: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteEngagedNewVisitors: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteEngagedNewVisitorsNot: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteAddToCart: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteAddToCartNot: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteConverters: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteConvertersNot: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
GroupQuery¶ [BETA] This GraphQL node is currently under development.
Avoid its use in production until it has passed some thorough QA.
Provides arbitrary grouping for queries.
Fields:
-
loadBy(eids: [String!]!, by: String!, start: Date, end: Date, pastDays: Int, currency: String, groups: [GroupBy!]!): GroupResult¶ Loads entities and metrics providing for arbitrary grouping.
Each group in the ‘groups’ argument will create a group level in the hierarchy. The first root group will always be empty and can be used as an aggregate for all the metrics.
Arguments:
-
eids: [String!]!¶ List of EIDs to load by. The kind of entity being loaded by is specified with the ‘by’ argument.
-
by: String!¶ Kind of entity to load by. The EIDs of the entities to load by are specified in the ‘eids’ argument.
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
pastDays: Int¶ Alternative to start/end parameters with less precedence. The date range will be: [today_utc - pastDays, today_utc)
- Default
0
-
groups: [GroupBy!]!¶ List of groups to group by.
- Default
[ ]
-
-
loadByList(eids: [String!]!, by: String!, start: Date, end: Date, pastDays: Int, currency: String, groups: [GroupBy!]!): [GroupListRow!]!¶ Loads entities and metrics providing for arbitrary grouping.
This differs from loadBy in that the group hierarchy is returned as a flat list that must be reconstructed as a tree by the client.
For details on how the group hierarchy is returned, see the documentation for GroupListRow.
Arguments:
-
eids: [String!]!¶ List of EIDs to load by. The kind of entity being loaded by is specified with the ‘by’ argument.
-
by: String!¶ Kind of entity to load by. The EIDs of the entities to load by are specified in the ‘eids’ argument.
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
pastDays: Int¶ Alternative to start/end parameters with less precedence. The date range will be: [today_utc - pastDays, today_utc)
- Default
0
-
groups: [GroupBy!]!¶ List of groups to group by.
- Default
[ ]
-
-
-
GroupResult¶ [BETA] This GraphQL node is currently under development.
Avoid its use in production until it has passed some thorough QA.
Result for the ‘groups.loadBy’ field.
Fields:
-
groups: [GroupResult!]!¶ Return children groups if available.
-
date: String!¶ When grouping by date, this is the metric date for this group. The format depends on the ‘date’ argument of the GroupBy:
day: “2018-12-30”
week: “2018-W52”
month: “2018-12”
year: “2018”
dayofweek: “sun”
-
dateKey: String!¶ This is a sortable value for the ‘date’ argument. It is equal to ‘date’ except for when using ‘dayofweek’ when it is the number corresponding to the week day order.
-
columns: JSON!¶ When grouping by columns, this will return a JSON object whose keys are the group column names (as specified in the GroupBy argument) and the values are the column values for the current group.
-
organization: OrganizationGroupData¶ Organization data for the group. This is only available when grouping by organizations (e.g. ‘entity’ = ‘organization’).
-
advertisable: AdvertisableGroupData¶ Advertisable data for the group. This is only available when grouping by advertisables (e.g. ‘entity’ = ‘advertisable’).
-
campaign: CampaignGroupData¶ Campaign data for the group. This is only available when grouping by campaigns (e.g. ‘entity’ = ‘campaign’).
-
adgroup: AdgroupGroupData¶ Adgroup data for the group. This is only available when grouping by adgroups (e.g. ‘entity’ = ‘adgroup’).
-
ad: AdGroupData¶ Ad data for the group. This is only available when grouping by ads (e.g. ‘entity’ = ‘ad’).
-
segment: SegmentGroupData¶ Segment data for the group. This is only available when grouping by segments (e.g. ‘entity’ = ‘segment’).
-
email: EmailGroupData¶ Email data for the group. This is only available when grouping by emails (e.g. ‘entity’ = ‘email’).
-
smsMessage: SMSMessageGroupData¶ SMS data for the group. This is only available when grouping by sms messages (e.g. ‘entity’ = ‘smsMessage’).
-
audience: AudienceGroupData¶ Audience data for the group. This is only available when grouping by audiences (e.g. ‘entity’ = ‘audience’).
-
clickThroughs: Decimal¶ Click-through conversion (CTC). A goal completion that happens after someone clicks your ad.
-
viewThroughs: Decimal¶ View-through conversion (VTC). A goal completion that happens after someone views your ad, but does not click.
-
clickRevenue: Decimal¶ Click-Attributed Revenue. Total earnings when someone clicks your ad and converts.
-
viewRevenue: Decimal¶ View-Attributed Revenue. Total earnings when someone views your ad and converts.
-
ctr: Decimal¶ Click-through rate. The percentage of ad serves that were clicked.
CTR (%) = Clicks / Impression * 100
-
cpa: Decimal¶ Cost per acquisition. Your average spend per conversion.
CPA ($) = Spend / Conversions
-
clickCPA: Decimal¶ Cost-per-click acquisition. Your average spend for a conversion that happens after someone clicks your ad.
Click CPA ($) = Spend / Click Conversions
-
viewCPA: Decimal¶ Cost-per-view acquisition: Your average spend for a conversion that happens after someone views your ad.
View CPA ($) = Cost / View Throughs
-
averageOrderValue: Decimal¶ Average Order Value Average revenue per attributed conversion.
Average Order Value ($) = Attributed Revenue / Conversions
-
ctcRate: Decimal¶ Click-through conversion rate. The percentage of clicks that resulted in a click-through conversion.
CTC Rate (%) = Click Conversions / Clicks * 100
-
vtcRate: Decimal¶ View-through conversion rate: The percentage of impressions that resulted in a view-through conversion.
VTC Rate (%) = View Throughs / Impressions * 100
-
roas: Decimal¶ Return on advertising spend: Your profit per dollar spent on ads.
ROAS (x) = (Click Revenue + View Revenue) / Cost
-
clickROAS: Decimal¶ Click return on advertising spend: Your profit per dollar spent, generated from conversions that happen after someone clicks your ad.
Click ROAS (x) = Click Revenue / Cost
-
viewROAS: Decimal¶ View return on advertising spend: Your profit per dollar spent, generated from conversions that happen after someone views your ad.
View ROAS (x) = View Revenue / Cost
-
influencedThroughs: Decimal¶ Influenced Conversions.
A conversion touched or assisted by an ad but not attributed due to the current attribution model.
-
influencedRevenue: Decimal¶ Influenced Revenue.
Revenue touched or assisted by an ad but not attributed due to the current attribution model.
-
newVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyNewVisitors instead.
The number of unique new visitors who came to your site after viewing a prospecting ad.
-
engagedVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyEngagedVisitors instead.
The number of unique new visitors who have viewed at least 3 pages on your site after viewing a prospecting ad.
-
bouncedVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL.
Visitors who have only viewed one page and left your site after viewing a prospecting ad.
-
nonBouncedVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL.
Visitors who have only viewed more than one page after viewing a prospecting ad.
-
newVisitorCost: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyNewVisitorCost instead.
The cost for each unique new visitor that came to your site after viewing a prospecting ad.
New Visitor Cost = cost / newVisitors
-
engagedVisitorCost: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyEngagedVisitorCost instead.
The cost for each unique new visitor that has viewed at least 3 pages on your site after viewing a prospecting ad
Engaged Visitor Cost = cost / engagedVisitors
-
bounceRate: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL.
The percentage of new visitors who have only viewed one page and left your site after viewing a prospecting ad.
Bounce Rate (%) = bouncedVisitors / newVisitors * 100.
-
dailyNewVisitors: Decimal¶ The number of daily new visitors who came to your site after viewing a prospecting ad.
-
dailyReturnVisitors: Decimal¶ The number of daily new visitors who return to your site after viewing a prospecting ad.
-
dailyEngagedVisitors: Decimal¶ The number of daily new visitors who have viewed at least 3 pages on your site after viewing a prospecting ad.
-
dailyBounceRate: Decimal¶ The percentage of daily new visitors who have only viewed one page and left your site after viewing a prospecting ad.
-
dailyNewVisitorCost: Decimal¶ The cost for each daily new visitor that came to your site after viewing a prospecting ad.
New Visitor Cost = cost / dailyNewVisitors
-
dailyEngagedVisitorCost: Decimal¶ The cost for each daily new visitor that has viewed at least 3 pages on your site after viewing a prospecting ad
Engaged Visitor Cost = cost / dailyEngagedVisitors
-
opens: Decimal¶ Number of unique-by-session email opens collected for a campaign.
WARNING: this field is deprecated, please use “emailUniqueOpen” instead. To ease up the transition this field will still be available, but always return null.
-
openRate: Decimal¶ WARNING: this field is deprecated, please use “emailUniqueOpenRate”. To ease up the transition this field will still be available, but always return null.
-
emailSentConfirmed: Decimal!¶ Total emails confirmed to have been sent by the Email Service Provider.
-
emailDeliveryRate: Decimal!¶ The percent of emails that have been confirmed to be delivered, over the send attempts.
-
emailUniqueOpenRate: Decimal!¶ The percent of sent emails that are opened once in a user’s lifetime.
-
emailUniqueClick: Decimal!¶ The number of times a link in an email was clicked once in a user’s lifetime.
-
emailUniqueClickRate: Decimal!¶ The percentage of emails opened that were clicked once in a user’s lifetime.
-
emailUniqueUnsubscribeRate: Decimal!¶ The percent of recipients that have unsubscribers (unique) over the number of confirmed to be deliveries.
-
emailUniqueClicksByCountry: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times an email was clicked once in a user’s lifetime broken out by ISO-2 country code
-
emailUniqueOpensByCountry: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times an email is opened by a user in its lifetime, broken out by ISO-2 country code
-
emailUniqueClicksByDeviceType: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times a link in an email was clicked once in a user’s lifetime, broken out by device type One of ‘pc’, ‘mobile’, ‘tablet’, ‘other’.
-
emailUniqueOpensByDeviceType: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times an email is opened by a user in its lifetime, broken out by device type One of ‘pc’, ‘mobile’, ‘tablet’, ‘other’.
-
emailUniqueClicksByXpathUrl: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Unique clicks by xpath;url present in an email message The key <xpath>;<url or macro> consists in 2 parts: 1. A XPath locator to the individual element that was clicked in the email message, based on a HTML5-compliant tree. 2. URL or macro: either a static URL that was clicked present in the email template or, the macro used to generate the URL. Eg.: {{product.url}}. Useful to identify links generated for the same intent, but it might show differently for emailed contacts.
In the future we may break this out to seperate metrics
-
smsSentUnconfirmed: Decimal!¶ Total number of SMS messages that were sent, but still unconfirmed on their delivery.
-
smsSentDelivered: Decimal!¶ Total number of SMS messages that were delivered (and confirmed by the recipient)
-
smsSentUndelivered: Decimal!¶ Total number of SMS messages that were marked as undelivered. This can happen for many reasons including carrier content filtering and the availability of the destination handset.
-
smsSentFailed: Decimal!¶ Total number of SMS messages that were considered as failed. This can happen for various reasons including queue overflows, Account suspensions and media errors.
-
-
InventoryCampaign¶ Fields:
-
budget: Decimal!¶ The daily budget of the campaign. Note that this can be an approximation, for example when budgetType = “lifetime” it is: budget = budgetGoal / numberOfDays(budgetStartDate, budgetEndDate)
-
budgetGoal: Decimal!¶ The budget of the campaign, considered for the whole extent of its budgetType. When budgetType = “lifetime”, it will be applied in the period since budgetStartDate until budgetEndDate.
-
budgetType: String!¶ The type of budget of the campaign (daily, lifetime…). If this includes -auto (i.e. daily-auto), then it is the inventory campaign of a proxy strategy that is auto-balancing the budget for this campaign
-
budgetSettingsString: String!¶ Serialized budget settings as a string. “budgetType,budgetStartDate,budgetEndDate,budgetGoal”
-
status: String!¶ The status of the campaign. One of ‘running’, ‘ended’, ‘paused’, ‘review’, ‘draft’, ‘rejected’ or ‘deleted’. Result is ‘billingFailedPermanent’ or ‘billingFailedRecoverable’ when BillingAuthStatus is ‘failed’.
-
actualStatus: JSON¶ The effective status of the campaign. Details the reasons why it is not running, if applicable.
-
actualStatusString: String!¶ Minimal string representation of the actual status. One of ‘running’, ‘notRunning’ ,’ended’, ‘paused’, ‘review’, ‘draft’, ‘rejected’ or ‘deleted’.
-
targetingType: String!¶ The type of targeting that is used to pick which customers will be reached by this campaign.
-
kpiGoal: Decimal!¶ Goal -for the kpiMetric- that drives the campaign’s bid strategy. Null for automatic.
-
kpiCurrency: String!¶ ISO 4217 currency code for kpiGoal. If not provided assume the currency provided at the Advertisable level.
-
processingStatus: String!¶ The processing status of the campaign inside the AdRoll. It may have a transient value other than “created” while the campaign is being processed by an internal job.
-
billingAuthStatus: String¶ The billing auth status of the campaign inside the AdRoll. Will default to empty string when API BillingAuthStatus not present. Result is “failed” when the billing authorization did not complete.
-
inVoltronStrategyEID: String!¶ The EID of this campaign as referenced from its Voltron strategy. Only available for inventory campaigns of Universal Campaigns.
-
proxyStrategyEID: String!¶ The eid of the Proxy Strategy that contains this campaign. Only for Inventory campaigns.
-
proxyStrategyStatus: String!¶ The status of the Proxy Strategy that contains this campaign. Only for Inventory campaigns.
-
proxyStrategyName: String!¶ The name of the Proxy Strategy that contains this campaign. Only for Inventory campaigns.
If this is an Email Newsletter campaign, the number of potential recipients.
If this is an Email Newsletter campaign, the number of emails sent.
If this is an Email Newsletter campaign, the scheduled date for delivery. Only if the delivery is scheduled to happen or of it has already occurred. Omitted if in draft, paused or cancelled.
-
isBillable: Boolean!¶ True if the campaign is run by NextRoll and will be directly billed to the advertisable’s account. False if it is run by a third party.
-
syncStatus: String!¶ Only for Connected Campaigns, indicates the status of the sync’ing with the external service. When available, can be one of “pending”, “synced” or “error”
-
syncError: String!¶ Only for Connected Campaigns, shows the error that caused the sync’ing with the external service to fail. Provided if the syncStatus field is “error”.
-
funnelStage: String¶ Funnel stage for the campaign. One of “awareness”, “consideration”, “conversion”, or “other”.
-
isBudgetBalancingAutomated: Boolean!¶ Indicates if this campaign is a strategy that balances the budget automatically across its inventory campaigns. False means that inventory campaign budgets are manually set.
-
performanceTargets: [PerformanceTarget]¶ PerformanceTargets
Internal tags set on creation.
-
automationNodeEID: String¶ If managed by an Automation, the EID of the Automation Node that references this entity.
-
disabled: Boolean!¶ Indicates if the campaign is disabled. Currently applies only to Automation-managed campaigns that have been disabled by subscription downgrade action.
-
smsMessages: [SMSMessage]!¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
SMS Messages for this Campaign
-
metrics(start: Date, end: Date, pastDays: Int, currency: String, duration: Int): CampaignMetricResult!¶ Metrics for the Campaign.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
conversions(start: Date, end: Date, pastDays: Int, currency: String): ConversionResult!¶ Metrics for the entity broken down by conversion audiences.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
-
Keyword¶ Contains reporting metric data by keyword for Google Search campaign-adgroups.
Fields:
-
conversions: Decimal!¶ Conversions Total. Conversions (count) = View Conversions + Click Conversions
-
clickThroughs: Decimal!¶ Click-through conversion (CTC). A goal completion that happens after someone clicks your ad.
-
viewThroughs: Decimal!¶ View-through conversion (VTC). A goal completion that happens after someone views your ad, but does not click.
-
clickRevenue: Decimal!¶ Click-Attributed Revenue. Total earnings when someone clicks your ad and converts.
-
viewRevenue: Decimal!¶ View-Attributed Revenue. Total earnings when someone views your ad and converts.
-
ctr: Decimal!¶ Click-through rate. The percentage of ad serves that were clicked.
CTR (%) = Clicks / Impression * 100
-
cpm: Decimal!¶ Cost per mille. Cost per one thousand ad serves.
CPM ($) = Spend / Impressions * 1000
-
cpa: Decimal!¶ Cost per acquisition. Your average spend per conversion.
CPA ($) = Spend / Conversions
-
clickCPA: Decimal!¶ Cost-per-click acquisition. Your average spend for a conversion that happens after someone clicks your ad.
Click CPA ($) = Spend / Click Conversions
-
viewCPA: Decimal!¶ Cost-per-view acquisition: Your average spend for a conversion that happens after someone views your ad.
View CPA ($) = Cost / View Throughs
-
averageOrderValue: Decimal!¶ Average Order Value Average revenue per attributed conversion.
Average Order Value ($) = Attributed Revenue / Conversions
-
ctcRate: Decimal!¶ Click-through conversion rate. The percentage of clicks that resulted in a click-through conversion.
CTC Rate (%) = Click Conversions / Clicks * 100
-
vtcRate: Decimal!¶ View-through conversion rate: The percentage of impressions that resulted in a view-through conversion.
VTC Rate (%) = View Throughs / Impressions * 100
-
roas: Decimal!¶ Return on advertising spend: Your profit per dollar spent on ads.
ROAS (x) = (Click Revenue + View Revenue) / Cost
-
-
KeywordResult¶ Fields:
-
byKeyword: [Keyword!]!¶ Summarizes by Google Search keyword the reporting data for the given date range. [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Currently Fetching Keywords and keyword metrics without also requesting metrics for parent adgroup or campaign will return empty result.
-
-
LogEvent¶ Represents a single log event.
Fields:
-
LogItem¶ [WARNING] Log lines are intended for internal analysis and debugging.
They are not available for external developers to consume.
Represents a single entry in the operation log for the query.
Fields:
-
info: String!¶ The kind, key, text and timing information for the entry in a single field, for convenience.
-
data(filter: String): LogItemData¶ Additional data for the log entry.
Arguments:
-
filter: String¶ Filter the returned data by name. If this is empty, only the default (i.e. unnamed) data will be returned.
This supports wildcard * characters to match anything. If the wildcard follows a dot (i.e. .*) the dot is made optional (e.g. name.* will match both name and name.child).
- Default
null
-
-
json(filter: String): JSON¶ Additional data for the log entry as JSON.
This is a shortcut for querying:
data(filter:”some filter”) { json }
This is null if the given data cannot be converted to JSON.
Arguments:
-
allData: [LogItemData!]!¶ Return all data items for the entry.
-
-
LogItemData¶ [WARNING] Log lines are intended for internal analysis and debugging.
They are not available for external developers to consume.
Data entry for a LogItem.
Fields:
-
Metric¶ Contains reporting metric data for attributions, deliveries,
segment deliveries and emails.
Fields:
-
clickThroughs: Decimal¶ Click-through conversion (CTC). A goal completion that happens after someone clicks your ad.
-
viewThroughs: Decimal¶ View-through conversion (VTC). A goal completion that happens after someone views your ad, but does not click.
-
clickRevenue: Decimal¶ Click-Attributed Revenue. Total earnings when someone clicks your ad and converts.
-
viewRevenue: Decimal¶ View-Attributed Revenue. Total earnings when someone views your ad and converts.
-
ctr: Decimal¶ Click-through rate. The percentage of ad serves that were clicked.
CTR (%) = Clicks / Impression * 100
-
cpa: Decimal¶ Cost per acquisition. Your average spend per conversion.
CPA ($) = Spend / Conversions
-
clickCPA: Decimal¶ Cost-per-click acquisition. Your average spend for a conversion that happens after someone clicks your ad.
Click CPA ($) = Spend / Click Conversions
-
viewCPA: Decimal¶ Cost-per-view acquisition: Your average spend for a conversion that happens after someone views your ad.
View CPA ($) = Cost / View Throughs
-
averageOrderValue: Decimal¶ Average Order Value Average revenue per attributed conversion.
Average Order Value ($) = Attributed Revenue / Conversions
-
ctcRate: Decimal¶ Click-through conversion rate. The percentage of clicks that resulted in a click-through conversion.
CTC Rate (%) = Click Conversions / Clicks * 100
-
vtcRate: Decimal¶ View-through conversion rate: The percentage of impressions that resulted in a view-through conversion.
VTC Rate (%) = View Throughs / Impressions * 100
-
roas: Decimal¶ Return on advertising spend: Your profit per dollar spent on ads.
ROAS (x) = (Click Revenue + View Revenue) / Cost
-
clickROAS: Decimal¶ Click return on advertising spend: Your profit per dollar spent, generated from conversions that happen after someone clicks your ad.
Click ROAS (x) = Click Revenue / Cost
-
viewROAS: Decimal¶ View return on advertising spend: Your profit per dollar spent, generated from conversions that happen after someone views your ad.
View ROAS (x) = View Revenue / Cost
-
influencedThroughs: Decimal¶ Influenced Conversions.
A conversion touched or assisted by an ad but not attributed due to the current attribution model.
-
influencedRevenue: Decimal¶ Influenced Revenue.
Revenue touched or assisted by an ad but not attributed due to the current attribution model.
-
newVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyNewVisitors instead.
The number of unique new visitors who came to your site after viewing a prospecting ad.
-
engagedVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyEngagedVisitors instead.
The number of unique new visitors who have viewed at least 3 pages on your site after viewing a prospecting ad.
-
bouncedVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL.
Visitors who have only viewed one page and left your site after viewing a prospecting ad.
-
nonBouncedVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL.
Visitors who have only viewed more than one page after viewing a prospecting ad.
-
newVisitorCost: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyNewVisitorCost instead.
The cost for each unique new visitor that came to your site after viewing a prospecting ad.
New Visitor Cost = cost / newVisitors
-
engagedVisitorCost: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyEngagedVisitorCost instead.
The cost for each unique new visitor that has viewed at least 3 pages on your site after viewing a prospecting ad
Engaged Visitor Cost = cost / engagedVisitors
-
bounceRate: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL.
The percentage of new visitors who have only viewed one page and left your site after viewing a prospecting ad.
Bounce Rate (%) = bouncedVisitors / newVisitors * 100.
-
dailyNewVisitors: Decimal¶ The number of daily new visitors who came to your site after viewing a prospecting ad.
-
dailyReturnVisitors: Decimal¶ The number of daily new visitors who return to your site after viewing a prospecting ad.
-
dailyEngagedVisitors: Decimal¶ The number of daily new visitors who have viewed at least 3 pages on your site after viewing a prospecting ad.
-
dailyBounceRate: Decimal¶ The percentage of daily new visitors who have only viewed one page and left your site after viewing a prospecting ad.
-
dailyNewVisitorCost: Decimal¶ The cost for each daily new visitor that came to your site after viewing a prospecting ad.
New Visitor Cost = cost / dailyNewVisitors
-
dailyEngagedVisitorCost: Decimal¶ The cost for each daily new visitor that has viewed at least 3 pages on your site after viewing a prospecting ad
Engaged Visitor Cost = cost / dailyEngagedVisitors
-
opens: Decimal¶ Number of unique-by-session email opens collected for a campaign.
WARNING: this field is deprecated, please use “emailUniqueOpen” instead. To ease up the transition this field will still be available, but always return null.
-
openRate: Decimal¶ WARNING: this field is deprecated, please use “emailUniqueOpenRate”. To ease up the transition this field will still be available, but always return null.
-
emailSentConfirmed: Decimal!¶ Total emails confirmed to have been sent by the Email Service Provider.
-
emailDeliveryRate: Decimal!¶ The percent of emails that have been confirmed to be delivered, over the send attempts.
-
emailUniqueOpenRate: Decimal!¶ The percent of sent emails that are opened once in a user’s lifetime.
-
emailUniqueClick: Decimal!¶ The number of times a link in an email was clicked once in a user’s lifetime.
-
emailUniqueClickRate: Decimal!¶ The percentage of emails opened that were clicked once in a user’s lifetime.
-
emailUniqueUnsubscribeRate: Decimal!¶ The percent of recipients that have unsubscribers (unique) over the number of confirmed to be deliveries.
-
emailUniqueClicksByCountry: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times an email was clicked once in a user’s lifetime broken out by ISO-2 country code
-
emailUniqueOpensByCountry: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times an email is opened by a user in its lifetime, broken out by ISO-2 country code
-
emailUniqueClicksByDeviceType: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times a link in an email was clicked once in a user’s lifetime, broken out by device type One of ‘pc’, ‘mobile’, ‘tablet’, ‘other’.
-
emailUniqueOpensByDeviceType: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times an email is opened by a user in its lifetime, broken out by device type One of ‘pc’, ‘mobile’, ‘tablet’, ‘other’.
-
emailUniqueClicksByXpathUrl: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Unique clicks by xpath;url present in an email message The key <xpath>;<url or macro> consists in 2 parts: 1. A XPath locator to the individual element that was clicked in the email message, based on a HTML5-compliant tree. 2. URL or macro: either a static URL that was clicked present in the email template or, the macro used to generate the URL. Eg.: {{product.url}}. Useful to identify links generated for the same intent, but it might show differently for emailed contacts.
In the future we may break this out to seperate metrics
-
smsSentUnconfirmed: Decimal!¶ Total number of SMS messages that were sent, but still unconfirmed on their delivery.
-
smsSentDelivered: Decimal!¶ Total number of SMS messages that were delivered (and confirmed by the recipient)
-
smsSentUndelivered: Decimal!¶ Total number of SMS messages that were marked as undelivered. This can happen for many reasons including carrier content filtering and the availability of the destination handset.
-
smsSentFailed: Decimal!¶ Total number of SMS messages that were considered as failed. This can happen for various reasons including queue overflows, Account suspensions and media errors.
-
smsUnsubscribers: Decimal!¶ Total number of recipients that responded to the message with a request to unsubscribe them.
-
videoCompletionRate: Decimal¶ Video completion rate
Video Completion Rate (x) = Video Viewed To 100% / Video Impressions
-
frequency: Decimal!¶ Number of ads seen per day by reached users
Frequency = total impressions/reached users
-
customMetric(formula: String): Decimal!¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Usage: - Operators: ‘+’, ‘-‘, ‘*’, ‘/’ and parentheses () are valid Requires formula to have space-seperated operand and operators.
e.g. costPerImpression: customMetric(formula: “cost / impressions”)
Arguments:
-
araViewThroughs: Decimal¶ A goal completion that happens after someone views your ad, but does not click. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araClickThroughs: Decimal¶ A goal completion that happens after someone clicks your ad. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araViewThroughsVariance: Decimal¶ Variance of the view-through conversions. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araClickThroughsVariance: Decimal¶ Variance of the click-through conversions. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araViewRevenueMin: Decimal¶ Lower bound on total earnings when someone views your ad and converts. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araViewRevenueMax: Decimal¶ Upper bound on total earnings when someone views your ad and converts. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
-
MetricAggregateResult¶ Groups reporting metric data in summary and by date format. This
is the result of the metricsTotal field. See the root metricsTotal
field in Query for documentation.
Fields:
-
MetricDomain¶ Contains reporting metric data for the domain.
Fields:
-
MetricDomainResult¶ Groups reporting metric data for the domain in summary and by
date format.
Fields:
-
summary: MetricDomain!¶ Summarizes the reporting data for the given date range.
-
byDate: [MetricDomain!]!¶ Reporting data by date in the given range.
-
-
MetricForAdvertisable¶ Contains advertisable level reporting metric data for attributions, deliveries,
segment deliveries and emails.
Fields:
-
clickThroughs: Decimal¶ Click-through conversion (CTC). A goal completion that happens after someone clicks your ad.
-
viewThroughs: Decimal¶ View-through conversion (VTC). A goal completion that happens after someone views your ad, but does not click.
-
clickRevenue: Decimal¶ Click-Attributed Revenue. Total earnings when someone clicks your ad and converts.
-
viewRevenue: Decimal¶ View-Attributed Revenue. Total earnings when someone views your ad and converts.
-
ctr: Decimal¶ Click-through rate. The percentage of ad serves that were clicked.
CTR (%) = Clicks / Impression * 100
-
cpa: Decimal¶ Cost per acquisition. Your average spend per conversion.
CPA ($) = Spend / Conversions
-
clickCPA: Decimal¶ Cost-per-click acquisition. Your average spend for a conversion that happens after someone clicks your ad.
Click CPA ($) = Spend / Click Conversions
-
viewCPA: Decimal¶ Cost-per-view acquisition: Your average spend for a conversion that happens after someone views your ad.
View CPA ($) = Cost / View Throughs
-
averageOrderValue: Decimal¶ Average Order Value Average revenue per attributed conversion.
Average Order Value ($) = Attributed Revenue / Conversions
-
ctcRate: Decimal¶ Click-through conversion rate. The percentage of clicks that resulted in a click-through conversion.
CTC Rate (%) = Click Conversions / Clicks * 100
-
vtcRate: Decimal¶ View-through conversion rate: The percentage of impressions that resulted in a view-through conversion.
VTC Rate (%) = View Throughs / Impressions * 100
-
roas: Decimal¶ Return on advertising spend: Your profit per dollar spent on ads.
ROAS (x) = (Click Revenue + View Revenue) / Cost
-
clickROAS: Decimal¶ Click return on advertising spend: Your profit per dollar spent, generated from conversions that happen after someone clicks your ad.
Click ROAS (x) = Click Revenue / Cost
-
viewROAS: Decimal¶ View return on advertising spend: Your profit per dollar spent, generated from conversions that happen after someone views your ad.
View ROAS (x) = View Revenue / Cost
-
influencedThroughs: Decimal¶ Influenced Conversions.
A conversion touched or assisted by an ad but not attributed due to the current attribution model.
-
influencedRevenue: Decimal¶ Influenced Revenue.
Revenue touched or assisted by an ad but not attributed due to the current attribution model.
-
newVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyNewVisitors instead.
The number of unique new visitors who came to your site after viewing a prospecting ad.
-
engagedVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyEngagedVisitors instead.
The number of unique new visitors who have viewed at least 3 pages on your site after viewing a prospecting ad.
-
bouncedVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL.
Visitors who have only viewed one page and left your site after viewing a prospecting ad.
-
nonBouncedVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL.
Visitors who have only viewed more than one page after viewing a prospecting ad.
-
newVisitorCost: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyNewVisitorCost instead.
The cost for each unique new visitor that came to your site after viewing a prospecting ad.
New Visitor Cost = cost / newVisitors
-
engagedVisitorCost: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyEngagedVisitorCost instead.
The cost for each unique new visitor that has viewed at least 3 pages on your site after viewing a prospecting ad
Engaged Visitor Cost = cost / engagedVisitors
-
bounceRate: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL.
The percentage of new visitors who have only viewed one page and left your site after viewing a prospecting ad.
Bounce Rate (%) = bouncedVisitors / newVisitors * 100.
-
dailyNewVisitors: Decimal¶ The number of daily new visitors who came to your site after viewing a prospecting ad.
-
dailyReturnVisitors: Decimal¶ The number of daily new visitors who return to your site after viewing a prospecting ad.
-
dailyEngagedVisitors: Decimal¶ The number of daily new visitors who have viewed at least 3 pages on your site after viewing a prospecting ad.
-
dailyBounceRate: Decimal¶ The percentage of daily new visitors who have only viewed one page and left your site after viewing a prospecting ad.
-
dailyNewVisitorCost: Decimal¶ The cost for each daily new visitor that came to your site after viewing a prospecting ad.
New Visitor Cost = cost / dailyNewVisitors
-
dailyEngagedVisitorCost: Decimal¶ The cost for each daily new visitor that has viewed at least 3 pages on your site after viewing a prospecting ad
Engaged Visitor Cost = cost / dailyEngagedVisitors
-
opens: Decimal¶ Number of unique-by-session email opens collected for a campaign.
WARNING: this field is deprecated, please use “emailUniqueOpen” instead. To ease up the transition this field will still be available, but always return null.
-
openRate: Decimal¶ WARNING: this field is deprecated, please use “emailUniqueOpenRate”. To ease up the transition this field will still be available, but always return null.
-
emailSentConfirmed: Decimal!¶ Total emails confirmed to have been sent by the Email Service Provider.
-
emailDeliveryRate: Decimal!¶ The percent of emails that have been confirmed to be delivered, over the send attempts.
-
emailUniqueOpenRate: Decimal!¶ The percent of sent emails that are opened once in a user’s lifetime.
-
emailUniqueClick: Decimal!¶ The number of times a link in an email was clicked once in a user’s lifetime.
-
emailUniqueClickRate: Decimal!¶ The percentage of emails opened that were clicked once in a user’s lifetime.
-
emailUniqueUnsubscribeRate: Decimal!¶ The percent of recipients that have unsubscribers (unique) over the number of confirmed to be deliveries.
-
emailUniqueClicksByCountry: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times an email was clicked once in a user’s lifetime broken out by ISO-2 country code
-
emailUniqueOpensByCountry: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times an email is opened by a user in its lifetime, broken out by ISO-2 country code
-
emailUniqueClicksByDeviceType: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times a link in an email was clicked once in a user’s lifetime, broken out by device type One of ‘pc’, ‘mobile’, ‘tablet’, ‘other’.
-
emailUniqueOpensByDeviceType: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times an email is opened by a user in its lifetime, broken out by device type One of ‘pc’, ‘mobile’, ‘tablet’, ‘other’.
-
emailUniqueClicksByXpathUrl: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Unique clicks by xpath;url present in an email message The key <xpath>;<url or macro> consists in 2 parts: 1. A XPath locator to the individual element that was clicked in the email message, based on a HTML5-compliant tree. 2. URL or macro: either a static URL that was clicked present in the email template or, the macro used to generate the URL. Eg.: {{product.url}}. Useful to identify links generated for the same intent, but it might show differently for emailed contacts.
In the future we may break this out to seperate metrics
-
smsSentUnconfirmed: Decimal!¶ Total number of SMS messages that were sent, but still unconfirmed on their delivery.
-
smsSentDelivered: Decimal!¶ Total number of SMS messages that were delivered (and confirmed by the recipient)
-
smsSentUndelivered: Decimal!¶ Total number of SMS messages that were marked as undelivered. This can happen for many reasons including carrier content filtering and the availability of the destination handset.
-
smsSentFailed: Decimal!¶ Total number of SMS messages that were considered as failed. This can happen for various reasons including queue overflows, Account suspensions and media errors.
-
smsUnsubscribers: Decimal!¶ Total number of recipients that responded to the message with a request to unsubscribe them.
-
videoCompletionRate: Decimal¶ Video completion rate
Video Completion Rate (x) = Video Viewed To 100% / Video Impressions
-
frequency: Decimal!¶ Number of ads seen per day by reached users
Frequency = total impressions/reached users
-
araViewThroughs: Decimal¶ A goal completion that happens after someone views your ad, but does not click. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araClickThroughs: Decimal¶ A goal completion that happens after someone clicks your ad. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araViewThroughsVariance: Decimal¶ Variance of the view-through conversions. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araClickThroughsVariance: Decimal¶ Variance of the click-through conversions. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araViewRevenueMin: Decimal¶ Lower bound on total earnings when someone views your ad and converts. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araViewRevenueMax: Decimal¶ Upper bound on total earnings when someone views your ad and converts. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araClickRevenueMin: Decimal¶ Lower bound on total earnings when someone clicks your ad and converts. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araClickRevenueMax: Decimal¶ Upper bound on total earnings when someone clicks your ad and converts. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
siteBounceRate: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteNewVisitors: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteNewVisitorsNot: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteEngaged: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteEngagedNot: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteEngagedNewVisitors: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteEngagedNewVisitorsNot: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteAddToCart: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteAddToCartNot: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteConverters: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteConvertersNot: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteReturningVisitors: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteReturningVisitorsNot: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
convCountImpRate01: Decimal!¶ Number of converters who saw an average of 0-1 ads/day in the last 30 days.
-
convCountImpRate12: Decimal!¶ Number of converters who saw an average of 1-2 ads/day in the last 30 days.
-
convCountImpRate23: Decimal!¶ Number of converters who saw an average of 2-3 ads/day in the last 30 days.
-
convCountImpRate34: Decimal!¶ Number of converters who saw an average of 3-4 ads/day in the last 30 days.
-
convCountImpRate4: Decimal!¶ Number of converters who saw an average of 4+ ads/day in the last 30 days.
-
nonConvCountImpRate01: Decimal!¶ Number of non-converters who saw an average of 0-1 ads/day in the last 30 days.
-
nonConvCountImpRate12: Decimal!¶ Number of non-converters who saw an average of 1-2 ads/day in the last 30 days.
-
nonConvCountImpRate23: Decimal!¶ Number of non-converters who saw an average of 2-3 ads/day in the last 30 days.
-
nonConvCountImpRate34: Decimal!¶ Number of non-converters who saw an average of 3-4 ads/day in the last 30 days.
-
nonConvCountImpRate4: Decimal!¶ Number of non-converters who saw an average of 4+ ads/day in the last 30 days.
-
customMetric(formula: String): Decimal!¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Usage: - Operators: ‘+’, ‘-‘, ‘*’, ‘/’ and parentheses () are valid Requires formula to have space-seperated operand and operators.
e.g. costPerImpression: customMetric(formula: “cost / impressions”)
Arguments:
-
-
MetricForCampaign¶ Contains campaign level reporting metric data for attributions, deliveries,
segment deliveries and emails.
Fields:
-
clickThroughs: Decimal¶ Click-through conversion (CTC). A goal completion that happens after someone clicks your ad.
-
viewThroughs: Decimal¶ View-through conversion (VTC). A goal completion that happens after someone views your ad, but does not click.
-
clickRevenue: Decimal¶ Click-Attributed Revenue. Total earnings when someone clicks your ad and converts.
-
viewRevenue: Decimal¶ View-Attributed Revenue. Total earnings when someone views your ad and converts.
-
ctr: Decimal¶ Click-through rate. The percentage of ad serves that were clicked.
CTR (%) = Clicks / Impression * 100
-
cpa: Decimal¶ Cost per acquisition. Your average spend per conversion.
CPA ($) = Spend / Conversions
-
clickCPA: Decimal¶ Cost-per-click acquisition. Your average spend for a conversion that happens after someone clicks your ad.
Click CPA ($) = Spend / Click Conversions
-
viewCPA: Decimal¶ Cost-per-view acquisition: Your average spend for a conversion that happens after someone views your ad.
View CPA ($) = Cost / View Throughs
-
averageOrderValue: Decimal¶ Average Order Value Average revenue per attributed conversion.
Average Order Value ($) = Attributed Revenue / Conversions
-
ctcRate: Decimal¶ Click-through conversion rate. The percentage of clicks that resulted in a click-through conversion.
CTC Rate (%) = Click Conversions / Clicks * 100
-
vtcRate: Decimal¶ View-through conversion rate: The percentage of impressions that resulted in a view-through conversion.
VTC Rate (%) = View Throughs / Impressions * 100
-
roas: Decimal¶ Return on advertising spend: Your profit per dollar spent on ads.
ROAS (x) = (Click Revenue + View Revenue) / Cost
-
clickROAS: Decimal¶ Click return on advertising spend: Your profit per dollar spent, generated from conversions that happen after someone clicks your ad.
Click ROAS (x) = Click Revenue / Cost
-
viewROAS: Decimal¶ View return on advertising spend: Your profit per dollar spent, generated from conversions that happen after someone views your ad.
View ROAS (x) = View Revenue / Cost
-
influencedThroughs: Decimal¶ Influenced Conversions.
A conversion touched or assisted by an ad but not attributed due to the current attribution model.
-
influencedRevenue: Decimal¶ Influenced Revenue.
Revenue touched or assisted by an ad but not attributed due to the current attribution model.
-
newVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyNewVisitors instead.
The number of unique new visitors who came to your site after viewing a prospecting ad.
-
engagedVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyEngagedVisitors instead.
The number of unique new visitors who have viewed at least 3 pages on your site after viewing a prospecting ad.
-
bouncedVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL.
Visitors who have only viewed one page and left your site after viewing a prospecting ad.
-
nonBouncedVisitors: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL.
Visitors who have only viewed more than one page after viewing a prospecting ad.
-
newVisitorCost: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyNewVisitorCost instead.
The cost for each unique new visitor that came to your site after viewing a prospecting ad.
New Visitor Cost = cost / newVisitors
-
engagedVisitorCost: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL. Use dailyEngagedVisitorCost instead.
The cost for each unique new visitor that has viewed at least 3 pages on your site after viewing a prospecting ad
Engaged Visitor Cost = cost / engagedVisitors
-
bounceRate: Decimal¶ This field has been deprecated as metrics for it are no longer available and it will always be NULL.
The percentage of new visitors who have only viewed one page and left your site after viewing a prospecting ad.
Bounce Rate (%) = bouncedVisitors / newVisitors * 100.
-
dailyNewVisitors: Decimal¶ The number of daily new visitors who came to your site after viewing a prospecting ad.
-
dailyReturnVisitors: Decimal¶ The number of daily new visitors who return to your site after viewing a prospecting ad.
-
dailyEngagedVisitors: Decimal¶ The number of daily new visitors who have viewed at least 3 pages on your site after viewing a prospecting ad.
-
dailyBounceRate: Decimal¶ The percentage of daily new visitors who have only viewed one page and left your site after viewing a prospecting ad.
-
dailyNewVisitorCost: Decimal¶ The cost for each daily new visitor that came to your site after viewing a prospecting ad.
New Visitor Cost = cost / dailyNewVisitors
-
dailyEngagedVisitorCost: Decimal¶ The cost for each daily new visitor that has viewed at least 3 pages on your site after viewing a prospecting ad
Engaged Visitor Cost = cost / dailyEngagedVisitors
-
opens: Decimal¶ Number of unique-by-session email opens collected for a campaign.
WARNING: this field is deprecated, please use “emailUniqueOpen” instead. To ease up the transition this field will still be available, but always return null.
-
openRate: Decimal¶ WARNING: this field is deprecated, please use “emailUniqueOpenRate”. To ease up the transition this field will still be available, but always return null.
-
emailSentConfirmed: Decimal!¶ Total emails confirmed to have been sent by the Email Service Provider.
-
emailDeliveryRate: Decimal!¶ The percent of emails that have been confirmed to be delivered, over the send attempts.
-
emailUniqueOpenRate: Decimal!¶ The percent of sent emails that are opened once in a user’s lifetime.
-
emailUniqueClick: Decimal!¶ The number of times a link in an email was clicked once in a user’s lifetime.
-
emailUniqueClickRate: Decimal!¶ The percentage of emails opened that were clicked once in a user’s lifetime.
-
emailUniqueUnsubscribeRate: Decimal!¶ The percent of recipients that have unsubscribers (unique) over the number of confirmed to be deliveries.
-
emailUniqueClicksByCountry: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times an email was clicked once in a user’s lifetime broken out by ISO-2 country code
-
emailUniqueOpensByCountry: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times an email is opened by a user in its lifetime, broken out by ISO-2 country code
-
emailUniqueClicksByDeviceType: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times a link in an email was clicked once in a user’s lifetime, broken out by device type One of ‘pc’, ‘mobile’, ‘tablet’, ‘other’.
-
emailUniqueOpensByDeviceType: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Number of times an email is opened by a user in its lifetime, broken out by device type One of ‘pc’, ‘mobile’, ‘tablet’, ‘other’.
-
emailUniqueClicksByXpathUrl: JSON¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Unique clicks by xpath;url present in an email message The key <xpath>;<url or macro> consists in 2 parts: 1. A XPath locator to the individual element that was clicked in the email message, based on a HTML5-compliant tree. 2. URL or macro: either a static URL that was clicked present in the email template or, the macro used to generate the URL. Eg.: {{product.url}}. Useful to identify links generated for the same intent, but it might show differently for emailed contacts.
In the future we may break this out to seperate metrics
-
smsSentUnconfirmed: Decimal!¶ Total number of SMS messages that were sent, but still unconfirmed on their delivery.
-
smsSentDelivered: Decimal!¶ Total number of SMS messages that were delivered (and confirmed by the recipient)
-
smsSentUndelivered: Decimal!¶ Total number of SMS messages that were marked as undelivered. This can happen for many reasons including carrier content filtering and the availability of the destination handset.
-
smsSentFailed: Decimal!¶ Total number of SMS messages that were considered as failed. This can happen for various reasons including queue overflows, Account suspensions and media errors.
-
smsUnsubscribers: Decimal!¶ Total number of recipients that responded to the message with a request to unsubscribe them.
-
videoCompletionRate: Decimal¶ Video completion rate
Video Completion Rate (x) = Video Viewed To 100% / Video Impressions
-
frequency: Decimal!¶ Number of ads seen per day by reached users
Frequency = total impressions/reached users
-
araViewThroughs: Decimal¶ A goal completion that happens after someone views your ad, but does not click. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araClickThroughs: Decimal¶ A goal completion that happens after someone clicks your ad. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araViewThroughsVariance: Decimal¶ Variance of the view-through conversions. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araClickThroughsVariance: Decimal¶ Variance of the click-through conversions. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araViewRevenueMin: Decimal¶ Lower bound on total earnings when someone views your ad and converts. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araViewRevenueMax: Decimal¶ Upper bound on total earnings when someone views your ad and converts. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araClickRevenueMin: Decimal¶ Lower bound on total earnings when someone clicks your ad and converts. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
araClickRevenueMax: Decimal¶ Upper bound on total earnings when someone clicks your ad and converts. Reported via the aggregate Attribution Reporting API for cookieless browsers.
-
siteBounceRate: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteNewVisitors: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteEngaged: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteEngagedNewVisitors: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
siteAddToCart: Decimal¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
-
customMetric(formula: String): Decimal!¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Usage: - Operators: ‘+’, ‘-‘, ‘*’, ‘/’ and parentheses () are valid Requires formula to have space-seperated operand and operators.
e.g. costPerImpression: customMetric(formula: “cost / impressions”)
Arguments:
-
-
MetricResult¶ Groups reporting metric data in summary and by date format.
Fields:
-
Organization¶ Fields:
-
advertisables: [Advertisable!]!¶ Advertisables for the current organization.
-
metricsTotal: MetricAggregateResult¶ Provides aggregation for any metrics in the current and child nodes.
Note that this will not load the metrics by itself, instead it aggregates loaded metrics fields in its scope.
For details see the documentation of MetricAggregateResult.
-
-
OrganizationGroupData¶ Fields:
-
OrganizationQuery¶ Fields:
-
byEID(organization: String!): Organization¶ Obtain an Organization by its unique identifier (EID).
Arguments:
-
byEIDs(eids: [String!]!): [Organization]!¶ Obtain a list of Organizations by their unique identifiers (EID).
Arguments:
-
current: Organization¶ Obtain the Organization the current user is part of.
-
metricsTotal: MetricAggregateResult¶ Provides aggregation for any metrics in the current and child nodes.
Note that this will not load the metrics by itself, instead it aggregates loaded metrics fields in its scope.
For details see the documentation of MetricAggregateResult.
-
-
Placement¶ Contains reporting metric data for attributions, deliveries
by placement.
Fields:
-
conversions: Decimal!¶ Conversions Total. Conversions (count) = View Conversions + Click Conversions
-
clickThroughs: Decimal!¶ Click-through conversion (CTC). A goal completion that happens after someone clicks your ad.
-
viewThroughs: Decimal!¶ View-through conversion (VTC). A goal completion that happens after someone views your ad, but does not click.
-
clickRevenue: Decimal!¶ Click-Attributed Revenue. Total earnings when someone clicks your ad and converts.
-
viewRevenue: Decimal!¶ View-Attributed Revenue. Total earnings when someone views your ad and converts.
-
ctr: Decimal!¶ Click-through rate. The percentage of ad serves that were clicked.
CTR (%) = Clicks / Impression * 100
-
cpm: Decimal!¶ Cost per mille. Cost per one thousand ad serves.
CPM ($) = Spend / Impressions * 1000
-
cpa: Decimal!¶ Cost per acquisition. Your average spend per conversion.
CPA ($) = Spend / Conversions
-
clickCPA: Decimal!¶ Cost-per-click acquisition. Your average spend for a conversion that happens after someone clicks your ad.
Click CPA ($) = Spend / Click Conversions
-
viewCPA: Decimal!¶ Cost-per-view acquisition: Your average spend for a conversion that happens after someone views your ad.
View CPA ($) = Cost / View Throughs
-
averageOrderValue: Decimal!¶ Average Order Value Average revenue per attributed conversion.
Average Order Value ($) = Attributed Revenue / Conversions
-
ctcRate: Decimal!¶ Click-through conversion rate. The percentage of clicks that resulted in a click-through conversion.
CTC Rate (%) = Click Conversions / Clicks * 100
-
vtcRate: Decimal!¶ View-through conversion rate: The percentage of impressions that resulted in a view-through conversion.
VTC Rate (%) = View Throughs / Impressions * 100
-
roas: Decimal!¶ Return on advertising spend: Your profit per dollar spent on ads.
ROAS (x) = (Click Revenue + View Revenue) / Cost
-
clickROAS: Decimal!¶ Click return on advertising spend: Your profit per dollar spent, generated from conversions that happen after someone clicks your ad.
Click ROAS (x) = Click Revenue / Cost
-
-
PlacementResult¶ Groups reporting metric data in summary and by date format.
Fields:
-
Query¶ Root element for a Reporting API GraphQL’s query.
Fields:
-
flags(enableKlaviyoFlowCampaigns: Boolean!, enableUniversalCampaigns: Boolean!, enableProxyCampaigns: Boolean!, enablePinterestCampaigns: Boolean!, enableTikTokCampaigns: Boolean!, enableGoogleSearchCampaigns: Boolean!, enableMultiChannelCampaigns: Boolean!, enableConnectedTVCampaigns: Boolean!, enableSMSCampaigns: Boolean!, listOnlyInventoryForVoltronStrategies: Boolean!, useExperimentalProxyCampaigns: Boolean!, includeExpiredData: Boolean!, useAdrollAdsStatusOnlyEndpoint: Boolean!): Boolean!¶ Setup global request flags
Arguments:
-
enableKlaviyoFlowCampaigns: Boolean!¶ Includes Flows for Klaviyo Email campaigns. The enableMultiChannelCampaigns flag must be enabled as well. For internal use only.
- Default
false
-
enableUniversalCampaigns: Boolean!¶ Enables or disables fetching Universal campaigns for advertisable and organization queries and filtering of inventory campaigns. This does not affect queries using EIDs.
Note: The default value for this flag will be changed to true once universal campaign support is considered stable.
- Default
false
-
enableProxyCampaigns: Boolean!¶ Enables or disables fetching Proxy campaigns for advertisable and organization queries and filtering of inventory campaigns.
This does not affect queries using EIDs.
- Default
false
-
enablePinterestCampaigns: Boolean!¶ Include experimental Pinterest Connected Ads campaigns. For internal use only.
- Default
false
-
enableTikTokCampaigns: Boolean!¶ Include experimental TikTok Connected Ads campaigns. For internal use only.
- Default
false
-
enableGoogleSearchCampaigns: Boolean!¶ Include experimental Google Search Connected Ads campaigns. For internal use only.
- Default
false
-
enableMultiChannelCampaigns: Boolean!¶ Include experimental MultiChannel Connected Ads campaigns. For internal use only.
- Default
false
-
enableConnectedTVCampaigns: Boolean!¶ Include experimental Connected TV Ads campaigns.
- Default
false
-
enableSMSCampaigns: Boolean!¶ Include experimental SMS campaigns. For internal use only.
- Default
false
-
listOnlyInventoryForVoltronStrategies: Boolean!¶ When enableProxyCampaigns or enableUniversalCampaigns is enabled,
return just the inventory campaigns filtering out the top-level proxy or UC campaigns. Does not apply to Playbooks.
This flag is used by reports to avoid duplicating metric numbers when both the top-level and inventory campaigns are included in the results.
- Default
false
-
useExperimentalProxyCampaigns: Boolean!¶ For internal use only. Don’t use it, it will disappear soon with no warning.
- Default
false
-
-
requestId: String!¶ Unique ID for this request. This can be used to retrieve debugging and profiling info for the request.
-
organization: OrganizationQuery!¶ Root for querying Organizations.
-
advertisable: AdvertisableQuery!¶ Root for querying Advertisables.
-
campaign: CampaignQuery!¶ Root for querying Campaigns.
-
adgroup: AdgroupQuery!¶ Root for querying Adgroups.
-
automation: AutomationQuery!¶ Root for querying Automation.
-
email: EmailQuery!¶ Root for querying Emails.
-
smsMessage: SMSMessageQuery!¶ [ALPHA] This GraphQL field is currently under development and QA, please hold off from using it. It might change or be removed in the future, within this API’s version.
Root for querying SMSMessages.
-
segment: SegmentQuery¶ Use the child Audiences of Campaigns and AdGroups instead.
Root for querying Segments.
-
group: GroupQuery¶ [BETA] This GraphQL node is currently under development. Avoid its use in production until it has passed some thorough QA.
Provides custom grouping in queries.
-
metricsTotal: MetricAggregateResult¶ Provides aggregation for any metrics in the current and child nodes.
Note that this will not load the metrics by itself, instead it aggregates loaded metrics fields in its scope.
For details see the documentation of MetricAggregateResult.
-
accountMetrics: FieldAccountMetricsSummary¶ [ALPHA] This GraphQL node is currently under development Avoid its use in production until it has passed some thorough QA.
Provides metrics per account for a list of campaigns and an advertisable, over a specific date range. It will return the metrics for the top 1000 accounts by spend.
-
log: [LogItem!]!¶ [WARNING] Log lines are intended for internal analysis and debugging. They are not available for external developers to consume.
Return log entries for the current query.
-
-
SMSMessage¶ Fields:
-
sequencePosition: Int!¶ The position of this SMS Message in the campaign’s sequence. (0 for the first message).
-
actualStatus: JSON¶ The effective status of the campaign. Details the reasons why it is not running, if applicable.
-
actualStatusString: String!¶ Minimal string representation of the actual status. One of ‘running’, ‘notRunning’, b’paused’, ‘draft’, ‘suspended’ or ‘deleted’.
-
advertisable: String!¶ Advertisable for this SMSMessage.
[WARNING] The advertisable information is not usually available, so querying this will cause an additional request to be made.
-
metrics(start: Date, end: Date, pastDays: Int, currency: String, duration: Int): MetricResult!¶ Metrics for the entity.
Arguments:
-
start: Date¶ The start date for the metrics period (inclusive). The date range will be: [start, end)
-
-
metricsTotal: MetricAggregateResult¶ Provides aggregation for any metrics in the current and child nodes.
Note that this will not load the metrics by itself, instead it aggregates loaded metrics fields in its scope.
For details see the documentation of MetricAggregateResult.
-
-
SMSMessageGroupData¶ Fields:
-
sequencePosition: Int!¶ The position of this SMS Message in the campaign’s sequence. (0 for the first message).
-
actualStatus: JSON¶ The effective status of the campaign. Details the reasons why it is not running, if applicable.
-
-
SMSMessageQuery¶ Fields:
-
byEID(smsMessage: String!): SMSMessage¶ Resolves an SMSMessage by its EID.
Arguments:
-
byEIDs(eids: [String!]!): [SMSMessage]!¶ Resolves multiple SMSMessages by their EID.
Arguments:
-
byAdvertisable(advertisable: String!): [SMSMessage]!¶ Resolves all SMSMessages for an Advertisable.
Arguments:
-
byCampaign(campaign: String!): [SMSMessage]!¶ Resolves all SMSMessages for a Campaign.
Arguments:
-
metricsTotal: MetricAggregateResult¶ Provides aggregation for any metrics in the current and child nodes.
Note that this will not load the metrics by itself, instead it aggregates loaded metrics fields in its scope.
For details see the documentation of MetricAggregateResult.
-
-
Segment¶ Fields:
Tags explicitly assigned to the segment.
-
SegmentGroupData¶ Fields:
Tags explicitly assigned to the segment.
-
SegmentQuery¶ Fields:
-
byEID(segment: String!): Segment¶ [WARNING] Fetching Segments directly through this operation will ignore the overrides and state provided by its relationship to an AdGroup. For a complete state fetch segments as children of Campaigns or AdGroups.
Arguments:
-
byEIDs(eids: [String!]!): [Segment]!¶ [WARNING] Fetching Segments directly through this operation will ignore the overrides and state provided by its relationship to an AdGroup. For a complete state fetch segments as children of Campaigns or AdGroups.
Arguments:
-
byAdvertisable(advertisable: String!, isActive: Boolean, isConversion: Boolean): [Segment]!¶ [WARNING] Fetching Segments directly through this operation will ignore the overrides and state provided by its relationship to an AdGroup. For a complete state fetch segments as children of Campaigns or AdGroups.
Arguments:
-
-
User¶ Provides information about a logged user.
Fields:
-
UtmBasedConversionsForAdvertisable¶ Contains advertisable-level UTM-based conversions data.
Fields:
-
campaigns: [UtmBasedConversionsForCampaign!]!¶ Campaign level data.
-
Scalars¶
Scalars represent primitive types and cannot have fields.
Descriptions¶
-
Boolean¶ The Boolean scalar type represents true or false.
-
Date¶ Scalar type for dates.
-
DateTime¶ Scalar type for dates with time information.
-
Decimal¶ Scalar type for decimal numeric values.
-
Float¶ The Float scalar type represents signed double‐precision fractional values as specified by IEEE 754.
-
ID¶ The ID scalar type represents a unique identifier, often used to refetch an object or as the key for a cache.
-
Int¶ The Int scalar type represents a signed 32‐bit numeric non‐fractional value.
-
JSON¶ Scalar type for arbitrary JSON data.
-
String¶ The String scalar type represents textual data, represented as UTF‐8 character sequences.