Updated: June 29th, 2018

Advertiser Order Plays Report

The page explains how an advertiser may use the Adomni API to review what has played as part of one of their orders over a given time period.

Assumptions

For the purposes of this paper we will assume that the user already has an advertiser account on Adomni.com, and has access to the credentials for that account. We also assume the user has already created an order (by performing a checkout against a cart). If you haven't done that yet, you may wish to read about performing a programmatic checkout.

Order plays report overview
Step 1 - Perform login

The customer generates a valid token for their owner account using the POST /access-token endpoint. More detail on the login process can be found here.

Step 2 - Select a time range.

The start and end times for this endpoint are expressed in terms of the UNIX "epoch". This eliminates possible issues with time zone confusion. Select a start and end date appropriately.

Step 3 - Execute your query

Visit the URL of the format /advertiser/reports/plays/orders/{orderId}/{start}/{end}. So, for example, if I wanted to see the content that has played for order between timestamp 1529737200 and 1529823600, I would visit https://neon.adomni.com/v0/advertiser/reports/plays/orders/98/1529737200/1529823600 (supplying the correct login token, of course.

Results

Every entry in the results will contain the fields contentId, orderId, and timestamp. These may be collated to see the results by order, time, or content, respectively.