get https://{clientname}.koddi.io/event-collection/beacon?action=click
This endpoint allows tracking of click activity. This should be called when the ad is clicked or tapped.
The root URL and the tracking string are provided in the response to winning ads. It is imperative that [trackingData] is updated.
If you receive an error from this endpoint, it can be retried.
Inputs
| Field | Description | Required |
|---|---|---|
| action | click | Required |
| clientName | Your Name Your company name. Your Koddi team will provide this value. | Required |
| trackingData | [provided in winning ads] Data string provided in the winning ads response. | 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 5th ad position having rank = 2 9th position having rank = 3 Counting starts with 1, not zero. | Optional (must be included to be reportable) |
| testVersionOverride | 1,2,3 Unique test IDs. Koddi can provide guidance on testing. | Optional |
| destinationUrl | www.yoursite.com The final URL for the user to land on if using Koddi redirection. | 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 |