Paging

Starting with version 5.0.0 of the Revive Adserver REST API, it is possible to retrieve the statistics of objects in ‘pages’, instead of all statistics in one large response. This is especially useful for processing long date ranges or for retrieving the statistics of large sets of objects.

Parameter

Add /1 to the end of the URL to instruct the REST API to use the time zone preference set in the agency

Implementation: URL/[object_type]/[objectId]/statistics/[breakdown_type/[start_date]/[end_date]/?limit=X&page=Y

Method: GET

Usage

By adding the ?limit=X&page=Y parameter to the query, the developer can specify that the response should contain no more than X nodes, and also indicate the page being requested.

Json example

Method:

GET http://api.example.com//agc/1/statistics/daily/2019-01-23/2019-02-19?limit=7&page=1

This will retrieve statistics for a 28 day date range, but it will return only the first 7 days initially.

 

Response example

When requesting statistics using the above example query, the response will have an extra few lines at the end, helping the developer retrieve the next page of the response (if relevant).

{
    "id": 1,
    "start_date": "2019-01-23",
    "end_date": "2019-02-19",
    "days": {
        "data": [
            {
                "impressions": 105,
                "clicks": 0,
                "requests": 123,
                "revenue": 0.0794,
                "day": "2019-01-23"
            },
(abbreviated for clarity)
            {
                "impressions": 169,
                "clicks": 0,
                "requests": 207,
                "revenue": 0.1274,
                "day": "2019-01-29"
            }
        ]
    },
    "limit": 7,
    "page": 1,
    "next": "\/rest\/agc\/1\/statistics\/daily\/2019-01-23\/2019-02-19?limit=7&page=2"
}

Current version

The most recently released version of the Revive Adserver REST API is v5.0.0 (publication date February 20, 2019).

See Release Notes

Compatibility

Revive Adserver REST API is compatible with all versions of Revive Adserver v4.x and v5.0. It may also be compatible with Revive Adserver v3.x (and also with OpenX Source v2.8 and higher), but this can not be guaranteed.

Revive Adserver REST API is compatible with all supported versions of PHP, including PHP7.

Also see Technical Requirements, Product Content, and Installation Instructions.

Our Recent Tweets