Parameters

Adi Heymann -

Parameters are passed in JSON syntax.

List of allowed parameters

Field
Description
Required/Default
Example
 
 

dimensions
array of dimensions

Requested dimensions in report
(see Dimensions List, case insensitive)

Required
"dimensions":["supply","demand","user agent"]

start
unix timestamp 

Start timestamp for query results in UTC

Optional
Default: now - 48 hours

"start":1502975270

end
unix timestamp 

End timestamp for query results in UTC

Optional
Default: now

"end":1505653644
range
string
Replacement for start/end parameters. Allowed only OR range, OR start/end. See Ranges list for supported options. Most suitable for scheduled reports. Optional
"range":"yesterday"

filters
object

Allows filter response
dimensions filter allows filter report by: Supply/Demand ID, dates, etc., see example
measures filter allows filter report by values, for example, Impression RPM greater than or equal to 0.2 and less than or equal to 5. Supported operators: gt, gte, lt, lte (greater than, greater than or equal, less than, less than or equal)
Optional
"day":"2018-01-09","hour":"3:00"
"filters":{"impression rpm":{"gte":0.2, "lte":5}}

multifilters
object

Allows filter response, keys - dimensions. As values, can contains array. Optional
"hour":["3:00","4:00","5:00"]
format Format of response. Can be: "csv", "json" Optional
Default: json
"format":"csv"
timezone
string/integer
Allows to set time zone offset. By default all reports generated in GMT. Could be integer value, in format "UTC X", known timezones, see http://php.net/manual/en/timezones.php Optional "timezone":-5
"timezone":"UTC -5" 
"timezone":"EST" 
"timezone":"America/New_York"
measures
string/array
The measures requested in the response. If not set, all measures related to report will be returned (see Measures List, case insensitive) Optional
"measures":"ad requests"
"measures":["ad requests","revenue"]
email
string/array
When the report file is ready a link will be sent to this email/s Optional

"email":"john@doe.com"
"email":["john@doe.com","foo@bar.com"]
limit string The client can set a limit for the number of returned rows in report. All reports are limited by 1M rows. To get more than 1M rows, The client can create another report with offset parameter OptionalDefault: 1000000 "limit":1000
offset string If the report contains more than 1M rows, the client can create another request with the offset parameter to get the next number of rows for report OptionalDefault: 0 "offset":1000000

 

Dimensions List:

supply, demand, domain, app bundle, sub id, country, environment, day, hour, user agent, app name, supply type, player size, demand type, supply partner, demand partner

Measures List:

cost, ad requests, impressions, revenue, impression rpm, opportunities, rpm, fillrate %, demand fr

*note: not all measures exists on each report

Ranges List:

yesterday, today

Have more questions? Submit a request

0 Comments

Article is closed for comments.