Reporting API Reference

Note

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

Note

We’ve introduced API keys, please read Migrating to API Keys

Description

AdRoll Reporting API 1

Access your data with the AdRoll Reporting API

Operations by Tag

Advertisable Attribute Metrics

Json

Operations

GET /uhura/v1/advertisable-site-metrics

Retrieve site metrics 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

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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

successful operation

Returns Advertisable Site Metrics Response

POST /uhura/v1/advertisable-site-metrics

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

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: Advertisable Site Metrics Post Input

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

Responses:

200

successful operation

Returns Advertisable Site Metrics Response

GET /uhura/v1/assisted-granular-attributions

Retrieve assisted granular attributions - This endpoint is deprecated since 2018-05-22, please use combined-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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

successful operation

Returns Assisted Granular Attributions Metrics Response

GET /uhura/v1/attributes-metrics/advertisable

Retrieve advertisable attribute metrics

Parameters:

Query Parameters

Name

Required

Type

Description

advertisable_eid

True

string

A single advertisable EID

attribute_name

True

string

A single attribute name

attribute_values

False

string

Comma-separated list of attribute values

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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

successful operation

Returns Advertisable Attribute Metrics Response

POST /uhura/v1/attributes-metrics/advertisable

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

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: Advertisable Attribute Metrics Post Input

{
  "advertisable_eid": "string",
  "attribute_name": "string",
  "attribute_values": [
    "string"
  ],
  "currency": "string",
  "end_date": "string",
  "past_days": 0,
  "start_date": "string"
}

Responses:

200

successful operation

Returns Advertisable Attribute Metrics Response

GET /uhura/v1/attributes-metrics/aggregated/export

Retrieve aggregated advertisable attribute metrics as CSV

Parameters:

Query Parameters

Name

Required

Type

Description

advertisable_eid

True

string

A single advertisable EID

attribute_name

True

string

A single attribute name

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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

use_new_table

False

boolean

Temporary parameter indicating that the new table should be used

filter_by_tal

False

boolean

Whether to only return domains that are targeted by attribute segments. Available if use_new_table is true.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

successful operation

Schema as JSON:

"string"
Schema
Type

string

GET /uhura/v1/attributes-metrics/export

Retrieve advertisable attribute metrics as CSV

Parameters:

Query Parameters

Name

Required

Type

Description

advertisable_eid

True

string

A single advertisable EID

attribute_name

True

string

A single attribute name

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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase

use_new_table

False

boolean

Temporary parameter indicating that the new table should be used

filter_by_tal

False

boolean

Whether to only return domains that are targeted by attribute segments. Available if use_new_table is true.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

successful operation

Schema as JSON:

"string"
Schema
Type

string

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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

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.

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: Attributions Post Input

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

Responses:

200

successful operation

Returns Attribution 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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

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.

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: Attributions Post Input

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

Responses:

200

successful operation

Returns Attribution Metrics 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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

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.

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: Attributions Post Input

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

Responses:

200

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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

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.

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: Attributions Post Input

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

Responses:

200

successful operation

Returns Attribution 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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

successful operation

Schema as JSON:

"string"
Schema
Type

string

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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

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.

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: Attributions Post Input

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

Responses:

200

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.

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: Attributions Post Input

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

Responses:

200

successful operation

Returns Attribution Metrics Response

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

Retrieve wca placement attributions as CSV

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: Attributions Post Input

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

Responses:

200

successful operation

Schema as JSON:

"string"
Schema
Type

string

GET /uhura/v1/combined-granular-attributions

Retrieve combined granular conversions

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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

successful operation

Returns Combined Granular Attributions 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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

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.

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

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

successful operation

Returns Deliveries Metrics Response

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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

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.

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

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

successful operation

Returns Deliveries Metrics 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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

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.

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

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

successful operation

Returns Deliveries 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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

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.

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

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

successful operation

Returns Deliveries Metrics Response

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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

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.

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

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

successful operation

Returns Deliveries Metrics Response

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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

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.

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

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

successful operation

Returns Deliveries Metrics Response

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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

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.

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

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

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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

successful operation

Schema as JSON:

"string"
Schema
Type

string

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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

successful operation

Schema as JSON:

"string"
Schema
Type

string

POST /uhura/v1/deliveries/export

Retrieve deliveries as CSV

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

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

successful operation

Schema as JSON:

"string"
Schema
Type

string

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.

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

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

successful operation

Returns Deliveries Metrics Response

GET /uhura/v1/email-domain-metrics/export

Retrieve attributions and deliveries CSV data grouped by email domain, for a campaign based on CRM segments

Parameters:

Query Parameters

Name

Required

Type

Description

advertisable_eid

True

string

A single advertisable EID

campaign_eid

True

string

A single campaign 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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

successful operation

Schema as JSON:

"string"
Schema
Type

string

POST /uhura/v1/email-domain-metrics/export

Retrieve attributions and deliveries CSV data grouped by email domain, for a campaign based on CRM segments

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: Email Domain Metrics Post Input

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

Responses:

200

successful operation

Schema as JSON:

"string"
Schema
Type

string

GET /uhura/v1/granular-attributions

Retrieve granular attributions - This endpoint is deprecated since 2018-05-22, please use combined-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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

successful operation

Returns Granular Attribution Metrics Response

GET /uhura/v1/multiproduct-granular-attributions

Retrieve multiproduct granular conversions - This endpoint is deprecated since 2018-05-22, please use combined-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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

successful operation

Returns Multiproduct Granular Attributions Metrics Response

GET /uhura/v1/prospecting-attributes/advertisable

Retrieve total and unique cookie counts for one or more attributes by advertisable.

Parameters:

Query Parameters

Name

Required

Type

Description

advertisable_eid

True

string

A single advertisable EID

report_date

True

string

Reporting (as-of) date for results

attribute_names

True

string

Comma-separated list of attribute names

sorted

False

string

Either total_cookie_count or unique_cookie_count

top

False

string

The maximum number of values to return

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

successful operation

Returns Third Party Attributes Metrics Response

POST /uhura/v1/prospecting-attributes/advertisable

Retrieve total and unique cookie counts for one or more attributes by advertisable. This is the POST version, used when the request is too big for a GET.

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: Third Party Attributes Post Input

{
  "advertisable_eid": "string",
  "attribute_names": [
    "string"
  ],
  "report_date": "string",
  "sorted": "string",
  "top": "string"
}

Responses:

200

successful operation

Returns Third Party Attributes Metrics Response

GET /uhura/v1/prospecting-attributes/advertisable/export

Retrieve total and unique cookie counts for one or more attributes by advertisableas a csv.

Parameters:

Query Parameters

Name

Required

Type

Description

advertisable_eid

True

string

A single advertisable EID

report_date

True

string

Reporting (as-of) date for results

attribute_names

True

string

Comma-separated list of attribute names

sorted

False

string

Either total_cookie_count or unique_cookie_count

top

False

string

The maximum number of values to return

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

successful operation

Schema as JSON:

"string"
Schema
Type

string

GET /uhura/v1/retargeting-attributes/advertisable

Retrieve total and unique cookie counts for one or more attributes by advertisable.

Parameters:

Query Parameters

Name

Required

Type

Description

advertisable_eid

True

string

A single advertisable EID

report_date

True

string

Reporting (as-of) date for results

attribute_names

True

string

Comma-separated list of attribute names

sorted

False

string

Either total_cookie_count or unique_cookie_count

top

False

string

The maximum number of values to return

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

successful operation

Returns Third Party Attributes Metrics Response

POST /uhura/v1/retargeting-attributes/advertisable

Retrieve total and unique cookie counts for one or more attributes by advertisable. This is the POST version, used when the request is too big for a GET.

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: Third Party Attributes Post Input

{
  "advertisable_eid": "string",
  "attribute_names": [
    "string"
  ],
  "report_date": "string",
  "sorted": "string",
  "top": "string"
}

Responses:

200

successful operation

Returns Third Party Attributes Metrics Response

GET /uhura/v1/retargeting-attributes/advertisable/export

Retrieve total and unique cookie counts for one or more attributes by advertisable.

Parameters:

Query Parameters

Name

Required

Type

Description

advertisable_eid

True

string

A single advertisable EID

report_date

True

string

Reporting (as-of) date for results

attribute_names

True

string

Comma-separated list of attribute names

sorted

False

string

Either total_cookie_count or unique_cookie_count

top

False

string

The maximum number of values to return

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

successful operation

Schema as JSON:

"string"
Schema
Type

string

GET /uhura/v1/segment-attributes/advertisable

Retrieve total and unique cookie counts for one or more attributes by segment.

Parameters:

Query Parameters

Name

Required

Type

Description

advertisable_eid

True

string

A single advertisable EID

segment_eid

True

string

A single segment EID

report_date

True

string

Reporting (as-of) date for results

attribute_names

True

string

Comma-separated list of attribute names

sorted

False

string

Either total_cookie_count or unique_cookie_count

top

False

string

The maximum number of values to return

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

successful operation

Returns Segment Attributes Metrics Response

POST /uhura/v1/segment-attributes/advertisable

Retrieve total and unique cookie counts for one or more attributes by segment. This is the POST version, used when the request is too big for a GET.

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Schema for request body: Segment Attributes Post Input

{
  "advertisable_eid": "string",
  "attribute_names": [
    "string"
  ],
  "report_date": "string",
  "segment_eid": "string",
  "sorted": "string",
  "top": "string"
}

Responses:

200

successful operation

Returns Segment Attributes Metrics Response

GET /uhura/v1/segment-attributes/advertisable/export

Retrieve total and unique cookie counts for one or more attributes by segment.

Parameters:

Query Parameters

Name

Required

Type

Description

advertisable_eid

True

string

A single advertisable EID

segment_eid

True

string

A single segment EID

report_date

True

string

Reporting (as-of) date for results

attribute_names

True

string

Comma-separated list of attribute names

sorted

False

string

Either total_cookie_count or unique_cookie_count

top

False

string

The maximum number of values to return

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

successful operation

Schema as JSON:

"string"
Schema
Type

string

GET /uhura/v1/segment-deliveries/advertisable

Retrieve segment 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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

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.

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

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

successful operation

Returns Segment Deliveries Response

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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

successful operation

Schema as JSON:

"string"
Schema
Type

string

GET /uhura/v1/segment-deliveries/segment

Retrieve segment 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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

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.

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

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

successful operation

Returns Segment Deliveries Response

POST /uhura/v1/segmentation-event-deliveries/advertisable

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

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

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

successful operation

Returns Segmentation Event Deliveries Response

GET /uhura/v1/segmentation-event-deliveries/export

Retrieve segmentation event 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

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

currency

False

string

Three-letter currency code, in uppercase Default: USD.

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

successful operation

Schema as JSON:

"string"
Schema
Type

string

POST /uhura/v1/segmentation-event-deliveries/segment

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

Parameters:

Query Parameters

Name

Required

Type

Description

apikey

False

string

Required if using HTTP Basic Authentication. The value is the Client ID you received when you registered your application on the NextRoll Developer site

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

successful operation

Returns Segmentation Event Deliveries Response

Definitions

Advertisable Attribute Metrics Response

An object for responding to requests with advertisable attribute metrics

Type

object

results
Type

object

Advertisable attribute json item

Response of the advertisable attribute metrics broken down for a single day

Type

object

date
Type

string

Format

date-time

is_cross_device
Type

boolean

impression_uniques
Type

integer

Format

int64

click_uniques
Type

integer

Format

int64

page_views
Type

integer

Format

int64

unique_site_visitors
Type

integer

Format

int64

conversions
Type

integer

Format

int64

conversion_uniques
Type

integer

Format

int64

conversion_revenue

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

Type

number

Format

double

engaged_visitors
Type

integer

Format

int64

Advertisable Attribute Metrics Post Input

Parameters when sending a POST request to the Advertisable Attribute Metrics endpoints

Type

object

advertisable_eid

A single advertisable EID

Required

True

Type

string

attribute_name

A single attribute name (e.g. domain)

Required

True

Type

string

attribute_values

Comma-separated list of attribute values

Type

array of items

start_date

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

Type

string

end_date

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

Type

string

past_days
Type

integer

Format

int32

currency

Three-letter currency code, in uppercase

Type

string

Advertisable Site Metrics

Metrics about site activity, like page views and revenue.(includes only site audience)

Type

object

summary
Type

advertisable site metrics Metrics

entity
Type

array of Advertisable Site Metrics Response

date
Type

array of Advertisable Site Metrics Date Metrics

Advertisable Site Metrics Date Metrics

A JSON encoded wrapper for Advertisable Site Metrics broken down by each day

Type

object

date
Type

string

Format

date-time

visitors

Total number of page views. Only trackable page views are counted.

Type

integer

Format

int64

revenue

The amount of conversion revenue brought in from those page views. Only trackable page views are counted. Default currency is USD.

Type

number

Format

double

all_visitors

Total number of page views. All visitors are counted.

Type

integer

Format

int64

all_revenue

The amount of conversion revenue brought in from those page views. All page views are counted. Default currency is USD.

Type

number

Format

double

Advertisable Site Metrics Response

Metrics about site activity, like page views and revenue.(includes only site audience)

Type

object

results
Type

Advertisable Site Metrics

advertisable site metrics Metrics

A JSON encoded wrapper for totals of advertisable site metrics Metrics

Type

object

visitors

Total number of page views. Only trackable visitors are counted.

Type

integer

Format

int64

revenue

The amount of conversion revenue brought in from those page views. Only trackable page views are counted. Default currency is USD.

Type

number

Format

double

all_visitors

Total number of page views. All page views are counted.

Type

integer

Format

int64

all_revenue

The amount of conversion revenue brought in from those page views. All page views are counted. Default currency is USD.

Type

number

Format

double

Advertisable Site Metrics Post Input

Parameters when sending a POST request to the site advertisable metrics endpoints

Type

object

breakdowns

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

Required

True

Type

array of items

advertisable_eid

A single advertisable EID

Required

True

Type

string

start_date

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

Type

string

end_date

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

Type

string

past_days

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

Type

integer

Format

int32

currency

Three-letter currency code, in uppercase

Type

string

Assisted Granular Attributions Metrics Item Response

Response of attribution metrics with more granularity and information

Type

object

conversion_time

The date and time when the conversion occurred

Type

string

Format

date-time

conversion_type
Type

string

product_type
Type

string

assist_product_type
Type

string

first_touch_time

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

Type

string

Format

date-time

last_touch_time

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

Type

string

Format

date-time

touchpoint_time

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

Type

string

Format

date-time

segment_eid
Type

string

campaign_eid
Type

string

adgroup_eid
Type

string

ad_eid
Type

string

conversion_value
Type

number

Format

double

device_id_type
Type

string

country
Type

string

city
Type

string

width
Type

integer

Format

int32

height
Type

integer

Format

int32

external_data
Type

string

final_event
Type

string

conversion_guid
Type

string

Assisted Granular Attributions Metrics Response

An object for responding to requests with assisted granular attributions metrics

Type

object

results
Type

array of Assisted Granular Attributions Metrics Item Response

Attribution Date Metrics Response

Response of attribution metrics are broken down by each day

Type

object

date
Type

string

Format

date-time

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

assists

Number of times a product assists a click or a view within the click/view through window

Type

integer

Format

int32

precise_view_throughs
Type

number

Format

double

precise_click_throughs
Type

number

Format

double

precise_assists
Type

number

Format

double

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

assist_revenue

Attributed revenue generated from all assists. The default currency is USD.

Type

number

Format

double

Attribution Entity Metric Response

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

Type

object

entity

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

Type

string

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

assists

Number of times a product assists a click or a view within the click/view through window

Type

integer

Format

int32

precise_view_throughs
Type

number

Format

double

precise_click_throughs
Type

number

Format

double

precise_assists
Type

number

Format

double

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

assist_revenue

Attributed revenue generated from all assists. The default currency is USD.

Type

number

Format

double

Attribution Metrics

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

Type

object

summary
Type

Attribution Summary Metrics Response

entity
Type

array of Attribution Entity Metric Response

date
Type

array of Attribution Date Metrics Response

Attribution Metrics Response

An object for responding to requests with attribution metrics

Type

object

results
Type

Attribution Metrics

Attribution Summary Metrics Response

Response of a summary of attribution metrics

Type

object

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

assists

Number of times a product assists a click or a view within the click/view through window

Type

integer

Format

int32

precise_view_throughs
Type

number

Format

double

precise_click_throughs
Type

number

Format

double

precise_assists
Type

number

Format

double

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

assist_revenue

Attributed revenue generated from all assists. The default currency is USD.

Type

number

Format

double

Attributions Post Input

Parameters when sending a POST request to the attribution endpoints

Type

object

breakdowns

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

Required

True

Type

array of items

advertisable_eid

A single advertisable EID

Required

True

Type

string

campaign_eids

Comma-separated list of campaign eids

Type

array of items

segment_eids

Comma-separated list of segment eids

Type

array of items

adgroup_eids

Comma-separated list of adgroup eids

Type

array of items

ad_eids

Comma-separated list of ad eids

Type

array of items

start_date

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

Type

string

end_date

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

Type

string

past_days

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

Type

integer

Format

int32

currency

Three-letter currency code, in uppercase

Type

string

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

product_type

A product type to filter data

Type

string

apply_weights

true or false to determine if weights will be applied

Type

string

provide_unweighted_values
Type

string

Combined Granular Attributions Metrics Item Response

Response of conversion metrics with more granularity and information

Type

object

conversion_time

The date and time when the conversion occurred

Type

string

Format

date-time

conversion_type
Type

string

product_type
Type

string

first_touch_time

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

Type

string

Format

date-time

last_touch_time

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

Type

string

Format

date-time

first_touch_to_conversion

The days between the first event related to the conversion and the conversion

Type

integer

Format

int32

segment_eid
Type

string

campaign_eid
Type

string

adgroup_eid
Type

string

ad_eid
Type

string

conversion_value
Type

number

Format

double

device_id_type
Type

string

country
Type

string

city
Type

string

width
Type

integer

Format

int32

height
Type

integer

Format

int32

is_last_touch_attribution
Type

boolean

external_data
Type

string

conversion_guid
Type

string

attribution_model
Type

string

attribution_credit
Type

string

attributed_ratio
Type

number

Format

double

attributed_value
Type

number

Format

double

cookie
Type

string

referrer
Type

string

touchpoint_time
Type

string

Format

date-time

Combined Granular Attributions Metrics Response

An object for responding to requests with combined granular attributions metrics

Type

object

results
Type

array of Combined Granular Attributions Metrics Item Response

Multiproduct Granular Attributions Metrics Item Response

Response of conversion metrics with more granularity and information

Type

object

conversion_time

The date and time when the conversion occurred

Type

string

Format

date-time

conversion_type
Type

string

product_type
Type

string

first_touch_time

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

Type

string

Format

date-time

last_touch_time

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

Type

string

Format

date-time

first_touch_to_conversion

The days between the first event related to the conversion and the conversion

Type

integer

Format

int32

segment_eid
Type

string

campaign_eid
Type

string

adgroup_eid
Type

string

ad_eid
Type

string

conversion_value
Type

number

Format

double

device_id_type
Type

string

country
Type

string

city
Type

string

width
Type

integer

Format

int32

height
Type

integer

Format

int32

is_pr_assisted
Type

boolean

is_sr_assisted
Type

boolean

is_rt_assisted
Type

boolean

external_data
Type

string

conversion_guid
Type

string

Multiproduct Granular Attributions Metrics Response

An object for responding to requests with multiproduct granular attributions metrics

Type

object

results
Type

array of Multiproduct Granular Attributions Metrics Item Response

Granular Attribution Metrics Response

An object for responding to requests with granular attribution metrics

Type

object

results
Type

array of Single Product Granular Attribution Metrics Item Response

Single Product Granular Attribution Metrics Item Response

Response of attribution metrics with more granularity and information

Type

object

conversion_time

The date and time when the conversion occurred

Type

string

Format

date-time

conversion_type
Type

string

final_event_time

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

Type

string

Format

date-time

segment_eid
Type

string

cookie
Type

string

adgroup_eid
Type

string

ad_eid
Type

string

conversion_value
Type

number

Format

double

ip
Type

string

country
Type

string

city
Type

string

external_data
Type

string

referrer
Type

string

Deliveries Date Metrics Response

Response of deliveries metrics broken down by each day

Type

object

date
Type

string

Format

date-time

impressions
Type

integer

Format

int32

clicks
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

our_cost

AdRoll’s internal cost to service the impressions and clicks

Type

number

Format

double

billable_cost

The cost that AdRoll will bill to the advertisable

Type

number

Format

double

Deliveries Entity Metrics Response

Response of deliveries metrics broken down by a specified entity type

Type

object

entity

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

Type

string

impressions
Type

integer

Format

int32

clicks
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

our_cost

AdRoll’s internal cost to service the impressions and clicks

Type

number

Format

double

billable_cost

The cost that AdRoll will bill to the advertisable

Type

number

Format

double

Deliveries Metrics

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

Type

object

summary
Type

Deliveries Summary Metrics Response

entity
Type

array of Deliveries Entity Metrics Response

date
Type

array of Deliveries Date Metrics Response

Deliveries Metrics Response

An object for responding to requests with deliveries metrics

Type

object

results
Type

Deliveries Metrics

Deliveries Summary Metrics Response

Response of a summary of deliveries metrics

Type

object

impressions
Type

integer

Format

int32

clicks
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

our_cost

AdRoll’s internal cost to service the impressions and clicks

Type

number

Format

double

billable_cost

The cost that AdRoll will bill to the advertisable

Type

number

Format

double

Deliveries Post Input

Parameters when sending a POST request to the site deliveries endpoints

Type

object

breakdowns

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

Required

True

Type

array of items

advertisable_eid

A single advertisable EID

Required

True

Type

string

campaign_eids

Comma-separated list of campaign eids

Type

array of items

adgroup_eids

Comma-separated list of adgroup eids

Type

array of items

ad_eids

Comma-separated list of ad eids

Type

array of items

start_date

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

Type

string

end_date

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

Type

string

past_days

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

Type

integer

Format

int32

currency

Three-letter currency code, in uppercase

Type

string

extra_costs

Parameter for retrieving our_cost and billable_cost

Type

boolean

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

Email Domain Metrics Post Input

Parameters when sending a POST request to the email domain metrics endpoints

Type

object

advertisable_eid

A single advertisable EID

Required

True

Type

string

campaign_eids

Comma-separated list of campaign eids

Required

True

Type

array of items

start_date

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

Type

string

end_date

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

Type

string

past_days

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

Type

integer

Format

int32

currency

Three-letter currency code, in uppercase

Type

string

Segmentation Event Deliveries Date Metrics

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

Type

object

date
Type

string

Format

date-time

visitors

Total number of visitors that visited a page. Only trackable visitors are counted.

Type

integer

Format

int64

revenue

The amount of conversion revenue brought in from those visitors. Only trackable visitors are counted. Default currency is USD.

Type

number

Format

double

all_visitors

Total number of visitors that visited a page. All visitors are counted.

Type

integer

Format

int64

all_revenue

The amount of conversion revenue brought in from those visitors. All visitors are counted. Default currency is USD.

Type

number

Format

double

Segmentation Event Deliveries Entity Metrics Response

A JSON encoded wrapper for Segmentation Event Deliveries Metrics broken down by each entity

Type

object

entity

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

Type

string

visitors

Total number of visitors that visited a page. Only trackable visitors are counted.

Type

integer

Format

int64

revenue

The amount of conversion revenue brought in from those visitors. Only trackable visitors are counted. Default currency is USD.

Type

number

Format

double

all_visitors

Total number of visitors that visited a page. All visitors are counted.

Type

integer

Format

int64

all_revenue

The amount of conversion revenue brought in from those visitors. All visitors are counted. Default currency is USD.

Type

number

Format

double

Segmentation Event Deliveries Metrics

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

Type

object

summary
Type

Segmentation Event Deliveries Summary Metrics

entity
Type

array of Segmentation Event Deliveries Entity Metrics Response

date
Type

array of Segmentation Event Deliveries Date Metrics

Segmentation Event Deliveries Response

An object for responding to requests with segmentation event deliveries metrics

Type

object

results
Type

Segmentation Event Deliveries Metrics

Segmentation Event Deliveries Summary Metrics

A JSON encoded wrapper for totals of Segmentation Event Deliveries Metrics

Type

object

visitors

Total number of visitors that visited a page. Only trackable visitors are counted.

Type

integer

Format

int64

revenue

The amount of conversion revenue brought in from those visitors. Only trackable visitors are counted. Default currency is USD.

Type

number

Format

double

all_visitors

Total number of visitors that visited a page. All visitors are counted.

Type

integer

Format

int64

all_revenue

The amount of conversion revenue brought in from those visitors. All visitors are counted. Default currency is USD.

Type

number

Format

double

Segment Deliveries Post Input

Parameters when sending a POST request to the segment deliveries endpoints

Type

object

breakdowns

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

Required

True

Type

array of items

advertisable_eid

A single advertisable EID

Required

True

Type

string

segment_eids

Comma-separated list of segment eids

Type

array of items

start_date

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

Type

string

end_date

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

Type

string

past_days

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

Type

integer

Format

int32

currency

Three-letter currency code, in uppercase

Type

string

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. Only trackable visitors are counted.

Type

integer

Format

int64

revenue

The amount of conversion revenue brought in from those visitors. Only trackable visitors are counted. Default currency is USD.

Type

number

Format

double

all_visitors

Total number of visitors that visited a page. All visitors are counted.

Type

integer

Format

int64

all_revenue

The amount of conversion revenue brought in from those visitors. All visitors are counted. Default currency is USD.

Type

number

Format

double

Segment Deliveries Metrics

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

Type

object

summary
Type

Segment Deliveries Summary Metrics

entity
Type

array of Deliveries Entity Metrics Response

date
Type

array of Segment Deliveries Date Metrics

Segment Deliveries Response

An object for responding to requests with segment deliveries metrics

Type

object

results
Type

Segment Deliveries Metrics

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. Only trackable visitors are counted.

Type

integer

Format

int64

revenue

The amount of conversion revenue brought in from those visitors. Only trackable visitors are counted. Default currency is USD.

Type

number

Format

double

all_visitors

Total number of visitors that visited a page. All visitors are counted.

Type

integer

Format

int64

all_revenue

The amount of conversion revenue brought in from those visitors. All visitors are counted. Default currency is USD.

Type

number

Format

double

Site Deliveries Post Input

Parameters when sending a POST request to the site deliveries endpoints

Type

object

breakdowns

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

Required

True

Type

array of items

advertisable_eid

A single advertisable EID

Required

True

Type

string

domains

Comma-separated list of domains

Type

array of items

adgroup_eids

Comma-separated list of adgroup eids

Type

array of items

ad_eids

Comma-separated list of ad eids

Type

array of items

start_date

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

Type

string

end_date

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

Type

string

past_days

Equivalent to setting end_date to today (exclusive) and start_date to (today - past_days). Takes precedence over start_date and end_date

Type

integer

Format

int32

currency

Three-letter currency code, in uppercase

Type

string

extra_costs

Parameter for retrieving our_cost and billable_cost

Type

boolean

Third Party Attributes Metrics Response

An object for responding to requests with total cookie count and unique cookie count

Type

object

results
Type

object

Third party attributes json item

Response of the Third Party Attributes metrics that has total_cookie_count and unique_cookie_count for a particular attribute value

Type

object

attribute_value
Type

string

total_cookie_count
Type

integer

Format

int64

unique_cookie_count
Type

integer

Format

int64

Third Party Attributes Post Input

Parameters when sending a POST request to the prospecting-attributes orretargeting-attributes endpoints

Type

object

advertisable_eid
Type

string

report_date

As of date of the report in yyyy-MM-dd

Type

string

attribute_names
Type

array of items

sorted
Type

string

top
Type

string

Segment Attributes Metrics Response

An object for responding to requests with total cookie count and unique cookie count

Type

object

results
Type

object

Segment Attributes Post Input

Parameters when sending a POST request to the segment-attributes endpoint

Type

object

advertisable_eid
Type

string

report_date

As of date of the report in yyyy-MM-dd

Type

string

attribute_names
Type

array of items

sorted
Type

string

top
Type

string

segment_eid
Type

string