AdRoll Reporting API Reference

Note

If you use the APIs provided here, you are subject to the API Terms of Use

Description

AdRoll Reporting API 1 by apihelp@adroll.com

Access your data with the AdRoll Reporting API

List of Operations

Operations

GET /uhura/v1/userlists/ad

Provides user list sizes broken down by ad and date

Parameters:

Query Parameters
Name Required Type Description
breakdowns True string Comma-separated list of breakdowns. Must be at least one of entity, date, summary
advertisable_eid True string A single advertisable EID
ad_eids True string Comma-separated list of ad EIDs
durations True string Comma-separated list of ad durations. Must be the same length as ad_eids
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date

Responses:

200 OK

successful operation

Returns UserList Metrics Response

GET /uhura/v1/segment-deliveries/segment

Retrieve segement deliveries by segment

Parameters:

Query Parameters
Name Required Type Description
breakdowns True string Comma-separated list of breakdowns. Must be at least one of entity, date, summary
advertisable_eid True string A single advertisable EID
segment_eids False string Comma-separated list of segment EIDs
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date
currency False string Three-letter currency code, in uppercase

Responses:

200 OK

successful operation

Returns Segment Deliveries Response

POST /uhura/v1/segment-deliveries/segment

Retrieve segment deliveries by segment. This is the POST version, used when the request is too big for a GET.

Schema for request body: Segment Deliveries Post Input

{
  "advertisable_eid": "string", 
  "breakdowns": [
    "string"
  ], 
  "currency": "string", 
  "end_date": "string", 
  "past_days": 0, 
  "segment_eids": [
    "string"
  ], 
  "start_date": "string"
}

Responses:

200 OK

successful operation

Returns Segment Deliveries Response

GET /uhura/v1/attributions/advertisable

Retrieve attributions by advertisable

Parameters:

Query Parameters
Name Required Type Description
breakdowns True string Comma-separated list of breakdowns. Must be at least one of entity, date, summary
advertisable_eid True string A single advertisable EID
campaign_eids False string Comma-separated list of campaign EIDs
segment_eids False string Comma-separated list of segment EIDs
adgroup_eids False string Comma-separated list of adgroup EIDs
ad_eids False string Comma-separated list of ad EIDs
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date
currency False string Three-letter currency code, in uppercase

Responses:

200 OK

successful operation

Returns Attribution Metrics Response

POST /uhura/v1/attributions/advertisable

Retrieve attributions by advertisable. This is the POST version, used when the request is too big for a GET.

Schema for request body: Attributions Post Input

{
  "ad_eids": [
    "string"
  ], 
  "adgroup_eids": [
    "string"
  ], 
  "advertisable_eid": "string", 
  "breakdowns": [
    "string"
  ], 
  "campaign_eids": [
    "string"
  ], 
  "currency": "string", 
  "end_date": "string", 
  "inventory_sources": [
    "string"
  ], 
  "networks": [
    "string"
  ], 
  "past_days": 0, 
  "segment_eids": [
    "string"
  ], 
  "start_date": "string"
}

Responses:

200 OK

successful operation

Returns Attribution Metrics Response

GET /uhura/v1/userlists/segment

Provides user list sizes broken down by segment and date

Provides user list sizes broken down by segment and date, as well as a summary for counts across all specified segments. If a particular segment has multiple durations associated with it, then the summary section will be computed with the segment’s largest duration. This endpoint also allows the specification of excluded segments, which are segments to not consider in generating the user list sizes. The excluded segments and their durations are combined together across the entire specified date range when they are being applied against the summary and entity breakdowns, but they are applied on a corresponding day-by-day basis when applied to the date breakdown.

Parameters:

Query Parameters
Name Required Type Description
breakdowns True string Comma-separated list of breakdowns. Must be at least one of entity, date, summary
advertisable_eid True string A single advertisable EID
segment_eids True string Comma-separated list of segment eids
durations True string Comma-separated list of segment durations. Must be the same length as segment_eids
excluded_segment_eids False string Comma-separated list of segment eids to exclude from the count
excluded_durations False string Comma-separated list of durations corresponding to the segments to exclude from the count. Must be the same length as excluded_segment_eids. Each excluded segment must have exactly one duration associated with it.
count_on False string Specify which metric to count on. This value is either cookie or email
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date

Responses:

200 OK

successful operation

Returns UserList Metrics Response

POST /uhura/v1/userlists/segment

Provides user list sizes broken down by segment and date

This is identical to the GET endpoint, but is presented as a POST endpoint in order to submit large input sets. The POST body is a JSON-encoded string whose format follows exactly from the GET endpoint’s query parameters.

Schema for request body: Segment UserList Post Input

{
  "advertisable_eid": "string", 
  "breakdowns": [
    "string"
  ], 
  "count_on": "string", 
  "durations": [
    0
  ], 
  "end_date": "string", 
  "excluded_durations": [
    0
  ], 
  "excluded_segment_eids": [
    "string"
  ], 
  "past_days": 0, 
  "segment_eids": [
    "string"
  ], 
  "start_date": "string"
}

Responses:

200 OK

successful operation

Returns UserList Metrics Response

POST /uhura/v1/attributions/bulk/rollup/export

Schema for request body:

"string"
<built-in method title of str object at 0x2b18eea3b120>
Format:<built-in method format of str object at 0x2b18eea3b120>

Responses:

Default
successful operation
GET /uhura/v1/attributions/segment

Retrieve attributions by segment

Parameters:

Query Parameters
Name Required Type Description
breakdowns True string Comma-separated list of breakdowns. Must be at least one of entity, date, summary
advertisable_eid True string A single advertisable EID
campaign_eids False string Comma-separated list of campaign EIDs
segment_eids False string Comma-separated list of segment EIDs
adgroup_eids False string Comma-separated list of adgroup EIDs
ad_eids False string Comma-separated list of ad EIDs
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date
currency False string Three-letter currency code, in uppercase

Responses:

200 OK

successful operation

Returns Attribution Metrics Response

POST /uhura/v1/attributions/segment

Retrieve attributions by segment. This is the POST version, used when the request is too big for a GET.

Schema for request body: Attributions Post Input

{
  "ad_eids": [
    "string"
  ], 
  "adgroup_eids": [
    "string"
  ], 
  "advertisable_eid": "string", 
  "breakdowns": [
    "string"
  ], 
  "campaign_eids": [
    "string"
  ], 
  "currency": "string", 
  "end_date": "string", 
  "inventory_sources": [
    "string"
  ], 
  "networks": [
    "string"
  ], 
  "past_days": 0, 
  "segment_eids": [
    "string"
  ], 
  "start_date": "string"
}

Responses:

200 OK

successful operation

Returns Attribution Metrics Response

GET /uhura/v1/attributions/campaign

Retrieve attributions by campaign

Parameters:

Query Parameters
Name Required Type Description
breakdowns True string Comma-separated list of breakdowns. Must be at least one of entity, date, summary
advertisable_eid True string A single advertisable EID
campaign_eids False string Comma-separated list of campaign EIDs
segment_eids False string Comma-separated list of segment EIDs
adgroup_eids False string Comma-separated list of adgroup EIDs
ad_eids False string Comma-separated list of ad EIDs
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date
currency False string Three-letter currency code, in uppercase

Responses:

200 OK

successful operation

Returns Attribution Metrics Response

POST /uhura/v1/attributions/campaign

Retrieve attributions by campaign. This is the POST version, used when the request is too big for a GET.

Schema for request body: Attributions Post Input

{
  "ad_eids": [
    "string"
  ], 
  "adgroup_eids": [
    "string"
  ], 
  "advertisable_eid": "string", 
  "breakdowns": [
    "string"
  ], 
  "campaign_eids": [
    "string"
  ], 
  "currency": "string", 
  "end_date": "string", 
  "inventory_sources": [
    "string"
  ], 
  "networks": [
    "string"
  ], 
  "past_days": 0, 
  "segment_eids": [
    "string"
  ], 
  "start_date": "string"
}

Responses:

200 OK

successful operation

Returns Attribution Metrics Response

POST /uhura/v1/attributions/wca-placement/export

Retrieve wca placement attributions as CSV

Schema for request body: Attributions Post Input

{
  "ad_eids": [
    "string"
  ], 
  "adgroup_eids": [
    "string"
  ], 
  "advertisable_eid": "string", 
  "breakdowns": [
    "string"
  ], 
  "campaign_eids": [
    "string"
  ], 
  "currency": "string", 
  "end_date": "string", 
  "inventory_sources": [
    "string"
  ], 
  "networks": [
    "string"
  ], 
  "past_days": 0, 
  "segment_eids": [
    "string"
  ], 
  "start_date": "string"
}

Responses:

200 OK

successful operation

Sample response:

"string"

Response schema:

Schema-0
Type:string
GET /uhura/v1/deliveries/domain/adgroup

Retrieve deliveries by domain adgroup

Parameters:

Query Parameters
Name Required Type Description
breakdowns True string Comma-separated list of breakdowns. Must be at least one of entity, date, summary
advertisable_eid True string A single advertisable EID
domains False string Comma-separated list of domains
adgroup_eids False string Comma-separated list of adgroup EIDs
ad_eids False string Comma-separated list of ad EIDs
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date
currency False string Three-letter currency code, in uppercase

Responses:

200 OK

successful operation

Returns Deliveries Metrics Response

POST /uhura/v1/deliveries/domain/adgroup

Retrieve deliveries by domain adgroup. This is the POST version, used when the request is too big for a GET.

Schema for request body: Site Deliveries Post Input

{
  "ad_eids": [
    "string"
  ], 
  "adgroup_eids": [
    "string"
  ], 
  "advertisable_eid": "string", 
  "breakdowns": [
    "string"
  ], 
  "currency": "string", 
  "domains": [
    "string"
  ], 
  "end_date": "string", 
  "extra_costs": true, 
  "past_days": 0, 
  "start_date": "string"
}

Responses:

200 OK

successful operation

Returns Deliveries Metrics Response

GET /uhura/v1/attributions/adgroup

Retrieve attributions by adgroup

Parameters:

Query Parameters
Name Required Type Description
breakdowns True string Comma-separated list of breakdowns. Must be at least one of entity, date, summary
advertisable_eid True string A single advertisable EID
campaign_eids False string Comma-separated list of campaign EIDs
segment_eids False string Comma-separated list of segment EIDs
adgroup_eids False string Comma-separated list of adgroup EIDs
ad_eids False string Comma-separated list of ad EIDs
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date
currency False string Three-letter currency code, in uppercase

Responses:

200 OK

successful operation

Returns Attribution Metrics Response

POST /uhura/v1/attributions/adgroup

Retrieve attributions by adgroup. This is the POST version, used when the request is too big for a GET.

Schema for request body: Attributions Post Input

{
  "ad_eids": [
    "string"
  ], 
  "adgroup_eids": [
    "string"
  ], 
  "advertisable_eid": "string", 
  "breakdowns": [
    "string"
  ], 
  "campaign_eids": [
    "string"
  ], 
  "currency": "string", 
  "end_date": "string", 
  "inventory_sources": [
    "string"
  ], 
  "networks": [
    "string"
  ], 
  "past_days": 0, 
  "segment_eids": [
    "string"
  ], 
  "start_date": "string"
}

Responses:

200 OK

successful operation

Returns Attribution Metrics Response

GET /uhura/v1/userlists/advertisable

Provides user list sizes broken down by advertisable and date

Parameters:

Query Parameters
Name Required Type Description
breakdowns True string Comma-separated list of breakdowns. Must be at least one of entity, date, summary
advertisable_eid True string A single advertisable EID
duration True string A single duration
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date

Responses:

200 OK

successful operation

Returns UserList Metrics Response

POST /uhura/v1/deliveries/wca-placement

Retrieve deliveries by wca placement. This is the POST version, used when the request is too big for a GET.

Schema for request body: Deliveries Post Input

{
  "ad_eids": [
    "string"
  ], 
  "adgroup_eids": [
    "string"
  ], 
  "advertisable_eid": "string", 
  "breakdowns": [
    "string"
  ], 
  "campaign_eids": [
    "string"
  ], 
  "currency": "string", 
  "end_date": "string", 
  "extra_costs": true, 
  "inventory_sources": [
    "string"
  ], 
  "networks": [
    "string"
  ], 
  "past_days": 0, 
  "start_date": "string"
}

Responses:

200 OK

successful operation

Returns Deliveries Metrics Response

GET /uhura/v1/deliveries/ad

Retrieve deliveries by ad

Parameters:

Query Parameters
Name Required Type Description
breakdowns True string Comma-separated list of breakdowns. Must be at least one of entity, date, summary
advertisable_eid True string A single advertisable EID
campaign_eids False string Comma-separated list of campaign EIDs
adgroup_eids False string Comma-separated list of adgroup EIDs
ad_eids False string Comma-separated list of ad EIDs
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date
currency False string Three-letter currency code, in uppercase

Responses:

200 OK

successful operation

Returns Deliveries Metrics Response

POST /uhura/v1/deliveries/ad

Retrieve deliveries by ad. This is the POST version, used when the request is too big for a GET.

Schema for request body: Deliveries Post Input

{
  "ad_eids": [
    "string"
  ], 
  "adgroup_eids": [
    "string"
  ], 
  "advertisable_eid": "string", 
  "breakdowns": [
    "string"
  ], 
  "campaign_eids": [
    "string"
  ], 
  "currency": "string", 
  "end_date": "string", 
  "extra_costs": true, 
  "inventory_sources": [
    "string"
  ], 
  "networks": [
    "string"
  ], 
  "past_days": 0, 
  "start_date": "string"
}

Responses:

200 OK

successful operation

Returns Deliveries Metrics Response

GET /uhura/v1/segment-deliveries/advertisable

Retrieve segement deliveries by advertisable

Parameters:

Query Parameters
Name Required Type Description
breakdowns True string Comma-separated list of breakdowns. Must be at least one of entity, date, summary
advertisable_eid True string A single advertisable EID
segment_eids False string Comma-separated list of segment EIDs
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date
currency False string Three-letter currency code, in uppercase

Responses:

200 OK

successful operation

Returns Segment Deliveries Response

POST /uhura/v1/segment-deliveries/advertisable

Retrieve segment deliveries by advertisable. This is the POST version, used when the request is too big for a GET.

Schema for request body: Segment Deliveries Post Input

{
  "advertisable_eid": "string", 
  "breakdowns": [
    "string"
  ], 
  "currency": "string", 
  "end_date": "string", 
  "past_days": 0, 
  "segment_eids": [
    "string"
  ], 
  "start_date": "string"
}

Responses:

200 OK

successful operation

Returns Segment Deliveries Response

GET /uhura/v1/deliveries/advertisable

Retrieve deliveries by advertisable

Parameters:

Query Parameters
Name Required Type Description
breakdowns True string Comma-separated list of breakdowns. Must be at least one of entity, date, summary
advertisable_eid True string A single advertisable EID
campaign_eids False string Comma-separated list of campaign EIDs
adgroup_eids False string Comma-separated list of adgroup EIDs
ad_eids False string Comma-separated list of ad EIDs
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date
currency False string Three-letter currency code, in uppercase

Responses:

200 OK

successful operation

Returns Deliveries Metrics Response

POST /uhura/v1/deliveries/advertisable

Retrieve deliveries by advertisable. This is the POST version, used when the request is too big for a GET.

Schema for request body: Deliveries Post Input

{
  "ad_eids": [
    "string"
  ], 
  "adgroup_eids": [
    "string"
  ], 
  "advertisable_eid": "string", 
  "breakdowns": [
    "string"
  ], 
  "campaign_eids": [
    "string"
  ], 
  "currency": "string", 
  "end_date": "string", 
  "extra_costs": true, 
  "inventory_sources": [
    "string"
  ], 
  "networks": [
    "string"
  ], 
  "past_days": 0, 
  "start_date": "string"
}

Responses:

200 OK

successful operation

Returns Deliveries Metrics Response

GET /uhura/v1/deliveries/export

Retrieve deliveries as CSV

Parameters:

Query Parameters
Name Required Type Description
advertisable_eid True string A single advertisable EID
campaign_eids False string Comma-separated list of campaign EIDs
adgroup_eids False string Comma-separated list of adgroup EIDs
ad_eids False string Comma-separated list of ad EIDs
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date
currency False string Three-letter currency code, in uppercase

Responses:

200 OK

successful operation

Sample response:

"string"

Response schema:

Schema-1
Type:string
GET /uhura/v1/segment-deliveries/export

Retrieve segment deliveries as CSV

Parameters:

Query Parameters
Name Required Type Description
advertisable_eid True string A single advertisable EID
segment_eids False string Comma-separated list of segment EIDs
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date
currency False string Three-letter currency code, in uppercase

Responses:

200 OK

successful operation

Sample response:

"string"

Response schema:

Schema-2
Type:string
GET /uhura/v1/deliveries/domain/ad

Retrieve deliveries by domain ad

Parameters:

Query Parameters
Name Required Type Description
breakdowns True string Comma-separated list of breakdowns. Must be at least one of entity, date, summary
advertisable_eid True string A single advertisable EID
domains False string Comma-separated list of domains
adgroup_eids False string Comma-separated list of adgroup EIDs
ad_eids False string Comma-separated list of ad EIDs
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date
currency False string Three-letter currency code, in uppercase

Responses:

200 OK

successful operation

Returns Deliveries Metrics Response

POST /uhura/v1/deliveries/domain/ad

Retrieve deliveries by domain ad. This is the POST version, used when the request is too big for a GET.

Schema for request body: Site Deliveries Post Input

{
  "ad_eids": [
    "string"
  ], 
  "adgroup_eids": [
    "string"
  ], 
  "advertisable_eid": "string", 
  "breakdowns": [
    "string"
  ], 
  "currency": "string", 
  "domains": [
    "string"
  ], 
  "end_date": "string", 
  "extra_costs": true, 
  "past_days": 0, 
  "start_date": "string"
}

Responses:

200 OK

successful operation

Returns Deliveries Metrics Response

GET /uhura/v1/deliveries/domain/export

Retrieve site deliveries as CSV

Parameters:

Query Parameters
Name Required Type Description
advertisable_eid True string A single advertisable EID
domains False string Comma-separated list of domains
adgroup_eids False string Comma-separated list of adgroup EIDs
ad_eids False string Comma-separated list of ad EIDs
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date
currency False string Three-letter currency code, in uppercase

Responses:

200 OK

successful operation

Sample response:

"string"

Response schema:

Schema-3
Type:string
GET /uhura/v1/deliveries/domain

Retrieve deliveries by domain

Parameters:

Query Parameters
Name Required Type Description
breakdowns True string Comma-separated list of breakdowns. Must be at least one of entity, date, summary
advertisable_eid True string A single advertisable EID
domains False string Comma-separated list of domains
adgroup_eids False string Comma-separated list of adgroup EIDs
ad_eids False string Comma-separated list of ad EIDs
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date
currency False string Three-letter currency code, in uppercase

Responses:

200 OK

successful operation

Returns Deliveries Metrics Response

POST /uhura/v1/deliveries/domain

Retrieve deliveries by domain. This is the POST version, used when the request is too big for a GET.

Schema for request body: Site Deliveries Post Input

{
  "ad_eids": [
    "string"
  ], 
  "adgroup_eids": [
    "string"
  ], 
  "advertisable_eid": "string", 
  "breakdowns": [
    "string"
  ], 
  "currency": "string", 
  "domains": [
    "string"
  ], 
  "end_date": "string", 
  "extra_costs": true, 
  "past_days": 0, 
  "start_date": "string"
}

Responses:

200 OK

successful operation

Returns Deliveries Metrics Response

GET /uhura/v1/userlists/adgroup

Provides user list sizes broken down by adgroup and date

Parameters:

Query Parameters
Name Required Type Description
breakdowns True string Comma-separated list of breakdowns. Must be at least one of entity, date, summary
advertisable_eid True string A single advertisable EID
adgroup_eids True string Comma-separated list of adgroup EIDs
durations True string Comma-separated list of adgroup durations. Must be the same length as adgroup_eids
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date

Responses:

200 OK

successful operation

Returns UserList Metrics Response

GET /uhura/v1/granular-attributions

Retrieve granular attributions

Parameters:

Query Parameters
Name Required Type Description
advertisable_eid True string A single advertisable EID
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date
currency False string Three-letter currency code, in uppercase

Responses:

200 OK

successful operation

Returns Attribution Metrics Response

POST /uhura/v1/attributions/wca-placement

Retrieve attributions by wca placement. This is the POST version, used when the request is too big for a GET.

Schema for request body: Attributions Post Input

{
  "ad_eids": [
    "string"
  ], 
  "adgroup_eids": [
    "string"
  ], 
  "advertisable_eid": "string", 
  "breakdowns": [
    "string"
  ], 
  "campaign_eids": [
    "string"
  ], 
  "currency": "string", 
  "end_date": "string", 
  "inventory_sources": [
    "string"
  ], 
  "networks": [
    "string"
  ], 
  "past_days": 0, 
  "segment_eids": [
    "string"
  ], 
  "start_date": "string"
}

Responses:

200 OK

successful operation

Returns Attribution Metrics Response

GET /uhura/v1/deliveries/campaign

Retrieve deliveries by campaign

Parameters:

Query Parameters
Name Required Type Description
breakdowns True string Comma-separated list of breakdowns. Must be at least one of entity, date, summary
advertisable_eid True string A single advertisable EID
campaign_eids False string Comma-separated list of campaign EIDs
adgroup_eids False string Comma-separated list of adgroup EIDs
ad_eids False string Comma-separated list of ad EIDs
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date
currency False string Three-letter currency code, in uppercase

Responses:

200 OK

successful operation

Returns Deliveries Metrics Response

POST /uhura/v1/deliveries/campaign

Retrieve deliveries by campaign. This is the POST version, used when the request is too big for a GET.

Schema for request body: Deliveries Post Input

{
  "ad_eids": [
    "string"
  ], 
  "adgroup_eids": [
    "string"
  ], 
  "advertisable_eid": "string", 
  "breakdowns": [
    "string"
  ], 
  "campaign_eids": [
    "string"
  ], 
  "currency": "string", 
  "end_date": "string", 
  "extra_costs": true, 
  "inventory_sources": [
    "string"
  ], 
  "networks": [
    "string"
  ], 
  "past_days": 0, 
  "start_date": "string"
}

Responses:

200 OK

successful operation

Returns Deliveries Metrics Response

GET /uhura/v1/attributions/export

Retrieve attributions as CSV

Parameters:

Query Parameters
Name Required Type Description
advertisable_eid True string A single advertisable EID
campaign_eids False string Comma-separated list of campaign EIDs
segment_eids False string Comma-separated list of segment EIDs
adgroup_eids False string Comma-separated list of adgroup EIDs
ad_eids False string Comma-separated list of ad EIDs
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date
currency False string Three-letter currency code, in uppercase

Responses:

200 OK

successful operation

Sample response:

"string"

Response schema:

Schema-4
Type:string
GET /uhura/v1/deliveries/adgroup

Retrieve deliveries by adgroup

Parameters:

Query Parameters
Name Required Type Description
breakdowns True string Comma-separated list of breakdowns. Must be at least one of entity, date, summary
advertisable_eid True string A single advertisable EID
campaign_eids False string Comma-separated list of campaign EIDs
adgroup_eids False string Comma-separated list of adgroup EIDs
ad_eids False string Comma-separated list of ad EIDs
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date
currency False string Three-letter currency code, in uppercase

Responses:

200 OK

successful operation

Returns Deliveries Metrics Response

POST /uhura/v1/deliveries/adgroup

Retrieve deliveries by adgroup. This is the POST version, used when the request is too big for a GET.

Schema for request body: Deliveries Post Input

{
  "ad_eids": [
    "string"
  ], 
  "adgroup_eids": [
    "string"
  ], 
  "advertisable_eid": "string", 
  "breakdowns": [
    "string"
  ], 
  "campaign_eids": [
    "string"
  ], 
  "currency": "string", 
  "end_date": "string", 
  "extra_costs": true, 
  "inventory_sources": [
    "string"
  ], 
  "networks": [
    "string"
  ], 
  "past_days": 0, 
  "start_date": "string"
}

Responses:

200 OK

successful operation

Returns Deliveries Metrics Response

GET /uhura/v1/attributions/ad

Retrieve attributions by ad

Parameters:

Query Parameters
Name Required Type Description
breakdowns True string Comma-separated list of breakdowns. Must be at least one of entity, date, summary
advertisable_eid True string A single advertisable EID
campaign_eids False string Comma-separated list of campaign EIDs
segment_eids False string Comma-separated list of segment EIDs
adgroup_eids False string Comma-separated list of adgroup EIDs
ad_eids False string Comma-separated list of ad EIDs
start_date False string Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)
end_date False string End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)
past_days False integer Takes precedence over start_date and end_date
currency False string Three-letter currency code, in uppercase

Responses:

200 OK

successful operation

Returns Attribution Metrics Response

POST /uhura/v1/attributions/ad

Retrieve attributions by ad. This is the POST version, used when the request is too big for a GET.

Schema for request body: Attributions Post Input

{
  "ad_eids": [
    "string"
  ], 
  "adgroup_eids": [
    "string"
  ], 
  "advertisable_eid": "string", 
  "breakdowns": [
    "string"
  ], 
  "campaign_eids": [
    "string"
  ], 
  "currency": "string", 
  "end_date": "string", 
  "inventory_sources": [
    "string"
  ], 
  "networks": [
    "string"
  ], 
  "past_days": 0, 
  "segment_eids": [
    "string"
  ], 
  "start_date": "string"
}

Responses:

200 OK

successful operation

Returns Attribution Metrics Response

Definitions

Site Deliveries Post Input

Parameters when sending a POST request to the site deliveries endpoints

Type:object
advertisable_eid

A single advertisable EID

Required:True
Type:string
breakdowns

Comma-separated list of breakdowns. Must be at least one of entity, date, summary

Required:True
Type:array of items
end_date

End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)

Type:string
adgroup_eids

Comma-separated list of adgroup eids

Type:array of items
ad_eids

Comma-separated list of ad eids

Type:array of items
currency

Three-letter currency code, in uppercase

Type:string
domains

Comma-separated list of domains

Type:array of items
extra_costs

Parameter for retrieving our_cost and billable_cost

Type:boolean
past_days

Takes precedence over start_date and end_date

Type:integer
Format:int32
start_date

Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)

Type:string
Segment UserList Post Input

Parameters when sending a POST request to the segment user list endpoint

Type:object
advertisable_eid

A single advertisable EID

Required:True
Type:string
breakdowns

Comma-separated list of breakdowns. Must be at least one of entity, date, summary

Required:True
Type:array of items
excluded_segment_eids

Comma-separated list of segment eids to exclude from the count

Type:array of items
end_date

End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)

Type:string
segment_eids

Comma-separated list of segment eids

Required:True
Type:array of items
durations

Comma-separated list of segment durations. Must be the same length as segment_eids

Required:True
Type:array of items
excluded_durations

Comma-separated list of durations corresponding to the segments to exclude from the count. Must be the same length as excluded_segment_eids. Each excluded segment must have exactly one duration associated with it.

Type:array of items
past_days

Takes precedence over start_date and end_date

Type:integer
Format:int32
start_date

Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)

Type:string
count_on

Specify which metric to count on. This value is either cookie or email

Type:string
Deliveries Metrics

An object for the different ways deliveries metrics is broken down and exposed

Type:object
date
Type:array of Deliveries Date Metrics Response
summary
Type:Deliveries Summary Metrics Response
entity
Type:array of Deliveries Entity Metrics Response
UserList Metrics Response

An object for responding to requests with UserList metrics

Type:object
results
Type:UserList Metrics
Attribution Metrics

An object for the different ways attribution metrics are broken down and exposed

Type:object
date
Type:array of Attribution Date Metrics Response
summary
Type:Attribution Summary Metrics Response
entity
Type:array of Attribution Entity Metric Response
UserList Date Metrics Response

A JSON encoded wrapper for UserList Metrics broken down by each day

Type:object
date
Type:string
Format:date-time
total_visitors

Total number of unique visitors between the specified start_date and end_date ignoring duration.

Type:integer
Format:int64
new_visitors

Count of unique new visitors who visited the entities between the specified date range.

Type:integer
Format:int64
excluded_total_visitors

Count of total visitors who did not visit entities because of a exclusion segment.

Type:integer
Format:int64
Segment Deliveries Response

An object for responding to requests with segment deliveries metrics

Type:object
results
Type:Segment Deliveries Metrics
Segment Deliveries Date Metrics

A JSON encoded wrapper for Segment Deliveries Metrics broken down by each day

Type:object
date
Type:string
Format:date-time
visitors

Total number of visitors that visited a page

Type:integer
Format:int32
revenue

The amount of revenue brought in from those visitors. Default currency is USD.

Type:number
Format:double
Segment Deliveries Summary Metrics

A JSON encoded wrapper for totals of Segment Deliveries Metrics

Type:object
visitors

Total number of visitors that visited a page

Type:integer
Format:int32
revenue

The amount of revenue brought in from those visitors. Default currency is USD.

Type:number
Format:double
Attributions Post Input

Parameters when sending a POST request to the attribution endpoints

Type:object
advertisable_eid

A single advertisable EID

Required:True
Type:string
breakdowns

Comma-separated list of breakdowns. Must be at least one of entity, date, summary

Required:True
Type:array of items
end_date

End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)

Type:string
adgroup_eids

Comma-separated list of adgroup eids

Type:array of items
segment_eids

Comma-separated list of segment eids

Type:array of items
campaign_eids

Comma-separated list of campaign eids

Type:array of items
start_date

Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)

Type:string
ad_eids

Comma-separated list of ad eids

Type:array of items
currency

Three-letter currency code, in uppercase

Type:string
past_days

Takes precedence over start_date and end_date

Type:integer
Format:int32
networks

Filter deliveries based on comma separated networks

Type:array of items
inventory_sources

Filter deliveries based on comma separated inventory sources

Type:array of items
Attribution Summary Metrics Response

Response of a summary of attribution metrics

Type:object
view_revenue

Attributed revenue generated from all view through conversions. Default currency is USD.

Type:number
Format:double
click_revenue

Attributed revenue generated from all click through conversions. Default currency is USD.

Type:number
Format:double
view_throughs

Number of times a user viewed an ad within the view through window

Type:integer
Format:int32
click_throughs

Number of times a user clicked on an ad within the click through window

Type:integer
Format:int32
UserList Summary Metrics Response

A JSON encoded wrapper for UserList Metrics

Type:object
total_visitors

Total number of unique visitors between the specified start_date and end_date ignoring duration.

Type:integer
Format:int64
excluded_current_visitors

Count of current visitors at the time of query who did not visit entities because of a exclusion segment.

Type:integer
Format:int64
excluded_current_visitors_in_date_range

Count of current visitors during the end_date who did not visit entities because of a exclusion segment.

Type:integer
Format:int64
current_visitors

Count of unique visitors who visited the entities at the time of the query.

Type:integer
Format:int64
excluded_total_visitors

Count of total visitors who did not visit entities because of a exclusion segment.

Type:integer
Format:int64
new_visitors

Count of unique new visitors who visited the entities between the specified date range.

Type:integer
Format:int64
current_visitors_in_date_range

Count of unique visitors who visited the entities during the date range.

Type:integer
Format:int64
Granular Attribution Metrics Response

Response of attribution metrics with more granularity and information

Type:object
city
Type:string
segment_eid
Type:string
ip
Type:string
ad_eid
Type:string
external_data
Type:string
conversion_value
Type:number
Format:double
conversion_type
Type:string
final_event_time

The date and time when the last event occurred before the conversion

Type:string
Format:date-time
conversion_time

The date and time when the conversion occurred

Type:string
Format:date-time
cookie
Type:string
referrer
Type:string
adgroup_eid
Type:string
country
Type:string
Attribution Metrics Response

An object for responding to requests with attribution metrics

Type:object
results
Type:Attribution Metrics
Deliveries Summary Metrics Response

Response of a summary of deliveries metrics

Type:object
billable_cost

The cost that AdRoll will bill to the advertisable

Type:number
Format:double
impressions
Type:integer
Format:int32
cost

The total cost the advertisable incurs to service the impressions and clicks. Default currency is USD.

Type:number
Format:double
clicks
Type:integer
Format:int32
our_cost

AdRoll’s internal cost to service the impressions and clicks

Type:number
Format:double
Deliveries Entity Metrics Response

Response of deliveries metrics broken down by a specified entity type

Type:object
billable_cost

The cost that AdRoll will bill to the advertisable

Type:number
Format:double
entity

The ID of a specified entity type that belongs to the advertisable

Type:string
cost

The total cost the advertisable incurs to service the impressions and clicks. Default currency is USD.

Type:number
Format:double
our_cost

AdRoll’s internal cost to service the impressions and clicks

Type:number
Format:double
impressions
Type:integer
Format:int32
clicks
Type:integer
Format:int32
User List Entity Metrics Response

Response of userlist metrics broken down by a specified entity type

Type:object
entity

The ID of a specified entity type that belongs to the advertisable

Type:string
Deliveries Metrics Response

An object for responding to requests with deliveries metrics

Type:object
results
Type:Deliveries Metrics
Deliveries Date Metrics Response

Response of deliveries metrics broken down by each day

Type:object
billable_cost

The cost that AdRoll will bill to the advertisable

Type:number
Format:double
cost

The total cost the advertisable incurs to service the impressions and clicks. Default currency is USD.

Type:number
Format:double
our_cost

AdRoll’s internal cost to service the impressions and clicks

Type:number
Format:double
date
Type:string
Format:date-time
impressions
Type:integer
Format:int32
clicks
Type:integer
Format:int32
UserList Metrics

An object for the different ways UserList metrics are broken down and exposed

Type:object
date
Type:array of UserList Date Metrics Response
summary
Type:UserList Summary Metrics Response
entity
Type:array of User List Entity Metrics Response
Segment Deliveries Post Input

Parameters when sending a POST request to the segment deliveries endpoints

Type:object
advertisable_eid

A single advertisable EID

Required:True
Type:string
breakdowns

Comma-separated list of breakdowns. Must be at least one of entity, date, summary

Required:True
Type:array of items
end_date

End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)

Type:string
segment_eids

Comma-separated list of segment eids

Type:array of items
currency

Three-letter currency code, in uppercase

Type:string
past_days

Takes precedence over start_date and end_date

Type:integer
Format:int32
start_date

Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)

Type:string
Attribution Entity Metric Response

Response of attribution metrics are broken down by a specified entity type

Type:object
view_revenue

Attributed revenue generated from all view through conversions. Default currency is USD.

Type:number
Format:double
entity

The ID of a specified entity type that belongs to the advertisable

Type:string
click_revenue

Attributed revenue generated from all click through conversions. Default currency is USD.

Type:number
Format:double
view_throughs

Number of times a user viewed an ad within the view through window

Type:integer
Format:int32
click_throughs

Number of times a user clicked on an ad within the click through window

Type:integer
Format:int32
Segment Deliveries Metrics

An object for the different ways segment deliveries metrics is broken down and exposed

Type:object
date
Type:array of Segment Deliveries Date Metrics
summary
Type:Segment Deliveries Summary Metrics
entity
Type:array of Deliveries Entity Metrics Response
Attribution Date Metrics Response

Response of attribution metrics are broken down by each day

Type:object
date
Type:string
Format:date-time
view_revenue

Attributed revenue generated from all view through conversions. Default currency is USD.

Type:number
Format:double
click_revenue

Attributed revenue generated from all click through conversions. Default currency is USD.

Type:number
Format:double
view_throughs

Number of times a user viewed an ad within the view through window

Type:integer
Format:int32
click_throughs

Number of times a user clicked on an ad within the click through window

Type:integer
Format:int32
Deliveries Post Input

Parameters when sending a POST request to the site deliveries endpoints

Type:object
advertisable_eid

A single advertisable EID

Required:True
Type:string
breakdowns

Comma-separated list of breakdowns. Must be at least one of entity, date, summary

Required:True
Type:array of items
end_date

End of the date range in yyyy-MM-dd or MM-dd-yyyy format (exclusive)

Type:string
adgroup_eids

Comma-separated list of adgroup eids

Type:array of items
campaign_eids

Comma-separated list of campaign eids

Type:array of items
start_date

Start of the date range in yyyy-MM-dd or MM-dd-yyyy format (inclusive)

Type:string
ad_eids

Comma-separated list of ad eids

Type:array of items
currency

Three-letter currency code, in uppercase

Type:string
extra_costs

Parameter for retrieving our_cost and billable_cost

Type:boolean
past_days

Takes precedence over start_date and end_date

Type:integer
Format:int32
networks

Filter deliveries based on comma separated networks

Type:array of items
inventory_sources

Filter deliveries based on comma separated inventory sources

Type:array of items