05-10-2022: Changes in AdReal API
Starting from 5 of October we are presenting changes in AdReal API. We recommend to get familiar with API changes and prepare to update and adjust tools using API. Please find the scope of changes below.
Changes in parameters
Parameters periods and platform won't be in use anymore. Instead of that, you can use parameters periods_range and platforms.
Examples
Was:
- https://adreal.gemius.com/api/pl/stats/?periods=week_20220103,week_20220110,week_20220117&platforms=pc&segments=brand_owner,website&metrics=ad_cont
- https://adreal.gemius.com/api/pl/stats/?platform=pc&periods_range=20220103,20220103,week&segments=brand_owner,website&metrics=ad_cont
Will be:
- https://adreal.gemius.com/api/pl/stats/?periods_range=20220103,20220117,week&platforms=pc&segments=brand_owner,website&metrics=ad_cont
- https://adreal.gemius.com/api/pl/stats/?platforms=pc&periods_range=20220103,20220103,week&segments=brand_owner,website&metrics=ad_cont
Changes in data presentation
The uncertainty percentage value, previously returned as a caption, will be returned as a fractional number. In addition, the uncertainty key in the result will contain a dictionary with values for each indicator separately, rather than a single value for all metrics as before.
Example
Was:
Will be:
Limit of the numbers of records
Maximum value of the limit parameter for endpoint /stats/ is set on 10000. This is the maximum number of records that can be returned on one page of results. To download all the results of a query you need to use the value returned in the next parameter, which is a link to the next page of results and is returned until the last available results page.
Example
