| Table of Contents |
|---|
...
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 |
...
Field | API Representation | Description |
|---|---|---|
Impression Requests |
| Total impression requests that the site sends to Sharethrough. |
Server Impressions |
| When a bid wins our internal auction. For the majority of our supply we need to send this winning bid to participate in the publisher's downstream Header Bidding auction against other exchanges. |
Header Bidding Wins |
| Sharethrough wins the impression in the publisher ad server/HB wrapper auction and a signal is sent to the page, the impression is loaded but the assets are not yet rendered. |
Rendered Impressions |
| The served ad creative is rendered on the page. This is the payable event for publishers. |
Viewable Impressions |
| The ad comes at least 50% in view for at least 1 second. |
Earnings |
| Programmatic only. The estimated amount of revenue you’ve earned through the Sharethrough Exchange (STX)
Note: Your earnings are derived from rendered impressions |
CPM |
| The eCPM for the entries returned by the query. |
Clicks |
| The total number of times users clicked on ads |
CTR |
| Click-through rate (= clicks /rendered impressions)
The percentage of rendered impressions that a user clicks on |
Fill Rate |
| = (rendered impressions/impressions requests)*100 The percentage of ad calls being filled with a creative for a given placement |
Viewability Rate |
| = viewable impressions/ rendered impressions The percentage of paid impressions that are viewable |
Render Rate |
| = (rendered impressions/ received impressions)*100 Once an impression is won and loaded, the percentage of times the assets are actually appearing/rendered on a page. |
Video Starts |
| When 50% of the video placement is in view (no minimum time) and there is no error, the player starts |
Video Start Rate |
| = (Video starts/Rendered impressions)*100 The percentage of videos that come into view and start once the final auction is won and the ad is rendered. |
Video Views (3+ seconds) |
| How many users reached 3 seconds during the video |
Video Views (10+ seconds) |
| How many users reached 10 seconds during the video |
Video Views (15+ seconds) |
| How many users reached 15 seconds during the video |
Video Views (30+ seconds) |
| How many users reached 30 seconds during the video |
25% Content Completion |
| How many users reached 25% of the video |
50% Content Completion |
| How many users reached 50% of the video |
75% Content Completion |
| How many users reached 75% of the video |
95% Content Completion |
| How many users reached 95% of the video |
...