The API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
All requests to the API must be authenticated using an API key. To authenticate, add a API-KEY
header to your request that contains your API Key.
Code | Summary | Description |
---|---|---|
200 | OK | Everything worked as expected. |
400 | Bad Request | The request was unacceptable, often due to missing a required parameter. |
401 | Unauthorized | No valid API key provided. |
402 | Request Failed | The parameters were valid but the request failed. |
403 | Forbidden | The API key doesn't have permissions to perform the request. |
404 | Not Found | The requested resource doesn't exist. |
429 | Too Many Requests | Too many requests hit the API too quickly. We recommend an exponential backoff of your requests. |
500, 502, 503, 504 | Server Errors | Something went wrong on Server's end. (These are rare.) |
We use conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a wrong data type is provided to a json field). Codes in the 5xx range indicate an error with our servers (these are rare).
To filter the result you can use the filter query parameter. Format:
filter[field_name][operator] = value
filter[outer_field.inner_field]
eq
.You can sort the result by adding sort
query params like sort=-type,name
. -
will act for descending
The API in general is using numbered pages except for Reports.
To paginate the result you can provide the following:
page[number]
is the number of the page.page[size]
is the size of the page. The API max limit is 100.In the response, meta.total_count
shows the number of total objects and meta.total_page
shows the number of total pages.
{
"meta": {
"total_count": 1000,
"total_page": 50
}
}
Example:
Go to the first page:
GET /api/v2/coffees?page[size]=100&page[number]=1
Go to the second page:
GET /api/v2/coffees?page[size]=100&page[number]=2
You can list all filter groups within an integration.
integrationID required | string The Integration ID |
Array of objects (csapi.FilterGroup) | |
object (csapi.ListMeta) |
{- "data": [
- {
- "active": true,
- "advertiser_ids": [
- "string"
], - "click_filter_preset_id": 0,
- "conversion_filter_preset_id": 0,
- "created_at": "string",
- "description": "string",
- "everflow_encoded_offers": [
- "string"
], - "everflow_encoded_publishers": [
- "string"
], - "filters": [
- {
- "block_on_reject": true,
- "invert": true,
- "settings": null,
- "target": "click",
- "type": "BOT"
}
], - "id": "string",
- "integration": "string",
- "last_updated_by": "string",
- "monitoring_mode": true,
- "name": "string",
- "name_with_id": "string",
- "offer_ids": [
- "string"
], - "organization": "string",
- "priority": 0,
- "publisher_ids": [
- "string"
], - "rtb_enabled": true,
- "tags": [
- "string"
], - "tags_meta": [
- {
- "color": "string",
- "created_at": "string",
- "id": "string",
- "last_updated_by": "string",
- "name": "string",
- "organization": "string",
- "updated_at": "string"
}
], - "updated_at": "string"
}
], - "meta": {
- "links": {
- "next": {
- "page[after]": "string",
- "page[before]": "string",
- "page[number]": 0,
- "page[size]": 0
}, - "prev": {
- "page[after]": "string",
- "page[before]": "string",
- "page[number]": 0,
- "page[size]": 0
}
}, - "total_count": 0,
- "total_page": 0
}
}
You can create a filter group within an integration.
integrationID required | string The Integration ID |
A JSON object containing filter group information
active | boolean When inactive, this filter group is not going to used. |
advertiser_ids | Array of strings unique A list of database ID of Clickshield advertisers that can use this filter group. |
click_filter_preset_id | integer The FilterPreset ID which is used to automatically populate the click filters. |
conversion_filter_preset_id | integer The FilterPreset ID which is used to automatically populate the conversion filters. |
description | string Description of the filter group. |
Array of objects (filters.Filter) The list of Filters to be used by the Gateway. | |
integration required | string Integration ID parent of this filter group. |
monitoring_mode | boolean MonitoringMode at filter group level. This takes precedence over Integration MonitoringMode. |
name required | string Friendly name of the filter group. |
offer_ids | Array of strings unique A list of Clickshield offers external ID or any offer ID that can use this filter group. |
organization required | string Organization parent of this filter group and integration. |
priority required | integer Priority used during matching in Gateway. An Integration can have multiple filter groups and if there are multiple equal matches score found by the Gateway, then priority is going to be considered. Priority value is unique from other Filter group instances. |
publisher_ids | Array of strings unique A list of database ID of Clickshield publishers that can use this filter group. |
rtb_enabled | boolean RTBEnabled at filter group level. This takes precedence over Integration RTBEnabled. |
tags | Array of strings <= 50 items A list of tags that is be used to categorize the filter group. |
{- "active": true,
- "advertiser_ids": [
- "string"
], - "click_filter_preset_id": 0,
- "conversion_filter_preset_id": 0,
- "description": "string",
- "filters": [
- {
- "block_on_reject": true,
- "invert": true,
- "settings": null,
- "target": "click",
- "type": "BOT"
}
], - "integration": "string",
- "monitoring_mode": true,
- "name": "string",
- "offer_ids": [
- "string"
], - "organization": "string",
- "priority": 0,
- "publisher_ids": [
- "string"
], - "rtb_enabled": true,
- "tags": [
- "string"
]
}
{- "created_item_id": "string"
}
You can bulk delete filter groups.
integrationID required | string The Integration ID |
organization | string The Organization ID of the filter group. |
An array of filter group IDs to delete
data | Array of strings |
{- "data": [
- "string"
]
}
{ }
You can bulk update the filter groups value.
integrationID required | string The Integration ID |
organization | string The Organization ID of the filter group. |
An array of filter group IDs to update
data | Array of strings |
monitoring_mode | boolean |
{- "data": [
- "string"
], - "monitoring_mode": true
}
{ }
You can read a filter group within an integration.
integrationID required | string The Integration ID |
filterGroupID required | string The Filter Group ID |
object (csapi.FilterGroup) |
{- "data": {
- "active": true,
- "advertiser_ids": [
- "string"
], - "click_filter_preset_id": 0,
- "conversion_filter_preset_id": 0,
- "created_at": "string",
- "description": "string",
- "everflow_encoded_offers": [
- "string"
], - "everflow_encoded_publishers": [
- "string"
], - "filters": [
- {
- "block_on_reject": true,
- "invert": true,
- "settings": null,
- "target": "click",
- "type": "BOT"
}
], - "id": "string",
- "integration": "string",
- "last_updated_by": "string",
- "monitoring_mode": true,
- "name": "string",
- "name_with_id": "string",
- "offer_ids": [
- "string"
], - "organization": "string",
- "priority": 0,
- "publisher_ids": [
- "string"
], - "rtb_enabled": true,
- "tags": [
- "string"
], - "tags_meta": [
- {
- "color": "string",
- "created_at": "string",
- "id": "string",
- "last_updated_by": "string",
- "name": "string",
- "organization": "string",
- "updated_at": "string"
}
], - "updated_at": "string"
}
}
You can delete a filter group within an integration.
integrationID required | string The Integration ID |
filterGroupID required | string The Filter Group ID |
{ }
You can update a filter group within an integration.
integrationID required | string The Integration ID |
filterGroupID required | string The Filter Group ID |
A JSON object containing filter group information
active | boolean |
advertiser_ids | Array of strings |
click_filter_preset_id | integer |
conversion_filter_preset_id | integer |
description | string |
Array of objects (filters.Filter) | |
monitoring_mode | boolean |
name | string |
offer_ids | Array of strings |
priority | integer |
publisher_ids | Array of strings |
rtb_enabled | boolean |
tags | Array of strings |
{- "active": true,
- "advertiser_ids": [
- "string"
], - "click_filter_preset_id": 0,
- "conversion_filter_preset_id": 0,
- "description": "string",
- "filters": [
- {
- "block_on_reject": true,
- "invert": true,
- "settings": null,
- "target": "click",
- "type": "BOT"
}
], - "monitoring_mode": true,
- "name": "string",
- "offer_ids": [
- "string"
], - "priority": 0,
- "publisher_ids": [
- "string"
], - "rtb_enabled": true,
- "tags": [
- "string"
]
}
{ }
The Reports API page[size]
limit is only 100. If you need to quickly and efficiently export a massive amount of data, we recommend to use the Download Center Export APIs.
Reports API methods use cursor-based pagination through the page[after]
and page[before]
parameters. Both parameters accept an existing value in transaction ID format which matches the objects real_tx_id
field.
The values to use can be found under pageInfo.startCursor
and pageInfo.endCursor
from the response and return objects in reverse chronological order. The page[before]
parameter returns objects listed before object.real_tx_id
. The page[after]
parameter returns objects listed after object.real_tx_id
. These parameters are mutually exclusive. You can use either the page[after]
or page[before]
parameter, but not both simultaneously.
data.pageInfo.startCursor
is the cursor of first object in the current page.data.pageInfo.endCursor
is the cursor of the last object in the current page. data.pageInfo.hasNextPage
shows you if there is a next page.data.pageInfo.hasPreviousPage
shows you if there is a previous page.GET /api/v2/reports/v2/conversion-table?page[size]=25&integration_id={integrationID}&start_date=2025-02-01&end_date=2025-02-27
Example response:
{
"data": {
"data": [
{
"real_tx_id": "ABC"
},
{
"real_tx_id": "............"
},
{
"real_tx_id": "XYZ"
}
],
"pageInfo": {
"startCursor": "ABC",
"endCursor": "XYZ",
"hasPreviousPage": true,
"hasNextPage": true
}
}
}
Fetch the next page by adding &page[after]=XYZ
in the request.
GET /api/v2/reports/v2/conversion-table?page[size]=25&integration_id={integrationID}&start_date=2025-02-01&end_date=2025-02-27&page[after]=XYZ'
Example response:
{
"data": {
"data": [
{
"real_tx_id": "{startCursor}"
},
{
"real_tx_id": "............"
},
{
"real_tx_id": "{endCursor}"
}
],
"pageInfo": {
"startCursor": "{startCursor}",
"endCursor": "{endCursor}",
"hasPreviousPage": true,
"hasNextPage": true
}
}
}
Use Download Center to export Clicks to a CSV file. Use Reporting filters to narrow down the data.
integrationID required | string The Integration ID |
delimiter | string Delimiter to be used in CSV. Default is comma. |
start_date | string <date> start date |
end_date | string <date> end date |
fields required | string The columns to include in the CSV |
extra_parameters required | string The extra parameters data that will be converted as columns in the CSV |
object (csapi.Artifact) | |
created_at | string |
error | string |
object new csapi fields | |
object (report.CSVExportFormat) | |
id required | string |
integration required | string |
last_updated_by | string |
organization required | string |
object nolint: lll | |
requested_by | string |
object (report.ReportsResultsMeta) | |
status required | string Enum: "PENDING" "IN_PROGRESS" "ERROR" "CANCELED" "COMPLETED" |
type required | string |
updated_at | string |
{- "artifact": {
- "download_link": "string",
- "meta": {
- "id": "string",
- "organization": "string",
- "type": "string"
}, - "name": "string",
- "size": 0
}, - "created_at": "string",
- "error": "string",
- "export_list_options": {
- "extra_parameters": [
- "string"
], - "fields": [
- "string"
], - "filters": {
- "booleans": {
- "property1": true,
- "property2": true
}, - "date_range": {
- "end": "string",
- "start": "string"
}, - "date_time_range": {
- "end": "string",
- "start": "string"
}, - "field_exists": {
- "property1": true,
- "property2": true
}, - "numbers": {
- "property1": {
- "property1": {
- "property1": [
- 0
], - "property2": [
- 0
]
}, - "property2": {
- "property1": [
- 0
], - "property2": [
- 0
]
}
}, - "property2": {
- "property1": {
- "property1": [
- 0
], - "property2": [
- 0
]
}, - "property2": {
- "property1": [
- 0
], - "property2": [
- 0
]
}
}
}, - "regex_query": {
- "fieldValue": "string",
- "searchableFields": [
- "string"
]
}, - "strings": {
- "property1": {
- "property1": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "property2": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}, - "property2": {
- "property1": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "property2": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
}, - "text_search": "string",
- "timeZone": "string"
}
}, - "format": {
- "delimiter": "string"
}, - "id": "string",
- "integration": "string",
- "last_updated_by": "string",
- "organization": "string",
- "reports_query_option": {
- "end_date": "string",
- "extra_parameters_as_new_fields": [
- "string"
], - "filters": {
- "property1": {
- "equal_values": [
- "string"
], - "greater_than_values": [
- 0
], - "less_than_values": [
- 0
], - "like_values": [
- "string"
], - "not_equal_values": [
- "string"
]
}, - "property2": {
- "equal_values": [
- "string"
], - "greater_than_values": [
- 0
], - "less_than_values": [
- 0
], - "like_values": [
- "string"
], - "not_equal_values": [
- "string"
]
}
}, - "include_fields": [
- "string"
], - "relative_date": "string",
- "sort_by": [
- {
- "is_descending": true,
- "name": "string"
}
], - "start_date": "string"
}, - "requested_by": "string",
- "results_meta": {
- "duration_seconds": 0,
- "range_truncated": true,
- "total": 0
}, - "status": "PENDING",
- "type": "string",
- "updated_at": "string"
}
Use Download Center to export Conversions to a CSV file. Use Reporting filters to narrow down the data.
integrationID required | string The Integration ID |
delimiter | string Delimiter to be used in CSV. Default is comma. |
start_date | string <date> start date |
end_date | string <date> end date |
fields required | string The columns to include in the CSV |
extra_parameters required | string The extra parameters data that will be converted as columns in the CSV |
object (csapi.Artifact) | |
created_at | string |
error | string |
object new csapi fields | |
object (report.CSVExportFormat) | |
id required | string |
integration required | string |
last_updated_by | string |
organization required | string |
object nolint: lll | |
requested_by | string |
object (report.ReportsResultsMeta) | |
status required | string Enum: "PENDING" "IN_PROGRESS" "ERROR" "CANCELED" "COMPLETED" |
type required | string |
updated_at | string |
{- "artifact": {
- "download_link": "string",
- "meta": {
- "id": "string",
- "organization": "string",
- "type": "string"
}, - "name": "string",
- "size": 0
}, - "created_at": "string",
- "error": "string",
- "export_list_options": {
- "extra_parameters": [
- "string"
], - "fields": [
- "string"
], - "filters": {
- "booleans": {
- "property1": true,
- "property2": true
}, - "date_range": {
- "end": "string",
- "start": "string"
}, - "date_time_range": {
- "end": "string",
- "start": "string"
}, - "field_exists": {
- "property1": true,
- "property2": true
}, - "numbers": {
- "property1": {
- "property1": {
- "property1": [
- 0
], - "property2": [
- 0
]
}, - "property2": {
- "property1": [
- 0
], - "property2": [
- 0
]
}
}, - "property2": {
- "property1": {
- "property1": [
- 0
], - "property2": [
- 0
]
}, - "property2": {
- "property1": [
- 0
], - "property2": [
- 0
]
}
}
}, - "regex_query": {
- "fieldValue": "string",
- "searchableFields": [
- "string"
]
}, - "strings": {
- "property1": {
- "property1": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "property2": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}, - "property2": {
- "property1": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "property2": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
}, - "text_search": "string",
- "timeZone": "string"
}
}, - "format": {
- "delimiter": "string"
}, - "id": "string",
- "integration": "string",
- "last_updated_by": "string",
- "organization": "string",
- "reports_query_option": {
- "end_date": "string",
- "extra_parameters_as_new_fields": [
- "string"
], - "filters": {
- "property1": {
- "equal_values": [
- "string"
], - "greater_than_values": [
- 0
], - "less_than_values": [
- 0
], - "like_values": [
- "string"
], - "not_equal_values": [
- "string"
]
}, - "property2": {
- "equal_values": [
- "string"
], - "greater_than_values": [
- 0
], - "less_than_values": [
- 0
], - "like_values": [
- "string"
], - "not_equal_values": [
- "string"
]
}
}, - "include_fields": [
- "string"
], - "relative_date": "string",
- "sort_by": [
- {
- "is_descending": true,
- "name": "string"
}
], - "start_date": "string"
}, - "requested_by": "string",
- "results_meta": {
- "duration_seconds": 0,
- "range_truncated": true,
- "total": 0
}, - "status": "PENDING",
- "type": "string",
- "updated_at": "string"
}
Use Download Center to export Impressions to a CSV file. Use Reporting filters to narrow down the data.
integrationID required | string The Integration ID |
delimiter | string Delimiter to be used in CSV. Default is comma. |
start_date | string <date> start date |
end_date | string <date> end date |
fields required | string The columns to include in the CSV |
extra_parameters required | string The extra parameters data that will be converted as columns in the CSV |
object (csapi.Artifact) | |
created_at | string |
error | string |
object new csapi fields | |
object (report.CSVExportFormat) | |
id required | string |
integration required | string |
last_updated_by | string |
organization required | string |
object nolint: lll | |
requested_by | string |
object (report.ReportsResultsMeta) | |
status required | string Enum: "PENDING" "IN_PROGRESS" "ERROR" "CANCELED" "COMPLETED" |
type required | string |
updated_at | string |
{- "artifact": {
- "download_link": "string",
- "meta": {
- "id": "string",
- "organization": "string",
- "type": "string"
}, - "name": "string",
- "size": 0
}, - "created_at": "string",
- "error": "string",
- "export_list_options": {
- "extra_parameters": [
- "string"
], - "fields": [
- "string"
], - "filters": {
- "booleans": {
- "property1": true,
- "property2": true
}, - "date_range": {
- "end": "string",
- "start": "string"
}, - "date_time_range": {
- "end": "string",
- "start": "string"
}, - "field_exists": {
- "property1": true,
- "property2": true
}, - "numbers": {
- "property1": {
- "property1": {
- "property1": [
- 0
], - "property2": [
- 0
]
}, - "property2": {
- "property1": [
- 0
], - "property2": [
- 0
]
}
}, - "property2": {
- "property1": {
- "property1": [
- 0
], - "property2": [
- 0
]
}, - "property2": {
- "property1": [
- 0
], - "property2": [
- 0
]
}
}
}, - "regex_query": {
- "fieldValue": "string",
- "searchableFields": [
- "string"
]
}, - "strings": {
- "property1": {
- "property1": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "property2": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}, - "property2": {
- "property1": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "property2": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
}, - "text_search": "string",
- "timeZone": "string"
}
}, - "format": {
- "delimiter": "string"
}, - "id": "string",
- "integration": "string",
- "last_updated_by": "string",
- "organization": "string",
- "reports_query_option": {
- "end_date": "string",
- "extra_parameters_as_new_fields": [
- "string"
], - "filters": {
- "property1": {
- "equal_values": [
- "string"
], - "greater_than_values": [
- 0
], - "less_than_values": [
- 0
], - "like_values": [
- "string"
], - "not_equal_values": [
- "string"
]
}, - "property2": {
- "equal_values": [
- "string"
], - "greater_than_values": [
- 0
], - "less_than_values": [
- 0
], - "like_values": [
- "string"
], - "not_equal_values": [
- "string"
]
}
}, - "include_fields": [
- "string"
], - "relative_date": "string",
- "sort_by": [
- {
- "is_descending": true,
- "name": "string"
}
], - "start_date": "string"
}, - "requested_by": "string",
- "results_meta": {
- "duration_seconds": 0,
- "range_truncated": true,
- "total": 0
}, - "status": "PENDING",
- "type": "string",
- "updated_at": "string"
}
Get a single click given the query parameters. An error is returned if there is no match.
integration_id required | string The Integration ID |
request_date required | string <date> The Click Time |
offer required | string The Offer |
publisher required | string The Publisher |
tx_id required | string The Transaction ID |
object (report.Click) |
{- "data": {
- "advertiser": "string",
- "advertiser_db_id": "string",
- "advertiser_id": "string",
- "asn": 0,
- "blocked": 0,
- "browser_language": [
- "string"
], - "browser_name": "string",
- "browser_timezone": "string",
- "browser_version": "string",
- "bundle_id": "string",
- "city": "string",
- "click_ip": "string",
- "country": "string",
- "coupon_code": "string",
- "device_id": "string",
- "device_type": "string",
- "external_transaction_id": "string",
- "extra_params.keys": [
- "string"
], - "extra_params.values": [
- "string"
], - "filter_group_id": "string",
- "final_offer": "string",
- "final_offer_id": "string",
- "fingerprint": "string",
- "integration_id": "string",
- "integration_type": "string",
- "invalid_sub_id": "string",
- "ip_network": "string",
- "is_bot": 0,
- "is_old_browser": 0,
- "is_old_os": 0,
- "isp": "string",
- "lat": 0,
- "long": 0,
- "manager_id": "string",
- "manager_name": "string",
- "monitoring_mode": 0,
- "offer": "string",
- "offer_db_id": "string",
- "offer_group_id": "string",
- "offer_id": "string",
- "organization_id": "string",
- "os_name": "string",
- "os_version": "string",
- "payout": 0,
- "postal_code": "string",
- "preview_url_enabled": 0,
- "proxy_type": "string",
- "publisher": "string",
- "publisher_db_id": "string",
- "real_advertiser": "string",
- "real_filter_group_id": "string",
- "real_offer_id": "string",
- "real_publisher": "string",
- "real_tx_id": "string",
- "referer": "string",
- "referer_categories": [
- "string"
], - "rejected_advanced_reason": "string",
- "rejected_language": "string",
- "rejected_primary_reason": "string",
- "rejected_simple_reason": "string",
- "rejection_type": "string",
- "rejections": [
- "string"
], - "request_date": "2019-08-24",
- "request_time": "2019-08-24T14:15:22Z",
- "revenue": 0,
- "rtb_url_used": 0,
- "rtt": 0,
- "server_region": "string",
- "smart_link_id": "string",
- "smartlink_db_id": "string",
- "status": "Approved",
- "sub_id": "string",
- "sub_id_2": "string",
- "sub_id_3": "string",
- "sub_id_4": "string",
- "sub_id_5": "string",
- "sub_id_6": "string",
- "tags": [
- "string"
], - "targeting_group_id": "string",
- "tx_id": "string",
- "user_agent": "string",
- "user_email": "string",
- "uuid": "string"
}
}
Get a single conversion or event given the query parameters. An error is returned if there is no match.
integration_id required | string The Integration ID |
request_date required | string <date> The Conversion Time |
offer required | string The Offer |
publisher required | string The Publisher |
hash required | string The Hash |
object (report.Conversion) |
{- "data": {
- "advertiser": "string",
- "advertiser_db_id": "string",
- "advertiser_name": "string",
- "app_id": "string",
- "app_version": "string",
- "asn": 0,
- "begin_install_time": "2019-08-24T14:15:22Z",
- "browser_language": [
- "string"
], - "browser_name": "string",
- "browser_timezone": "string",
- "browser_version": "string",
- "city": "string",
- "click_ip": "string",
- "click_time": "2019-08-24T14:15:22Z",
- "click_tx_id": "string",
- "conversion_ip": "string",
- "conversion_time": "2019-08-24T14:15:22Z",
- "country": "string",
- "coupon_code": "string",
- "device_id": "string",
- "device_type": "string",
- "event_db_id": "string",
- "event_id": 0,
- "event_name": "string",
- "event_status": 0,
- "external_transaction_id": "string",
- "extra_params.keys": [
- "string"
], - "extra_params.values": [
- "string"
], - "filter_group_id": "string",
- "fingerprint": "string",
- "finish_install_time": "2019-08-24T14:15:22Z",
- "hash": "string",
- "integration_id": "string",
- "integration_type": "string",
- "invalid_sub_id": "string",
- "ip_network": "string",
- "is_bot": 0,
- "is_click_spam": 0,
- "is_low_session_time": 0,
- "is_old_browser": 0,
- "is_old_os": 0,
- "isp": "string",
- "lat": 0,
- "long": 0,
- "manager_id": "string",
- "manager_name": "string",
- "network": "string",
- "offer": "string",
- "offer_db_id": "string",
- "offer_group_id": "string",
- "offer_id": "string",
- "offer_id_name": "string",
- "organization_id": "string",
- "os_name": "string",
- "os_version": "string",
- "payout": 0,
- "postal_code": "string",
- "proxy_type": "string",
- "publisher": "string",
- "publisher_db_id": "string",
- "publisher_name": "string",
- "purchase_value": 0,
- "real_advertiser": "string",
- "real_filter_group_id": "string",
- "real_offer_id": "string",
- "real_publisher": "string",
- "real_rejected_advanced_reason": "string",
- "real_rejected_simple_reason": "string",
- "real_tx_id": "string",
- "referer": "string",
- "referer_categories": [
- "string"
], - "rejected": 0,
- "rejected_advanced_reason": "string",
- "rejected_language": "string",
- "rejected_simple_reason": "string",
- "rejection_type": "string",
- "rejections": [
- "string"
], - "request_time": "2019-08-24T14:15:22Z",
- "revenue": 0,
- "risk": "string",
- "rtt": 0,
- "score": 0,
- "server_ip": "string",
- "server_region": "string",
- "session_time": 0,
- "smart_link_id": "string",
- "smartlink_db_id": "string",
- "status": "Approved",
- "sub_id": "string",
- "sub_id_2": "string",
- "sub_id_3": "string",
- "sub_id_4": "string",
- "sub_id_5": "string",
- "sub_id_6": "string",
- "tags": [
- "string"
], - "targeting_group_id": "string",
- "third_party_rejection_reason": "string",
- "third_party_status": "string",
- "tx_id": "string",
- "user_agent": "string",
- "user_email": "string",
- "uuid": "string"
}
}
integration_id required | string The Integration ID |
start_date required | string <date> Fetch data where request_time is starting from this date |
end_date required | string <date> Fetch data where request_time is until this date |
page[size] required | integer The number of items to return |
page[before] | string Fetch the previous data before this cursor |
page[after] | string Fetch the next data after this cursor |
object (report.ClickTable) |
{- "data": {
- "count": 0,
- "data": [
- {
- "advertiser": "string",
- "advertiser_db_id": "string",
- "advertiser_id": "string",
- "asn": 0,
- "blocked": 0,
- "browser_language": [
- "string"
], - "browser_name": "string",
- "browser_timezone": "string",
- "browser_version": "string",
- "bundle_id": "string",
- "city": "string",
- "click_ip": "string",
- "country": "string",
- "coupon_code": "string",
- "device_id": "string",
- "device_type": "string",
- "external_transaction_id": "string",
- "extra_params.keys": [
- "string"
], - "extra_params.values": [
- "string"
], - "filter_group_id": "string",
- "final_offer": "string",
- "final_offer_id": "string",
- "fingerprint": "string",
- "integration_id": "string",
- "integration_type": "string",
- "invalid_sub_id": "string",
- "ip_network": "string",
- "is_bot": 0,
- "is_old_browser": 0,
- "is_old_os": 0,
- "isp": "string",
- "lat": 0,
- "long": 0,
- "manager_id": "string",
- "manager_name": "string",
- "monitoring_mode": 0,
- "offer": "string",
- "offer_db_id": "string",
- "offer_group_id": "string",
- "offer_id": "string",
- "organization_id": "string",
- "os_name": "string",
- "os_version": "string",
- "payout": 0,
- "postal_code": "string",
- "preview_url_enabled": 0,
- "proxy_type": "string",
- "publisher": "string",
- "publisher_db_id": "string",
- "real_advertiser": "string",
- "real_filter_group_id": "string",
- "real_offer_id": "string",
- "real_publisher": "string",
- "real_tx_id": "string",
- "referer": "string",
- "referer_categories": [
- "string"
], - "rejected_advanced_reason": "string",
- "rejected_language": "string",
- "rejected_primary_reason": "string",
- "rejected_simple_reason": "string",
- "rejection_type": "string",
- "rejections": [
- "string"
], - "request_date": "2019-08-24",
- "request_time": "2019-08-24T14:15:22Z",
- "revenue": 0,
- "rtb_url_used": 0,
- "rtt": 0,
- "server_region": "string",
- "smart_link_id": "string",
- "smartlink_db_id": "string",
- "status": "Approved",
- "sub_id": "string",
- "sub_id_2": "string",
- "sub_id_3": "string",
- "sub_id_4": "string",
- "sub_id_5": "string",
- "sub_id_6": "string",
- "tags": [
- "string"
], - "targeting_group_id": "string",
- "tx_id": "string",
- "user_agent": "string",
- "user_email": "string",
- "uuid": "string"
}
], - "pageInfo": {
- "endCursor": "string",
- "hasNextPage": true,
- "hasPreviousPage": true,
- "startCursor": "string"
}
}
}
integration_id required | string The Integration ID |
start_date required | string <date> Fetch data where conversion_time is starting from this date |
end_date required | string <date> Fetch data where conversion_time is until this date |
page[size] required | integer The number of items to return |
page[before] | string Fetch the previous data before this cursor |
page[after] | string Fetch the next data after this cursor |
object (report.ConversionTable) |
{- "data": {
- "count": 0,
- "data": [
- {
- "advertiser": "string",
- "advertiser_db_id": "string",
- "advertiser_name": "string",
- "app_id": "string",
- "app_version": "string",
- "asn": 0,
- "begin_install_time": "2019-08-24T14:15:22Z",
- "browser_language": [
- "string"
], - "browser_name": "string",
- "browser_timezone": "string",
- "browser_version": "string",
- "city": "string",
- "click_ip": "string",
- "click_time": "2019-08-24T14:15:22Z",
- "click_tx_id": "string",
- "conversion_ip": "string",
- "conversion_time": "2019-08-24T14:15:22Z",
- "country": "string",
- "coupon_code": "string",
- "device_id": "string",
- "device_type": "string",
- "event_db_id": "string",
- "event_id": 0,
- "event_name": "string",
- "event_status": 0,
- "external_transaction_id": "string",
- "extra_params.keys": [
- "string"
], - "extra_params.values": [
- "string"
], - "filter_group_id": "string",
- "fingerprint": "string",
- "finish_install_time": "2019-08-24T14:15:22Z",
- "hash": "string",
- "integration_id": "string",
- "integration_type": "string",
- "invalid_sub_id": "string",
- "ip_network": "string",
- "is_bot": 0,
- "is_click_spam": 0,
- "is_low_session_time": 0,
- "is_old_browser": 0,
- "is_old_os": 0,
- "isp": "string",
- "lat": 0,
- "long": 0,
- "manager_id": "string",
- "manager_name": "string",
- "network": "string",
- "offer": "string",
- "offer_db_id": "string",
- "offer_group_id": "string",
- "offer_id": "string",
- "offer_id_name": "string",
- "organization_id": "string",
- "os_name": "string",
- "os_version": "string",
- "payout": 0,
- "postal_code": "string",
- "proxy_type": "string",
- "publisher": "string",
- "publisher_db_id": "string",
- "publisher_name": "string",
- "purchase_value": 0,
- "real_advertiser": "string",
- "real_filter_group_id": "string",
- "real_offer_id": "string",
- "real_publisher": "string",
- "real_rejected_advanced_reason": "string",
- "real_rejected_simple_reason": "string",
- "real_tx_id": "string",
- "referer": "string",
- "referer_categories": [
- "string"
], - "rejected": 0,
- "rejected_advanced_reason": "string",
- "rejected_language": "string",
- "rejected_simple_reason": "string",
- "rejection_type": "string",
- "rejections": [
- "string"
], - "request_time": "2019-08-24T14:15:22Z",
- "revenue": 0,
- "risk": "string",
- "rtt": 0,
- "score": 0,
- "server_ip": "string",
- "server_region": "string",
- "session_time": 0,
- "smart_link_id": "string",
- "smartlink_db_id": "string",
- "status": "Approved",
- "sub_id": "string",
- "sub_id_2": "string",
- "sub_id_3": "string",
- "sub_id_4": "string",
- "sub_id_5": "string",
- "sub_id_6": "string",
- "tags": [
- "string"
], - "targeting_group_id": "string",
- "third_party_rejection_reason": "string",
- "third_party_status": "string",
- "tx_id": "string",
- "user_agent": "string",
- "user_email": "string",
- "uuid": "string"
}
], - "pageInfo": {
- "endCursor": "string",
- "hasNextPage": true,
- "hasPreviousPage": true,
- "startCursor": "string"
}
}
}
integration_id required | string The Integration ID |
start_date required | string <date> Fetch data where request_time is starting from this date |
end_date required | string <date> Fetch data where request_time is until this date |
page[size] required | integer The number of items to return |
page[before] | string Fetch the previous data before this cursor |
page[after] | string Fetch the next data after this cursor |
object (report.ImpressionTable) |
{- "data": {
- "count": 0,
- "data": [
- {
- "advertiser": "string",
- "advertiser_db_id": "string",
- "advertiser_id": "string",
- "asn": 0,
- "blocked": 0,
- "browser_language": [
- "string"
], - "browser_name": "string",
- "browser_timezone": "string",
- "browser_version": "string",
- "bundle_id": "string",
- "city": "string",
- "click_ip": "string",
- "country": "string",
- "device_id": "string",
- "device_type": "string",
- "extra_params.keys": [
- "string"
], - "extra_params.values": [
- "string"
], - "filter_group_id": "string",
- "fingerprint": "string",
- "integration_id": "string",
- "integration_type": "string",
- "invalid_sub_id": "string",
- "ip_network": "string",
- "is_bot": 0,
- "is_old_browser": 0,
- "is_old_os": 0,
- "isp": "string",
- "lat": 0,
- "long": 0,
- "manager_id": "string",
- "manager_name": "string",
- "monitoring_mode": 0,
- "offer_db_id": "string",
- "offer_id": "string",
- "organization_id": "string",
- "os_name": "string",
- "os_version": "string",
- "payout": 0,
- "postal_code": "string",
- "proxy_type": "string",
- "publisher": "string",
- "publisher_db_id": "string",
- "real_advertiser": "string",
- "real_filter_group_id": "string",
- "real_offer_id": "string",
- "real_publisher": "string",
- "real_tx_id": "string",
- "referer": "string",
- "referer_categories": [
- "string"
], - "rejected_advanced_reason": "string",
- "rejected_language": "string",
- "rejected_primary_reason": "string",
- "rejected_simple_reason": "string",
- "rejection_type": "string",
- "rejections": [
- "string"
], - "request_date": "2019-08-24",
- "request_time": "2019-08-24T14:15:22Z",
- "revenue": 0,
- "rtt": 0,
- "server_region": "string",
- "site_url": "string",
- "site_url_categories": [
- "string"
], - "status": "string",
- "sub_id": "string",
- "sub_id_2": "string",
- "sub_id_3": "string",
- "sub_id_4": "string",
- "sub_id_5": "string",
- "sub_id_6": "string",
- "tags": [
- "string"
], - "targeting_group_id": "string",
- "tx_id": "string",
- "user_agent": "string",
- "user_email": "string",
- "uuid": "string"
}
], - "pageInfo": {
- "endCursor": "string",
- "hasNextPage": true,
- "hasPreviousPage": true,
- "startCursor": "string"
}
}
}
Get the signed url for a download center file. You need this URL in order to download the file.
artifact_name required | string The Download Export object artifact name |
url | string |
{- "url": "string"
}
List all the Download Center exports.
filter[reports_query_option.filters.offer_id.equalvalues] | Array of strings The offer IDs filter used in the exported data. |
filter[reports_query_option.filters.publisher.equalvalues] | Array of strings The publishers filter used in the exported data. |
filter[reports_query_option.filters.advertiser.equalvalues] | Array of strings The advertisers filter used in the exported data. |
filter[reports_query_option.filters.integration_id.equalvalues] | Array of strings The integration ID filter used in the exported data. |
filter[reports_query_option.start_date] | string <date> The start date filter used in the exported data. This is a string and date range logic does not apply. Use this if you know the exact start date filter used during the export. |
filter[reports_query_option.end_date] | string <date> The end date filter used in the exported data. This is a string and date range logic does not apply. Use this if you know the exact end date filter used during the export. |
filter[status] | string Enum: "UNKNOWN" "PENDING" "IN_PROGRESS" "ERROR" "CANCELED" The report export status |
filter[type] | string Enum: "conversion_logs" "click_logs" The report type |
filter[results_meta.total][gte] | integer Greater than or equals to the total number of rows of exported data. |
filter[results_meta.total][lte] | integer Less than or equals to the total number of rows of exported data. |
filter[results_meta.duration_seconds][gte] | integer Greater than or equals to the export completion time in seconds. |
filter[results_meta.duration_seconds][lte] | integer Less than or equals to the export completion time in seconds. |
Array of objects (report.DownloadCenterExport) | |
object (csapi.ListMeta) |
{- "data": [
- {
- "artifact": {
- "download_link": "string",
- "meta": {
- "id": "string",
- "organization": "string",
- "type": "string"
}, - "name": "string",
- "size": 0
}, - "created_at": "string",
- "error": "string",
- "export_list_options": {
- "extra_parameters": [
- "string"
], - "fields": [
- "string"
], - "filters": {
- "booleans": {
- "property1": true,
- "property2": true
}, - "date_range": {
- "end": "string",
- "start": "string"
}, - "date_time_range": {
- "end": "string",
- "start": "string"
}, - "field_exists": {
- "property1": true,
- "property2": true
}, - "numbers": {
- "property1": {
- "property1": {
- "property1": [
- 0
], - "property2": [
- 0
]
}, - "property2": {
- "property1": [
- 0
], - "property2": [
- 0
]
}
}, - "property2": {
- "property1": {
- "property1": [
- 0
], - "property2": [
- 0
]
}, - "property2": {
- "property1": [
- 0
], - "property2": [
- 0
]
}
}
}, - "regex_query": {
- "fieldValue": "string",
- "searchableFields": [
- "string"
]
}, - "strings": {
- "property1": {
- "property1": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "property2": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}, - "property2": {
- "property1": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "property2": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
}, - "text_search": "string",
- "timeZone": "string"
}
}, - "format": {
- "delimiter": "string"
}, - "id": "string",
- "integration": "string",
- "last_updated_by": "string",
- "organization": "string",
- "reports_query_option": {
- "end_date": "string",
- "extra_parameters_as_new_fields": [
- "string"
], - "filters": {
- "property1": {
- "equal_values": [
- "string"
], - "greater_than_values": [
- 0
], - "less_than_values": [
- 0
], - "like_values": [
- "string"
], - "not_equal_values": [
- "string"
]
}, - "property2": {
- "equal_values": [
- "string"
], - "greater_than_values": [
- 0
], - "less_than_values": [
- 0
], - "like_values": [
- "string"
], - "not_equal_values": [
- "string"
]
}
}, - "include_fields": [
- "string"
], - "relative_date": "string",
- "sort_by": [
- {
- "is_descending": true,
- "name": "string"
}
], - "start_date": "string"
}, - "requested_by": "string",
- "results_meta": {
- "duration_seconds": 0,
- "range_truncated": true,
- "total": 0
}, - "status": "PENDING",
- "type": "string",
- "updated_at": "string"
}
], - "meta": {
- "links": {
- "next": {
- "page[after]": "string",
- "page[before]": "string",
- "page[number]": 0,
- "page[size]": 0
}, - "prev": {
- "page[after]": "string",
- "page[before]": "string",
- "page[number]": 0,
- "page[size]": 0
}
}, - "total_count": 0,
- "total_page": 0
}
}
Get the Download Center export object.
exportID required | string The Export ID |
object (report.DownloadCenterExport) |
{- "data": {
- "artifact": {
- "download_link": "string",
- "meta": {
- "id": "string",
- "organization": "string",
- "type": "string"
}, - "name": "string",
- "size": 0
}, - "created_at": "string",
- "error": "string",
- "export_list_options": {
- "extra_parameters": [
- "string"
], - "fields": [
- "string"
], - "filters": {
- "booleans": {
- "property1": true,
- "property2": true
}, - "date_range": {
- "end": "string",
- "start": "string"
}, - "date_time_range": {
- "end": "string",
- "start": "string"
}, - "field_exists": {
- "property1": true,
- "property2": true
}, - "numbers": {
- "property1": {
- "property1": {
- "property1": [
- 0
], - "property2": [
- 0
]
}, - "property2": {
- "property1": [
- 0
], - "property2": [
- 0
]
}
}, - "property2": {
- "property1": {
- "property1": [
- 0
], - "property2": [
- 0
]
}, - "property2": {
- "property1": [
- 0
], - "property2": [
- 0
]
}
}
}, - "regex_query": {
- "fieldValue": "string",
- "searchableFields": [
- "string"
]
}, - "strings": {
- "property1": {
- "property1": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "property2": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}, - "property2": {
- "property1": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "property2": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
}, - "text_search": "string",
- "timeZone": "string"
}
}, - "format": {
- "delimiter": "string"
}, - "id": "string",
- "integration": "string",
- "last_updated_by": "string",
- "organization": "string",
- "reports_query_option": {
- "end_date": "string",
- "extra_parameters_as_new_fields": [
- "string"
], - "filters": {
- "property1": {
- "equal_values": [
- "string"
], - "greater_than_values": [
- 0
], - "less_than_values": [
- 0
], - "like_values": [
- "string"
], - "not_equal_values": [
- "string"
]
}, - "property2": {
- "equal_values": [
- "string"
], - "greater_than_values": [
- 0
], - "less_than_values": [
- 0
], - "like_values": [
- "string"
], - "not_equal_values": [
- "string"
]
}
}, - "include_fields": [
- "string"
], - "relative_date": "string",
- "sort_by": [
- {
- "is_descending": true,
- "name": "string"
}
], - "start_date": "string"
}, - "requested_by": "string",
- "results_meta": {
- "duration_seconds": 0,
- "range_truncated": true,
- "total": 0
}, - "status": "PENDING",
- "type": "string",
- "updated_at": "string"
}
}
Delete the Download Center export object and the associated file.
exportID required | string The Export ID |
{ }