| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
This endpoint allows tracking of impression activity. It should be called when the ad is shown for the first time to a user.
The root URL is provided in the response to winning ads. It is imperative that [trackingData] is updated.
Note: Parameter rank is 1-based as opposed to 0-based, and counts from the first available organic slot available.
If you receive an error from this endpoint, it can be retried.
Inputs
| Field | Description | Required |
|---|---|---|
| action | impression | Required |
| clientName | Your Name Your company name. Your Koddi team will provide this value. | Required |
| trackingData | Data string provided by Koddi in the response to the related POST Winning Ads call. | Required |
| rank | 1 The rank of the ad unit displayed. Please note this is not equivalent to the overall rank of the ad position. Example: Your program has 3 static ad slots, in the 2nd, 5th, and 9th overall positions on the page. The rank values would be as follows: 2nd ad position having rank = 1 Counting starts with 1, not zero. | Optional (must be included to be reportable) |
| onsite_paid_rank | The rank of the ad unit displayed. Should match the rank parameter value. Can replace rank parameter depending on your rank purposes. | Optional (must be included to be reportable) |
| onsite_organic_rank | The overall rank of the ad position. Example: Your program has 3 static ad slots, in the 2nd, 5th, and 9th overall positions on the page. The rank values would be as follows: 2nd ad position having rank = 2 Counting starts with 1, not zero. Can replace rank parameter depending on your rank purposes. | Optional (must be included to be reportable) |
| auction_rank | The rank returned by Koddi as a result of the auction Can replace rank parameter depending on your rank purposes. | Optional (must be included to be reportable) |
| ts | timestamp | Optional |
| beaconIssued | 2021-07-12T19:10:05 The timestamp the beacon was generated from the associated winning ads call. | Required |
| overrides | {encrypted({"cpc": 1.5, "rank": 1})} Enables you to override the auction results. Please discuss with your Koddi team before using this feature. | Optional |