post https://koddi.io/console/v1/member_groups//external/report
This endpoint is used to pull reporting for an entire program at any grain.
This endpoint requires authorization via an authorization header. Please work with the Koddi team to receive credentials that can be used in the Sessions - Token endpoint. Details for this sessions endpoint can be found here.
Inputs
Sample request body:
{
"currency_code": "USD",
"dimensions": [
"media_plan_id",
"media_plan_name"
],
"metrics": [
"cost_per_click",
"impressions",
"clicks",
"revenue"
],
"filters":[
{
"field": "advertiser_id",
"operation": "=",
"value": [
12345
]
}
],
"sort": [
{
"field":"impressions",
"order":"DESC"
}
],
"start_date": "2020-01-01",
"end_date": "2020-01-31"
}
Request parameter details:
| Field | Type | Description | Required |
| currency_code | string | The currency code that any monetary fields will be converted to. | Optional (Advertiser currency is default) |
| dimensions | array of strings | The list of dimensions to retrieve and report on.
These are available options to include in the dimensions array: daily_date site_id advertiser_id advertiser_name media_plan_id media_plan_name line_item_id campaign_id campaign_name ad_group_id ad_group_name internal_entity_id (note this is a big int) entity_id (note this is a big int) entity_name rank Any configured targeting parameter Please note that only a subset of these dimensions might be relevant to your program. Please consult your Koddi representative to determine which dimensions to include in your API call. |
Required |
| metrics | array of strings | The list of metrics to retrieve and report on.
These are available options to include in the metrics array: impressions average_rank clicks click_through_rate cost_per_click cost cost_per_transaction average_conversion_rate average_basket_size units transactions revenue return_on_ad_spend exposed_units exposed_transactions exposed_revenue exposed_roas halo_units halo_transactions halo_revenue halo_roas halo_exposed_units halo_exposed_transactions halo_exposed_revenue halo_exposed_roas Please note that only a subset of these metrics might be relevant to your program. Please consult your Koddi representative to determine which metrics to include in your API call. |
Required |
| filters | object | The list of metrics or dimensions to filter on, and their operators. | Optional |
| field | string | The name of the dimension or metric you want to filter on | Required if filters object is present |
| operation | string | The operator of the filter | Required if filters object is present |
| value | string | The value of the dimension or metric that you want to filter on | Required if filters object is present |
| pagination | object | The pagination parameters. | Optional |
| start | integer | The start index. | Optional |
| count | integer | The count of objects to return. If null then ONLY 250 rows will be returned. | Optional |
| sort | array of objects | The list of sort options. Will sort by last_modified ascending by default. | Optional |
| field | string | The field to sort on. | Required if sort object array is present |
| order | string | The order to sort by, either ASC or DESC. | Optional. The report will sort in ascending order if not provided. |
| start_date | string | The start date of the report date range. | Required |
| end_date | string | The end date of the report date range. | Required |
A note on the pagination count....
If no count variable is provided, only the first 250 records will be returned.
Lookback Period for Bulk Data Pulls
Minor data restatements happen in due course of advertising business operations. We generally try to keep them to a minimum, but as a safeguard we generally suggest at least a 3 day look back window on the bulk endpoints. If data is restated beyond the 3 day window, a message will be posted on status.koddi.com and your Koddi team will send you a direct message.
Response
| Field | Type | Description |
| headers | array of objects | The list of headers for the report. This corresponds directly to the metrics and dimensions included in the request. |
| name | string | The internal name of the field. |
| title | string | The user-facing label of the field. |
| type | string | The field type. |
| data | array of objects | The list of dictionary data point objects. These have keys corresponding to the headers. |