| Table of Contents |
|---|
...
| Note |
|---|
Be sure to not share your API key to keep your data secure. Also, all API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. |
API Endpoint
Method
POST: https://reporting-api.sharethrough.com/v2/programmatic/supply
Required Header
Authorization: Bearer $TOKEN_STRING
...
Parameter | Required? | Description | Example |
|---|---|---|---|
| Required | Start date of the data | "2020-03-01" |
| Required | End date of the data | "2020-03-01" |
| Required | Publishers you wish to pull data for | ["publisherKey1", "publisherKey2"] |
| Required | Metric fields you wish to pull | ["wins", "clicks"] |
| Optional | Add in case you wish to group your data by any dimensions listed. Below (up to 6). | ["publisher_name", "site_name"] |
| Optional. If specified a value of no more than 3 filterBy objects as defined by separate table below | Add in case you wish to filter your data by any dimensions listed below (up to 3) | [ {field: ”publisher_name”, value: “Test Pub”}, {field: “site_name”, value: “Some site name”} ] |
| Optional | Must be a valid IANA timezone. If not specified, results are returned by UTC timezone. (list here) |
|
| Optional | Requests also return timestamp and a query ID that can be shared with Sharethrough for debugging purposes | "debug": true |
...