AdRoll 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.

Descriptions

Fields:

eid: String!

EID of the ad.

adFormatID: Int!

The id of the corresponding ad format in the AdRoll system.

adFormat: String!

Format string. i.e. ‘300 wide x 250 high’.

adFormatName: String!

Format string. i.e. ‘300x250’.

advertisable: String!

The EID of the advertisable to which this ad belongs.

adgroups: JSON!

The list of adgroup EIDs that this ad belongs to.

hasFutureCampaigns: Boolean!

Whether or not this ad has the possiblity of serving based on the adgroups and campaigns in which it inhabits.

destinationURL: String!

The URL that the browser will navigate to when this ad is clicked.

headline: String!

For Facebook ads, the text to be displayed as the ad’s headline.

body: String!

For Facebook ads, the text to be displayed as the ad’s body.

message: String!

For Facebook Newsfeed ads, the text to be displayed as the ad’s message.

callToAction: String!

Facebook call to action constant.

isActive: Boolean!

Whether or not this ad is currently active.

name: String!

The name of this ad.

src: String!

This ad’s creative’s source URL.

status: String!

One of ‘approved’, ‘paused’, ‘review’, ‘draft’, ‘rejected’ 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’.

type: String!

The ad type: ‘liquid’, ‘image’, ‘flash’ or ‘ad_network’.

height: Int!

The height in pixels of this ad’s creative.

width: Int!

The width in pixels of this ad’s creative.

createdDate: DateTime

The date this ad was created.

updatedDate: DateTime

The date this ad was last updated.

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.

originalAd: String!

The EID of the ad that was edited to create this ad.

isOutlined: Boolean!

Whether or not an outline has been applied to the ad to satisfy network compliancy.

outlineColor: String!

Hexadecimal color code corresponding to the outline of an ad.

validClicktag: Boolean!

If the ad is in flash format, this is the flag showing whether or not the clickTAG is compliant.

Facebook permalink if applicable.

Instagram permalink if applicable.

utmSource: String!

UTM Source Parameter from this Ad’s destination.

utmMedium: String!

UTM Medium Parameter from this Ad’s destination.

utmCampaign: String!

UTM Campaign Parameter from this Ad’s destination.

utmTerm: String!

UTM Term Parameter from this Ad’s destination.

utmContent: String!

UTM Content Parameter from this Ad’s destination.

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.

adrollEID: String!

The adroll EID for prospecting ads.

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.

inAdgroupStatus: String!

The status of the AdGroupAd relationship, 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(duration: Int, start: Date, end: Date, pastDays: Int, currency: String): MetricResult!
Metrics for the Ad.

Arguments:

duration: Int
[DEPRECATED] Unused
Default:30
start: Date

The start date for the metrics period (inclusive). The date range will be: [start, end)

end: Date

The end date for the metrics period (exclusive). 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
currency: String
Currency to load the metrics in.
Default:“USD”
conversions(duration: Int, start: Date, end: Date, pastDays: Int, currency: String): ConversionResult!
Metrics for the Ad broken down by conversion audiences.

Arguments:

duration: Int
[DEPRECATED] Unused
Default:30
start: Date

The start date for the metrics period (inclusive). The date range will be: [start, end)

end: Date

The end date for the metrics period (exclusive). 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
currency: String
Currency to load the metrics in.
Default:“USD”
AdGroupData

Fields:

eid: String!

EID of the ad.

adFormatID: Int!

The id of the corresponding ad format in the AdRoll system.

adFormat: String!

Format string. i.e. ‘300 wide x 250 high’.

adFormatName: String!

Format string. i.e. ‘300x250’.

advertisable: String!

The EID of the advertisable to which this ad belongs.

adgroups: JSON!

The list of adgroup EIDs that this ad belongs to.

hasFutureCampaigns: Boolean!

Whether or not this ad has the possiblity of serving based on the adgroups and campaigns in which it inhabits.

destinationURL: String!

The URL that the browser will navigate to when this ad is clicked.

headline: String!

For Facebook ads, the text to be displayed as the ad’s headline.

body: String!

For Facebook ads, the text to be displayed as the ad’s body.

message: String!

For Facebook Newsfeed ads, the text to be displayed as the ad’s message.

callToAction: String!

Facebook call to action constant.

isActive: Boolean!

Whether or not this ad is currently active.

name: String!

The name of this ad.

src: String!

This ad’s creative’s source URL.

status: String!

One of ‘approved’, ‘paused’, ‘review’, ‘draft’, ‘rejected’ 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’.

type: String!

The ad type: ‘liquid’, ‘image’, ‘flash’ or ‘ad_network’.

height: Int!

The height in pixels of this ad’s creative.

width: Int!

The width in pixels of this ad’s creative.

createdDate: DateTime

The date this ad was created.

updatedDate: DateTime

The date this ad was last updated.

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.

originalAd: String!

The EID of the ad that was edited to create this ad.

isOutlined: Boolean!

Whether or not an outline has been applied to the ad to satisfy network compliancy.

outlineColor: String!

Hexadecimal color code corresponding to the outline of an ad.

validClicktag: Boolean!

If the ad is in flash format, this is the flag showing whether or not the clickTAG is compliant.

Facebook permalink if applicable.

Instagram permalink if applicable.

utmSource: String!

UTM Source Parameter from this Ad’s destination.

utmMedium: String!

UTM Medium Parameter from this Ad’s destination.

utmCampaign: String!

UTM Campaign Parameter from this Ad’s destination.

utmTerm: String!

UTM Term Parameter from this Ad’s destination.

utmContent: String!

UTM Content Parameter from this Ad’s destination.

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.

adrollEID: String!

The adroll EID for prospecting ads.

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.

inAdgroupStatus: String!

The status of the AdGroupAd relationship, 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.

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:

ad: String!

EID of the Ad.

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:

eids: [String!]!

List of Ad EIDs.

byAdvertisable(advertisable: String!, isActive: Boolean, statuses: [String!], types: [String!], width: Int, height: Int): [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:

advertisable: String!

The EID of the advertisable whose ads are to be fetched

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
byAdgroup(adgroup: String!, isActive: Boolean, statuses: [String!], types: [String!], width: Int, height: Int): [Ad]!

Resolves all Ads for an AdGroup.

Arguments:

adgroup: String!

The EID of the Adgroup whose ads are to be fetched

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
metricsTotal: MetricAggregateResult!

[ALPHA] This GraphQL node 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.

For documentation see the root metricsTotal field in Query.

Adgroup

Fields:

eid: String!

The EID of the adgroup.

adOptimization: String!

The strategy used to optimize ads when multiple ads fit a single ad space.

campaign: String!

The EID of the campaign that this adgroup is associated with.

isActive: Boolean!

Whether or not this adgroup is currently active.

name: String!

The name of this adgroup.

status: String!

One of ‘approved’, ‘paused’, ‘draft’, ‘rejected’ 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’.

createdDate: DateTime

The date this adgroup was created.

updatedDate: DateTime

The date this adgroup was last updated.

flightTimezone: String!

The timezone preference of all flights of this adgroup.

flights: JSON!

Scheduled flight periods when ads will be served. Null if there is no limitation.

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.

kpiMetric: String!

Metric being targeted by the campaign’s bid strategy.

adType: String!

Ad type restriction for this ad group. Empty if there is no explicit restriction. Currently one of “static” or “dynamic”.

ads(isActive: Boolean, statuses: [String!], types: [String!], width: Int, height: Int): [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
audiences(includeInactive: Boolean): [Audience]!

Audiences for this Adgroup

Arguments:

includeInactive: Boolean

True to return also inactive audiences (those that have been deleted). By default only active audiences are included.

Default:false
metrics(duration: Int, start: Date, end: Date, pastDays: Int, currency: String): MetricResult!

Metrics for the Adgroup.

Arguments:

duration: Int
[DEPRECATED] Unused.
Default:30
start: Date

The start date for the metrics period (inclusive). The date range will be: [start, end)

end: Date

The end date for the metrics period (exclusive). 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
currency: String
Currency to load the metrics in.
Default:“USD”
metricsTotal: MetricAggregateResult!

[ALPHA] This GraphQL node 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.

For documentation see the root metricsTotal field in Query.

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)

end: Date

The end date for the metrics period (exclusive). 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
currency: String
Currency to load the metrics in.
Default:“USD”
conversions(duration: Int, start: Date, end: Date, pastDays: Int, currency: String): ConversionResult!
Metrics for the AdGroup broken down by conversion audiences.

Arguments:

duration: Int
[DEPRECATED] Unused.
Default:30
start: Date

The start date for the metrics period (inclusive). The date range will be: [start, end)

end: Date

The end date for the metrics period (exclusive). 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
currency: String
Currency to load the metrics in.
Default:“USD”
AdgroupGroupData

Fields:

eid: String!

The EID of the adgroup.

adOptimization: String!

The strategy used to optimize ads when multiple ads fit a single ad space.

campaign: String!

The EID of the campaign that this adgroup is associated with.

isActive: Boolean!

Whether or not this adgroup is currently active.

name: String!

The name of this adgroup.

status: String!

One of ‘approved’, ‘paused’, ‘draft’, ‘rejected’ 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’.

createdDate: DateTime

The date this adgroup was created.

updatedDate: DateTime

The date this adgroup was last updated.

flightTimezone: String!

The timezone preference of all flights of this adgroup.

flights: JSON!

Scheduled flight periods when ads will be served. Null if there is no limitation.

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.

kpiMetric: String!

Metric being targeted by the campaign’s bid strategy.

adType: String!

Ad type restriction for this ad group. Empty if there is no explicit restriction. Currently one of “static” or “dynamic”.

AdgroupQuery

Fields:

byEID(adgroup: String!): Adgroup

Resolves an Adgroup by its EID.

Arguments:

adgroup: String!

EID of the Adgroup.

byEIDs(eids: [String!]!): [Adgroup]!

Resolves a Adgroups by their EIDs.

Arguments:

eids: [String!]!

List of Campaign EIDs.

byAdvertisable(advertisable: String!): [Adgroup]!

Resolves all Adgroups for a Advertisable.

Arguments:

advertisable: String!

The EID of the advertisable whose adgroups are to be fetched

byCampaign(campaign: String!): [Adgroup]!

Resolves all Adgroups for a Campaign.

Arguments:

campaign: String!

EID of the campaign.

metricsTotal: MetricAggregateResult!

[ALPHA] This GraphQL node 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.

For documentation see the root metricsTotal field in Query.

Advertisable

Fields:

eid: String!

EID of the advertisable.

isActive: Boolean!

Whether or not the advertisable is currently active.

isB2B: Boolean!

Whether or not the advertisable is a B2B customer. Deprecated field: use businessUnit instead.

businessUnit: String!

The business unit this Advertisable has signed up for.

isAbmCustomer: Boolean!

Whether or not the advertisable is an ABM customer.

name: String!

The name of the advertisable.

organization: String!

The EID of this advertisable’s organization.

status: String!

The status of the advertisable. One of [‘admin_review’, ‘approved’, ‘rejected’].

url: String!

The advertisable’s URL.

currency: String!

The currency code (ISO-4217) use by the advertisable’s account.

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.

createdDate: DateTime

The date this advertisable was created.

revshareViewPercent: Decimal!

[Deprecated] Attribution models now determine the revenue share attributed on view through conversions.

revshareClickPercent: Decimal!

[Deprecated] Attribution models now determine the revenue share attributed on click through conversions.

campaigns(isActive: Boolean, statuses: [String!], blacklistStatuses: [String!], types: [String!], channels: [String!], sources: [String!], excludeTypes: [String!], excludeChannels: [String!], excludeSources: [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:[ ]
blacklistStatuses: [String!]
Only campaigns whose status is not one of these will be returned (Optional; default: None)
Default:[ ]
types: [String!]
Only campaigns that match one of these 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:[ ]
excludeTypes: [String!]
Exclude campaigns that match one of the given 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:[ ]
adgroups: [Adgroup]!

[ALPHA] This GraphQL node 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.

Adgroups for this Advertisable.

emails: [Email]!

[ALPHA] This GraphQL node 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.

Emails for this Advertisable.

ads(isActive: Boolean, statuses: [String!], types: [String!], width: Int, height: Int): [Ad]!

[ALPHA] This GraphQL node 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.

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
segments(isConversion: Boolean): [Segment]!

[ALPHA] This GraphQL node 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.

Segments for this Advertisable.

Arguments:

isConversion: Boolean

If True, only conversion segments will be returned (Optional; default: False).

metrics(duration: Int, start: Date, end: Date, pastDays: Int, currency: String): AdvertisableMetricResult!

Metrics for the Advertisable.

Arguments:

duration: Int
[DEPRECATED] Unused.
Default:30
start: Date

The start date for the metrics period (inclusive). The date range will be: [start, end)

end: Date

The end date for the metrics period (exclusive). 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
currency: String
Currency to load the metrics in.
Default:“USD”
metricsTotal: MetricAggregateResult!

[ALPHA] This GraphQL node 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.

For documentation see the root metricsTotal field in Query.

conversions(duration: Int, start: Date, end: Date, pastDays: Int, currency: String): ConversionResult!
Metrics for the Ad broken down by conversion audiences.

Arguments:

duration: Int
[DEPRECATED] Unused.
Default:30
start: Date

The start date for the metrics period (inclusive). The date range will be: [start, end)

end: Date

The end date for the metrics period (exclusive). 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
currency: String
Currency to load the metrics in.
Default:“USD”
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.

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)

pastDays: Int

Alternative to start/end parameters with less precedence. The date range will be: [today_utc - pastDays, today_utc)

Default:0
currency: String

Currency to load the conversions in.

Default:“USD”
AdvertisableGroupData

Fields:

eid: String!

EID of the advertisable.

isActive: Boolean!

Whether or not the advertisable is currently active.

isB2B: Boolean!

Whether or not the advertisable is a B2B customer. Deprecated field: use businessUnit instead.

businessUnit: String!

The business unit this Advertisable has signed up for.

isAbmCustomer: Boolean!

Whether or not the advertisable is an ABM customer.

name: String!

The name of the advertisable.

organization: String!

The EID of this advertisable’s organization.

status: String!

The status of the advertisable. One of [‘admin_review’, ‘approved’, ‘rejected’].

url: String!

The advertisable’s URL.

currency: String!

The currency code (ISO-4217) use by the advertisable’s account.

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.

createdDate: DateTime

The date this advertisable was created.

revshareViewPercent: Decimal!

[Deprecated] Attribution models now determine the revenue share attributed on view through conversions.

revshareClickPercent: Decimal!

[Deprecated] Attribution models now determine the revenue share attributed on click through conversions.

AdvertisableMetricResult
Groups reporting metric data in summary and by date format.

Fields:

summary: Metric!

Summarises the reporting data for the given date range.

byDate: [Metric!]!

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:

advertisable: String!

Advertisable EID.

byEIDs(eids: [String!]!): [Advertisable]!
Obtain a list of Advertisables by their unique identifiers (EID).

Arguments:

eids: [String!]!

List of Advertisable EIDs.

byOrganization(organization: String!): [Advertisable]!
Obtain a list Advertisables owned by an Organization.

Arguments:

organization: String!

Organization EID.

metricsTotal: MetricAggregateResult!

[ALPHA] This GraphQL node 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.

For documentation see the root metricsTotal field in Query.

forUser: [Advertisable]!

All the advertisables for the current user.

Audience

Fields:

eid: String!

The EID of the audience in use.

segmentEID: String!

The EID of the segment describing this audience.

advertisable: String!

The Advertisable for the segment.

campaign: String!

The Campaign for the segment.

name: String!

The Audience Name.

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.

description: JSON!

Pieces to build the Audience’s description formatted following the type.

duration: Int!

The duration of the Audience, in days.

isActive: Boolean!

False if this is segment has been deleted.

inclusion: Boolean!

Is the segment an inclusion segment.

isConversion: Boolean!

True if this is a conversion audience.

conversionValue: Float!

The value of a conversion from this segment.

currency: String!

The value of a conversion from this segment. Default to the Advertisable’s currency.

createdDate: Date

Date of creation.

metrics(start: Date, end: Date, pastDays: Int): AudienceMetricResult!

[ALPHA] This GraphQL node 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 for the audience visitors.

Arguments:

start: Date

The start date for the metrics period (inclusive). The date range will be: [start, end)

end: Date

The end date for the metrics period (exclusive). 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
AudienceGroupData

Fields:

eid: String!

The EID of the audience in use.

segmentEID: String!

The EID of the segment describing this audience.

advertisable: String!

The Advertisable for the segment.

campaign: String!

The Campaign for the segment.

name: String!

The Audience Name.

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.

description: JSON!

Pieces to build the Audience’s description formatted following the type.

duration: Int!

The duration of the Audience, in days.

isActive: Boolean!

False if this is segment has been deleted.

inclusion: Boolean!

Is the segment an inclusion segment.

isConversion: Boolean!

True if this is a conversion audience.

conversionValue: Float!

The value of a conversion from this segment.

currency: String!

The value of a conversion from this segment. Default to the Advertisable’s currency.

createdDate: Date

Date of creation.

AudienceMetric

[ALPHA] This GraphQL node 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.

Groups reporting metric audience data in summary and by date format.

Fields:

audienceSizeCurrent: Decimal!

[ALPHA] This GraphQL node 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.

The number of unique visitors in a segment based on the segment’s duration in days. This is the total number of visitors who can be retargeted using this segment.

audienceSizeNew: Decimal!

[ALPHA] This GraphQL node 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.

audienceSizeTotal: Decimal!

[ALPHA] This GraphQL node 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.

audienceSizeInDateRange: Decimal!

[ALPHA] This GraphQL node 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.

AudienceMetricResult

[ALPHA] This GraphQL node 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.

Groups reporting metric audience data in summary and by date format.

Fields:

summary: AudienceMetric!

Summarises the reporting data for the given date range and duration.

Campaign

Fields:

eid: String!

EID of the campaign.

advertisable: String!

EID of the advertisable to which this campaign belongs.

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...).

budgetStartDate: DateTime

The start date of a lifetime budget.

budgetEndDate: DateTime

The end date of a lifetime budget.

budgetSettingsString: String!

Serialized budget settings as a string. “budgetType,budgetStartDate,budgetEndDate,budgetGoal”

createdDate: DateTime

The date this campaign was created.

cpc: Decimal!

The CPC for this campaign.

cpm: Decimal!

The CPM for this campaign.

maxCpm: Decimal!

The maximum CPM for this campaign.

name: String!

The name of this campaign.

startDate: DateTime

The day the campaign will start.

endDate: DateTime

The day the campaign will end, exclusive.

status: String!

The status of the campaign. One of ‘running’, ‘ended’, ‘paused’, ‘review’, ‘draft’, ‘rejected’ 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’.

updatedDate: DateTime

The date this campaign was last updated.

channel: String!

Campaign channel: one of ‘email’, ‘social’ or ‘web’

source: String!

The service responsible for the creation of this campaign.

currency: String!

ISO-4217 currency code for the given amount.

type: String!

Type for the campaign. One of “prospecting”, “blended” or “retargeting”.

abmType: String!

Type of ABM campaign. Empty string if this is not an ABM 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.

kpiMetric: String!

Metric being targeted by the campaign’s bid strategy.

spendLimitUntil: DateTime

SpendLimitUntil

spendLimitUntilReason: String!

SpendLimitUntilReason

adgroups: [Adgroup]!

Adgroups for this Campaign.

emails: [Email]!

Emails for this Campaign

audiences(includeInactive: Boolean): [Audience]!

Audiences for this Campaign.

Arguments:

includeInactive: Boolean

True to return also inactive audiences (those that have been deleted). By default only active audiences are included.

Default:false
metrics(duration: Int, start: Date, end: Date, pastDays: Int, currency: String): MetricResult!
Metrics for the campaign.

Arguments:

duration: Int
[DEPRECATED] Unused.
Default:30
start: Date

The start date for the metrics period (inclusive). The date range will be: [start, end)

end: Date

The end date for the metrics period (exclusive). 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
currency: String
Currency to load the metrics in.
Default:“USD”
metricsTotal: MetricAggregateResult!

[ALPHA] This GraphQL node 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.

For documentation see the root metricsTotal field in Query.

conversions(duration: Int, start: Date, end: Date, pastDays: Int, currency: String): ConversionResult!
Metrics for the Ad broken down by conversion audiences.

Arguments:

duration: Int
[DEPRECATED] Unused.
Default:30
start: Date

The start date for the metrics period (inclusive). The date range will be: [start, end)

end: Date

The end date for the metrics period (exclusive). 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
currency: String
Currency to load the metrics in.
Default:“USD”
CampaignGroupData

Fields:

eid: String!

EID of the campaign.

advertisable: String!

EID of the advertisable to which this campaign belongs.

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...).

budgetStartDate: DateTime

The start date of a lifetime budget.

budgetEndDate: DateTime

The end date of a lifetime budget.

budgetSettingsString: String!

Serialized budget settings as a string. “budgetType,budgetStartDate,budgetEndDate,budgetGoal”

createdDate: DateTime

The date this campaign was created.

cpc: Decimal!

The CPC for this campaign.

cpm: Decimal!

The CPM for this campaign.

maxCpm: Decimal!

The maximum CPM for this campaign.

name: String!

The name of this campaign.

startDate: DateTime

The day the campaign will start.

endDate: DateTime

The day the campaign will end, exclusive.

status: String!

The status of the campaign. One of ‘running’, ‘ended’, ‘paused’, ‘review’, ‘draft’, ‘rejected’ 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’.

updatedDate: DateTime

The date this campaign was last updated.

channel: String!

Campaign channel: one of ‘email’, ‘social’ or ‘web’

source: String!

The service responsible for the creation of this campaign.

currency: String!

ISO-4217 currency code for the given amount.

type: String!

Type for the campaign. One of “prospecting”, “blended” or “retargeting”.

abmType: String!

Type of ABM campaign. Empty string if this is not an ABM 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.

kpiMetric: String!

Metric being targeted by the campaign’s bid strategy.

spendLimitUntil: DateTime

SpendLimitUntil

spendLimitUntilReason: String!

SpendLimitUntilReason

CampaignQuery

Fields:

byEID(campaign: String!): Campaign
Obtain a campaign by its unique identifier (EID).

Arguments:

campaign: String!

EID of the campaign.

byEIDs(eids: [String!]!): [Campaign]!
Obtain a list of campaigns by their unique identifiers (EID).

Arguments:

eids: [String!]!

List of campaign EIDs.

byAdvertisable(advertisable: String!, isActive: Boolean, statuses: [String!], blacklistStatuses: [String!], types: [String!], channels: [String!], sources: [String!], excludeTypes: [String!], excludeChannels: [String!], excludeSources: [String!]): [Campaign]!
Obtain a list advertisables owned by an Advertisable.

Arguments:

advertisable: String!

The EID of the advertisable whose campaigns are to be fetched

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:[ ]
blacklistStatuses: [String!]
Only campaigns whose status is not one of these will be returned (Optional; default: None)
Default:[ ]
types: [String!]
Only campaigns that match one of these 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:[ ]
excludeTypes: [String!]
Exclude campaigns that match one of the given 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!], blacklistStatuses: [String!], types: [String!], channels: [String!], sources: [String!], excludeTypes: [String!], excludeChannels: [String!], excludeSources: [String!]): [Campaign]!
Obtain a list advertisables owned by an Organization.

Arguments:

organization: String!

The EID of the organization whose campaigns are to be fetched

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:[ ]
blacklistStatuses: [String!]
Only campaigns whose status is not one of these will be returned (Optional; default: None)
Default:[ ]
types: [String!]
Only campaigns that match one of these 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:[ ]
excludeTypes: [String!]
Exclude campaigns that match one of the given 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:[ ]
metricsTotal: MetricAggregateResult!

[ALPHA] This GraphQL node 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.

For documentation see the root metricsTotal field in Query.

ConversionResult

Groups reporting metric data for conversions.

Fields:

byAudience: [Conversions!]!

Summarises by conversion the reporting data for the given date range.

Conversions

Contains reporting metric data for attributions, deliveries

by audience conversion.

Fields:

audienceEID: String!

The unique identifier of the audience.

audienceName: String!

The name of the audience.

audienceDuration: Int!

The duration in days of the audience.

audienceIsActive: Boolean!

True if the audience is active.

summary: ConversionsSummary!

Summarises the reporting data for the given date range.

byDate: [ConversionsByDate!]!

Reporting data by date in the given range.

impressions: Decimal!

The sum of the number of ad impressions and the number of unique-by-session email opens collected.

clicks: Decimal!

The sum of clicks of all kinds of ads and emails.

cost: Decimal!

Cost associated to all kinds of ads and emails.

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-Attributed Revenue. Total earnings when someone views your ad and converts.

revenue: Decimal!

Revenue (amount) = View Revenue + Click Conversions

clickRevenue: Decimal!

Click-Attributed Revenue. Total earnings when someone clicks your ad and converts.

viewRevenue: Decimal!

View-through conversion (VTC). A goal completion that happens after someone views your ad, but doesn’t click.

ctr: Decimal!

Click-through rate. The percentage of ad serves that were clicked.

CTR (%) = Clicks / Impression * 100

cpc: Decimal!

Cost per click. Your average spend for one click.

CPC ($) = Spend / Clicks

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 + Opens) * 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

roi: Decimal!

[DEPRECATED] use ‘roas’ instead.

Alias for ‘roas’.

clickROI: Decimal!

[DEPRECATED] use ‘clickROAS’ instead.

Alias for ‘clickROAS’.

viewROI: Decimal!

[DEPRECATED] use ‘viewROAS’ instead.

Alias for ‘viewROAS’.

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.

ConversionsByDate

Fields:

date: Date

Reporting data by date in the given range.

impressions: Decimal!

The sum of the number of ad impressions and the number of unique-by-session email opens collected.

clicks: Decimal!

The sum of clicks of all kinds of ads and emails.

cost: Decimal!

Cost associated to all kinds of ads and emails.

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-Attributed Revenue. Total earnings when someone views your ad and converts.

revenue: Decimal!

Revenue (amount) = View Revenue + Click Conversions

clickRevenue: Decimal!

Click-Attributed Revenue. Total earnings when someone clicks your ad and converts.

viewRevenue: Decimal!

View-through conversion (VTC). A goal completion that happens after someone views your ad, but doesn’t click.

ctr: Decimal!

Click-through rate. The percentage of ad serves that were clicked.

CTR (%) = Clicks / Impression * 100

cpc: Decimal!

Cost per click. Your average spend for one click.

CPC ($) = Spend / Clicks

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 + Opens) * 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

roi: Decimal!

[DEPRECATED] use ‘roas’ instead.

Alias for ‘roas’.

clickROI: Decimal!

[DEPRECATED] use ‘clickROAS’ instead.

Alias for ‘clickROAS’.

viewROI: Decimal!

[DEPRECATED] use ‘viewROAS’ instead.

Alias for ‘viewROAS’.

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.

ConversionsSummary

Fields:

impressions: Decimal!

The sum of the number of ad impressions and the number of unique-by-session email opens collected.

clicks: Decimal!

The sum of clicks of all kinds of ads and emails.

cost: Decimal!

Cost associated to all kinds of ads and emails.

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-Attributed Revenue. Total earnings when someone views your ad and converts.

revenue: Decimal!

Revenue (amount) = View Revenue + Click Conversions

clickRevenue: Decimal!

Click-Attributed Revenue. Total earnings when someone clicks your ad and converts.

viewRevenue: Decimal!

View-through conversion (VTC). A goal completion that happens after someone views your ad, but doesn’t click.

ctr: Decimal!

Click-through rate. The percentage of ad serves that were clicked.

CTR (%) = Clicks / Impression * 100

cpc: Decimal!

Cost per click. Your average spend for one click.

CPC ($) = Spend / Clicks

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 + Opens) * 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

roi: Decimal!

[DEPRECATED] use ‘roas’ instead.

Alias for ‘roas’.

clickROI: Decimal!

[DEPRECATED] use ‘clickROAS’ instead.

Alias for ‘clickROAS’.

viewROI: Decimal!

[DEPRECATED] use ‘viewROAS’ instead.

Alias for ‘viewROAS’.

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.

Email

Fields:

eid: String!

The SendRoll e-mail EID.

campaign: String!

The EID of the AdRoll email campaign who owns this email.

sequencePosition: Int!

The position of this email in the campaign’s sequence. (0 for the first email).

subject: String!

The email’s subject.

status: String!

One of ‘running’, ‘scheduled’, ‘ended’, ‘paused’, ‘draft’ 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’, ‘draft’ or ‘deleted’.

delayHours: Int!

Delay in hours between the previous event in the drip sequence and when this email is scheduled to be sent.

createdDate: DateTime

The date this email was created.

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(duration: Int, start: Date, end: Date, pastDays: Int, currency: String): MetricResult!
Metrics for the Email.

Arguments:

duration: Int
[DEPRECATED] Unused.
Default:30
start: Date

The start date for the metrics period (inclusive). The date range will be: [start, end)

end: Date

The end date for the metrics period (exclusive). 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
currency: String
Currency to load the metrics in.
Default:“USD”
metricsTotal: MetricAggregateResult!

[ALPHA] This GraphQL node 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.

For documentation see the root metricsTotal field in Query.

EmailGroupData

Fields:

eid: String!

The SendRoll e-mail EID.

campaign: String!

The EID of the AdRoll email campaign who owns this email.

sequencePosition: Int!

The position of this email in the campaign’s sequence. (0 for the first email).

subject: String!

The email’s subject.

status: String!

One of ‘running’, ‘scheduled’, ‘ended’, ‘paused’, ‘draft’ 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’, ‘draft’ or ‘deleted’.

delayHours: Int!

Delay in hours between the previous event in the drip sequence and when this email is scheduled to be sent.

createdDate: DateTime

The date this email was created.

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.

EmailQuery

Fields:

byEID(email: String!): Email
Resolves an Email by its EID.

Arguments:

email: String!

EID of the Email.

byEIDs(eids: [String!]!): [Email]!
Resolves multiple Emails by their EID.

Arguments:

eids: [String!]!

List of campaign EIDs.

byAdvertisable(advertisable: String!): [Email]!
Resolves all Emails for an Advertisable.

Arguments:

advertisable: String!

The EID of the advertisable whose emails are to be fetched

byCampaign(campaign: String!): [Email]!
Resolves all Emails for a Campaign.

Arguments:

campaign: String!

EID of the campaign.

metricsTotal: MetricAggregateResult!

[ALPHA] This GraphQL node 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.

For documentation see the root metricsTotal field in Query.

GranularConversion

A row describing a granular conversion.

Fields:

time: DateTime

When the conversion happened.

type: String!

There are two types of conversions: “Click through” (CTC), “View through” (VTC) or “Influenced”.

attributionModel: String!

The attribution model applied at the time of conversion.

attributionCredit: String!

The type of credit assigned: “attributed” or “influenced”.

adrollConversionId: String!

The unique identifier for the attributed or influenced conversion.

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.

lastTouchAttribution: Boolean!

True if it has been attributed as last touch.

channel: String!

The channel that served the converting ad (Web, Facebook, Email).

campaignEID: String!

The EID of the campaign that served the converting ad.

campaignType: String!

The type of the campaign that served the converting ad.

campaignName: String!

The name of the campaign that served the converting ad.

adgroupEID: String!

The EID of the AdGroup that served the converting ad.

adgroupName: String!

The name of the AdGroup that served the converting ad.

adEID: String!

The EID of the ad that resulted in a conversion.

adName: String!

The name of the ad that resulted in a conversion.

adSize: String!

Size of the converting ad.

segmentEID: String!

The EID of the associated conversion audience.

segmentName: String!

The name of the associated conversion audience.

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).

externalData: JSON!

Data recorded by the AdRoll Pixel on the conversion event.

device: String!

If available the device where the conversion happened.

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.

firstTouchTimestamp: DateTime

When the first AdRoll touch occurred.

lastTouchTimestamp: DateTime

When the final AdRoll touch occurred.

daysToConversionFirstTouch: Decimal!

Time from first AdRoll touch to conversion (days).

daysToConversionLastTouch: Decimal!

Time from last AdRoll touch to conversion (days).

referrerURL: String!

URL preceding the conversion.

cookie: String!

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

hiearchy:

  • 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:

id: String!

Unique ID for this group.

parentId: String!

The unique ID of the parent group. Empty for the root group.

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.

domain: String!

When grouping by domain, this returns the domain for the current group.

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’).

audience: AudienceGroupData

Audience data for the group. This is only available when grouping by audiences (e.g. ‘entity’ = ‘audience’).

impressions: Decimal!

The sum of the number of ad impressions and the number of unique-by-session email opens collected.

clicks: Decimal!

The sum of clicks of all kinds of ads and emails.

cost: Decimal!

Cost associated to all kinds of ads and emails.

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-Attributed Revenue. Total earnings when someone views your ad and converts.

revenue: Decimal!

Revenue (amount) = View Revenue + Click Conversions

clickRevenue: Decimal!

Click-Attributed Revenue. Total earnings when someone clicks your ad and converts.

viewRevenue: Decimal!

View-through conversion (VTC). A goal completion that happens after someone views your ad, but doesn’t click.

ctr: Decimal!

Click-through rate. The percentage of ad serves that were clicked.

CTR (%) = Clicks / Impression * 100

cpc: Decimal!

Cost per click. Your average spend for one click.

CPC ($) = Spend / Clicks

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 + Opens) * 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

roi: Decimal!

[DEPRECATED] use ‘roas’ instead.

Alias for ‘roas’.

clickROI: Decimal!

[DEPRECATED] use ‘clickROAS’ instead.

Alias for ‘clickROAS’.

viewROI: Decimal!

[DEPRECATED] use ‘viewROAS’ instead.

Alias for ‘viewROAS’.

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.

audienceSizeNew: Decimal!

[DEPRECATED] Will be dropped in the near future.

audienceSizeTotal: Decimal!

[DEPRECATED] Will be dropped in the near future.

newVisitors: Decimal!

The number of new visitors who came to your site after viewing a prospecting ad.

engagedVisitors: Decimal!

The number of new visitors who have viewed at least 3 pages on your site after viewing a prospecting ad.

bouncedVisitors: Decimal!

Visitors who have only viewed one page and left your site after viewing a prospecting ad.

nonBouncedVisitors: Decimal!

Visitors who have only viewed more than one page after viewing a prospecting ad.

newVisitorCost: Decimal!

The cost for each new visitor that came to your site after viewing a prospecting ad.

New Visitor Cost = cost / newVisitors

engagedVisitorCost: Decimal!

The cost for each new visitor that has viewed at least 3 pages on your site after viewing a prospecting ad

Engaged Visitor Cost = cost / engagedVisitors

bounceRate: Decimal!

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.

sends: Decimal!

Number of emails sent by a campaign.

opens: Decimal!

Number of unique-by-session email opens collected for a campaign. WARNING: this field will be deprecated and opens aggregated into “impressions”. To ease up the transition this field will still be available, but always return 0.

openRate: Decimal!

Open Rate (%) = Opens / Sends * 100

videoImpressions: Decimal!

Impressions from video ads

videoViews: Decimal!

Number of times the video begun playing.

videoTwentyFivePercent: Decimal!

Number of times at least 25% of the video duration was played.

videoFiftyPercent: Decimal!

Number of times at least 50% of the video duration was played.

videoSeventyFivePercent: Decimal!

Number of times at least 75% of the video duration was played.

videoHundredPercent: Decimal!

Number of times the full video duration was played.

videoCompletionRate: Decimal!

Video completion rate

Video Completion Rate (x) = Video Viewed To 100% / Video Impressions

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)

end: Date

The end date for the metrics period (exclusive). 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
currency: String
Currency to load the metrics in.
Default:“USD”
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 hiearchy 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)

end: Date

The end date for the metrics period (exclusive). 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
currency: String
Currency to load the metrics in.
Default:“USD”
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:

id: String!

Unique ID for this group.

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.

domain: String!

When grouping by domain, this returns the domain for the current group.

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’).

audience: AudienceGroupData

Audience data for the group. This is only available when grouping by audiences (e.g. ‘entity’ = ‘audience’).

impressions: Decimal!

The sum of the number of ad impressions and the number of unique-by-session email opens collected.

clicks: Decimal!

The sum of clicks of all kinds of ads and emails.

cost: Decimal!

Cost associated to all kinds of ads and emails.

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-Attributed Revenue. Total earnings when someone views your ad and converts.

revenue: Decimal!

Revenue (amount) = View Revenue + Click Conversions

clickRevenue: Decimal!

Click-Attributed Revenue. Total earnings when someone clicks your ad and converts.

viewRevenue: Decimal!

View-through conversion (VTC). A goal completion that happens after someone views your ad, but doesn’t click.

ctr: Decimal!

Click-through rate. The percentage of ad serves that were clicked.

CTR (%) = Clicks / Impression * 100

cpc: Decimal!

Cost per click. Your average spend for one click.

CPC ($) = Spend / Clicks

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 + Opens) * 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

roi: Decimal!

[DEPRECATED] use ‘roas’ instead.

Alias for ‘roas’.

clickROI: Decimal!

[DEPRECATED] use ‘clickROAS’ instead.

Alias for ‘clickROAS’.

viewROI: Decimal!

[DEPRECATED] use ‘viewROAS’ instead.

Alias for ‘viewROAS’.

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.

audienceSizeNew: Decimal!

[DEPRECATED] Will be dropped in the near future.

audienceSizeTotal: Decimal!

[DEPRECATED] Will be dropped in the near future.

newVisitors: Decimal!

The number of new visitors who came to your site after viewing a prospecting ad.

engagedVisitors: Decimal!

The number of new visitors who have viewed at least 3 pages on your site after viewing a prospecting ad.

bouncedVisitors: Decimal!

Visitors who have only viewed one page and left your site after viewing a prospecting ad.

nonBouncedVisitors: Decimal!

Visitors who have only viewed more than one page after viewing a prospecting ad.

newVisitorCost: Decimal!

The cost for each new visitor that came to your site after viewing a prospecting ad.

New Visitor Cost = cost / newVisitors

engagedVisitorCost: Decimal!

The cost for each new visitor that has viewed at least 3 pages on your site after viewing a prospecting ad

Engaged Visitor Cost = cost / engagedVisitors

bounceRate: Decimal!

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.

sends: Decimal!

Number of emails sent by a campaign.

opens: Decimal!

Number of unique-by-session email opens collected for a campaign. WARNING: this field will be deprecated and opens aggregated into “impressions”. To ease up the transition this field will still be available, but always return 0.

openRate: Decimal!

Open Rate (%) = Opens / Sends * 100

videoImpressions: Decimal!

Impressions from video ads

videoViews: Decimal!

Number of times the video begun playing.

videoTwentyFivePercent: Decimal!

Number of times at least 25% of the video duration was played.

videoFiftyPercent: Decimal!

Number of times at least 50% of the video duration was played.

videoSeventyFivePercent: Decimal!

Number of times at least 75% of the video duration was played.

videoHundredPercent: Decimal!

Number of times the full video duration was played.

videoCompletionRate: Decimal!

Video completion rate

Video Completion Rate (x) = Video Viewed To 100% / Video Impressions

groups: [GroupResult!]!

Return children groups if available.

LogLine

[WARNING] Log lines are intended for internal analysis and debuging.

They are not available for external developers to consume.

Fields:

id: String!

ID for the log entry this line belongs to. An ID may have multiple lines.

kind: String!

Kind of entry.

key: String!

Key for the log line. The key indicates the operation in the system that generated this entry.

time: DateTime!

Absolute time when the log line was generated.

delta: Float!

Relative delta when the log line was generated. In seconds from the beginning of the request.

text: String!

Text for the log line message.

data: String!

Raw data for the log line (e.g. data dump).

lines: JSON!

This is the data field split by lines.

json: JSON!

Parsed JSON payload from the data field, if any.

info: String!

A string combining information from id, kind, key, time, delta and text fields.

payload: JSON!

Payload parses information from the data field and returns the CSV, JSON or Form data payload for a dump or the payload lines (excluding headers).

xtra: JSON!

Returns the non-payload part of the data dump as split lines.

Metric

Contains reporting metric data for attributions, deliveries,

segment deliveries and emails.

Fields:

date: Date

Date for this particular metric data. This is empty for summaries.

impressions: Decimal!

The sum of the number of ad impressions and the number of unique-by-session email opens collected.

clicks: Decimal!

The sum of clicks of all kinds of ads and emails.

cost: Decimal!

Cost associated to all kinds of ads and emails.

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-Attributed Revenue. Total earnings when someone views your ad and converts.

revenue: Decimal!

Revenue (amount) = View Revenue + Click Conversions

clickRevenue: Decimal!

Click-Attributed Revenue. Total earnings when someone clicks your ad and converts.

viewRevenue: Decimal!

View-through conversion (VTC). A goal completion that happens after someone views your ad, but doesn’t click.

ctr: Decimal!

Click-through rate. The percentage of ad serves that were clicked.

CTR (%) = Clicks / Impression * 100

cpc: Decimal!

Cost per click. Your average spend for one click.

CPC ($) = Spend / Clicks

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 + Opens) * 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

roi: Decimal!

[DEPRECATED] use ‘roas’ instead.

Alias for ‘roas’.

clickROI: Decimal!

[DEPRECATED] use ‘clickROAS’ instead.

Alias for ‘clickROAS’.

viewROI: Decimal!

[DEPRECATED] use ‘viewROAS’ instead.

Alias for ‘viewROAS’.

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.

audienceSizeNew: Decimal!

[DEPRECATED] Will be dropped in the near future.

audienceSizeTotal: Decimal!

[DEPRECATED] Will be dropped in the near future.

newVisitors: Decimal!

The number of new visitors who came to your site after viewing a prospecting ad.

engagedVisitors: Decimal!

The number of new visitors who have viewed at least 3 pages on your site after viewing a prospecting ad.

bouncedVisitors: Decimal!

Visitors who have only viewed one page and left your site after viewing a prospecting ad.

nonBouncedVisitors: Decimal!

Visitors who have only viewed more than one page after viewing a prospecting ad.

newVisitorCost: Decimal!

The cost for each new visitor that came to your site after viewing a prospecting ad.

New Visitor Cost = cost / newVisitors

engagedVisitorCost: Decimal!

The cost for each new visitor that has viewed at least 3 pages on your site after viewing a prospecting ad

Engaged Visitor Cost = cost / engagedVisitors

bounceRate: Decimal!

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.

sends: Decimal!

Number of emails sent by a campaign.

opens: Decimal!

Number of unique-by-session email opens collected for a campaign. WARNING: this field will be deprecated and opens aggregated into “impressions”. To ease up the transition this field will still be available, but always return 0.

openRate: Decimal!

Open Rate (%) = Opens / Sends * 100

videoImpressions: Decimal!

Impressions from video ads

videoViews: Decimal!

Number of times the video begun playing.

videoTwentyFivePercent: Decimal!

Number of times at least 25% of the video duration was played.

videoFiftyPercent: Decimal!

Number of times at least 50% of the video duration was played.

videoSeventyFivePercent: Decimal!

Number of times at least 75% of the video duration was played.

videoHundredPercent: Decimal!

Number of times the full video duration was played.

videoCompletionRate: Decimal!

Video completion rate

Video Completion Rate (x) = Video Viewed To 100% / Video Impressions

MetricAggregateResult

[ALPHA] This GraphQL node 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.

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:

summary: Metric!

Summarises the reporting data for the given date range.

byDate: [Metric!]!

Reporting data by date in the given range.

MetricDomain
Contains reporting metric data for the domain.

Fields:

date: Date

Date for this particular metric data. This is empty for summaries.

impressions: Decimal!

The sum of the number of ad impressions on the domain.

clicks: Decimal!

The sum of clicks of ads on the domain.

cost: Decimal!

Cost associated to displaying ads on the domain.

cpm: Decimal!

Cost per mille. Cost per one thousand ad serves on the domain.

CPM ($) = Spend / Impressions * 1000

ctr: Decimal!

Click-through rate. The percentage of ad serves that were clicked on the domain.

CTR (%) = Clicks / Impression * 100

MetricDomainResult

Groups reporting metric data for the domain in summary and by

date format.

Fields:

domain: String!

The domain this metric pertains to.

summary: MetricDomain!

Summarises the reporting data for the given date range.

byDate: [MetricDomain!]!

Reporting data by date in the given range.

MetricResult
Groups reporting metric data in summary and by date format.

Fields:

summary: Metric!

Summarises the reporting data for the given date range.

byDate: [Metric!]!

Reporting data by date in the given range.

Organization

Fields:

eid: String!

EID of the organization.

name: String!

Name of the organization.

createdDate: DateTime

Created date for the organization.

advertisables: [Advertisable]!

Advertisables for this Organization.

campaigns(isActive: Boolean, statuses: [String!], blacklistStatuses: [String!], types: [String!], channels: [String!]): [Campaign]!
Campaigns for this 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:[ ]
blacklistStatuses: [String!]
Only campaigns whose status is not one of these will be returned (Optional; default: None)
Default:[ ]
types: [String!]
Only campaigns that match one of these 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:[ ]
metricsTotal: MetricAggregateResult!

[ALPHA] This GraphQL node 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.

For documentation see the root metricsTotal field in Query.

OrganizationGroupData

Fields:

eid: String!

EID of the organization.

name: String!

Name of the organization.

createdDate: DateTime

Created date for the organization.

OrganizationQuery

Fields:

byEID(organization: String!): Organization
Obtain an Organization by its unique identifier (EID).

Arguments:

organization: String!

Organization EID.

current: Organization

Obtain the Organization the current user is part of.

metricsTotal: MetricAggregateResult!

[ALPHA] This GraphQL node 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.

For documentation see the root metricsTotal field in Query.

Placement

Contains reporting metric data for attributions, deliveries

by placement.

Fields:

placement: String!

Placement of the Ad in Facebook. For example ‘desktop’, ‘feed’...

impressions: Decimal!

The sum of the number of ad impressions and the number of unique-by-session email opens collected.

clicks: Decimal!

The sum of clicks of all kinds of ads and emails.

cost: Decimal!

Cost associated to all kinds of ads and emails.

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-Attributed Revenue. Total earnings when someone views your ad and converts.

revenue: Decimal!

Revenue (amount) = View Revenue + Click Conversions

clickRevenue: Decimal!

Click-Attributed Revenue. Total earnings when someone clicks your ad and converts.

viewRevenue: Decimal!

View-through conversion (VTC). A goal completion that happens after someone views your ad, but doesn’t click.

ctr: Decimal!

Click-through rate. The percentage of ad serves that were clicked.

CTR (%) = Clicks / Impression * 100

cpc: Decimal!

Cost per click. Your average spend for one click.

CPC ($) = Spend / Clicks

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 + Opens) * 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

roi: Decimal!

[DEPRECATED] use ‘roas’ instead.

Alias for ‘roas’.

clickROI: Decimal!

[DEPRECATED] use ‘clickROAS’ instead.

Alias for ‘clickROAS’.

viewROI: Decimal!

[DEPRECATED] use ‘viewROAS’ instead.

Alias for ‘viewROAS’.

PlacementResult
Groups reporting metric data in summary and by date format.

Fields:

byPlacement: [Placement!]!

Summarises by placement the reporting data for the given date range.

Query
Root query element for GraphQL.

Fields:

flags(enableUniversalCampaigns: Boolean!): Boolean!
Setup global request flags

Arguments:

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
requestId: String!

Unique ID generated for this request.

log(text: String, id: String, kind: String, key: String, filter: String, not: String): [LogLine!]!

Log lines for this request. Admin-only.

[WARNING] Log lines are intended for internal analysis and debuging. They are not available for external developers to consume.

Arguments:

text: String

Include logs containing the given text in their data.

id: String

Include logs with the given ID.

kind: String

Include logs of the given kind.

key: String

Include logs of the given key.

filter: String

Include logs that match the given filter.

not: String

Include logs that do not match the given filter.

organization: OrganizationQuery

Root for queries for Organizations.

advertisable: AdvertisableQuery

Root for queries for Advertisables.

campaign: CampaignQuery

Root for queries for Campaigns.

adgroup: AdgroupQuery

Root for queries for Adgroups.

ad: AdQuery

Root for queries for Ads.

email: EmailQuery

Root for queries for Emails.

segment: SegmentQuery

[ALPHA] This GraphQL node 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. Use the child Audiences of Campaigns and AdGroups instead.

Root for queries for 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!

[ALPHA] This GraphQL node 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.

Provides simple aggregation of all metrics in the current and child nodes. Supports aggregating the summary and byDate metrics separately.

The scope of the metricsTotal field, i.e. the scope from which metrics will be aggregated, is the current node (the node where the metricsTotal is declared under) and its inner nodes. The aggregation happens for each metrics field under the scope. Here the term “node” refers to the result of any non-scalar GraphQL field.

Note that this is a simple aggregation of the metric results in the scope, as such:

  • Using fields in metricsTotal WILL NOT cause them to be loaded, it

will only aggregate from data that is already being loaded through a metrics field. - As a corollary of the above, it will only aggregate a particular field insofar as it is loaded, e.g. if the field is included in some but not all “metrics” fields, only those which are loaded will be aggregated. - The totals may end up duplicated if metrics are loaded more than once for the same entity, or if the same metrics are loaded at multiple levels (e.g. campaigns and ads) in the metricsTotal scope.

Segment

[ALPHA] This GraphQL node 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.

Fields:

eid: String!

[ALPHA] This GraphQL node 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.

The Segment EID.

name: String!

[ALPHA] This GraphQL node 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.

The Segment Name.

duration: Int!

[ALPHA] This GraphQL node 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.

The Segment’s duration in days.

isConversion: Boolean!

[ALPHA] This GraphQL node 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.

True if this is a conversion segment.

conversionValue: Float!

[ALPHA] This GraphQL node 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.

The value of a conversion from this segment.

currency: String!

[ALPHA] This GraphQL node 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.

The value of a conversion from this segment. Default to the Advertisable’s currency.

SegmentGroupData

Fields:

eid: String!

[ALPHA] This GraphQL node 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.

The Segment EID.

name: String!

[ALPHA] This GraphQL node 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.

The Segment Name.

duration: Int!

[ALPHA] This GraphQL node 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.

The Segment’s duration in days.

isConversion: Boolean!

[ALPHA] This GraphQL node 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.

True if this is a conversion segment.

conversionValue: Float!

[ALPHA] This GraphQL node 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.

The value of a conversion from this segment.

currency: String!

[ALPHA] This GraphQL node 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.

The value of a conversion from this segment. Default to the Advertisable’s currency.

SegmentQuery

[ALPHA] This GraphQL node 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.

Fields:

byEID(segment: String!): Segment

[ALPHA] This GraphQL node 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.

[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:

segment: String!

Resolves a Segment by its EID.

byEIDs(eids: [String!]!): [Segment]!

[ALPHA] This GraphQL node 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.

[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:

eids: [String!]!

Resolves multiple Segments by their EID.

byAdvertisable(advertisable: String!, isConversion: Boolean): [Segment]!

[ALPHA] This GraphQL node 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.

[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:

advertisable: String!

Required advertisable EID.

isConversion: Boolean

If True, only conversion segments will be returned (Optional; default: False).

Scalars

Scalars represent primitive types and cannot have fields.

Descriptions

Boolean

The Boolean scalar type represents true or false.

Date
DateTime
Decimal
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
String

The String scalar type represents textual data, represented as UTF‐8 character sequences.