| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Description: This endpoint allows tracking of impression activity. It should be called when the ad is shown for the first time to a user. Each ad impression should only be reported once. The root URL and tracking string are provided in the response to winning ads (both are included within the [impression_tracking_url] value sent in the post winning ads response).
Changes: It is imperative that [trackingData] is updated to value sent in post winning ads response. Other fields (rank, ts, etc) are optional.
Note: Parameter rank is 1-based as opposed to 0-based, and counts from the first available organic slot available.
Handling Errors: Endpoint should not error. If you receive an error from this endpoint, please direct it to the appropriate Koddi contact.
Inputs
| Field | Description | Required |
|---|---|---|
| action | impression | Required |
| clientName | Your Name Your client identifier configured by Koddi for your integration. Your Koddi team will provide this value. | Required |
| trackingData | Data string provided by Koddi in the response to the related POST Winning Ads call. This value uniquely identifies the auction, ad group, and advertiser and must be passed exactly as received. | 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 the 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 before any reordering on your side. Can replace rank parameter depending on your rank purposes. | Optional (must be included to be reportable) |
| ts | timestamp The timestamp at which the impression occurred. | Optional |
| beaconIssued | 2021-07-12T19:10:05 The timestamp the beacon was generated from the associated winning ads call. Pass this value exactly as received. | Required |
| overrides | {encrypted({"cpc": 1.5, "rank": 1})} Enables you to override the auction results used during impressions reporting. Please discuss with your Koddi team before using this feature. | Optional |