Advertiser statistics

Documentation for all functionality to retrieve advertiser statistics using the Revive Adserver REST API, with breakdowns by day, by campaign, by banner, by publisher, or by zone. There are also a number of helpful notes about date ranges.

getAdvertiserDailyStatistics

Description: Returns advertiser’s statistics grouped by day, for a specified date range

Implementation: URL/adv/[advertiserId]/statistics/daily/[start_date]/[end_date]Method: GET

Json example

Method: 
    GET http://api.example.com/adv/2/statistics/daily/2018-06-12/2018-06-13

Response example

{
    "id": 2,
    "start_date": "2018-06-12",
    "end_date": "2018-06-13",
    "days": {
        "data": [
            {
                "impressions": 56,
                "clicks": 0,
                "requests": 66,
                "revenue": 0.0425,
                "day": "2018-06-12"
            },
            {
                "impressions": 42,
                "clicks": 0,
                "requests": 59,
                "revenue": 0.0319,
                "day": "2018-06-13"
            }
        ]
    }
}

Notes

See the notes at the end of the page with regard to date ranges and invalid advertiser IDs.

getAdvertiserCampaignStatistics

Description: Returns advertiser’s statistics grouped by campaign, for a specified date range

Implementation: URL/adv/[advertiserId]/statistics/campaign/[start_date]/[end_date]Method: GET

Json example

Method: 
    GET http://api.example.com/adv/2/statistics/campaign/2018-06-07/2018-06-13

Response example

{
    "id": 2,
    "start_date": "2018-06-07",
    "end_date": "2018-06-13",
    "campaigns": {
        "data": [
            {
                "impressions": "236",
                "clicks": "4",
                "requests": "306",
                "revenue": "0.1791",
                "campaignid": "4",
                "campaignname": "Statistics Demo Campaign"
            }
        ]
    }
}

Notes

See the notes at the end of the page with regard to date ranges and invalid advertiser IDs.

getAdvertiserBannerStatistics

Description: Returns advertiser’s statistics grouped by banner and campaign, for a specified date range

Implementation: URL/adv/[advertiserId]/statistics/banner/[start_date]/[end_date]Method: GET

Json example

Method: 
    GET http://api.example.com/adv/2/statistics/banner/2018-06-07/2018-06-13

Response example

{
    "id": 2,
    "start_date": "2018-06-07",
    "end_date": "2018-06-13",
    "banners": {
        "data": [
            {
                "impressions": "236",
                "clicks": "4",
                "requests": "306",
                "revenue": "0.1791",
                "campaignid": "4",
                "campaignname": "Statistics Demo Campaign",
                "bannerid": "12",
                "bannername": "Statistics Demo Banner"
            }
        ]
    }
}

Notes

See the notes at the end of the page with regard to date ranges and invalid advertiser IDs.

getAdvertiserPublisherStatistics

Description: Returns advertiser’s statistics grouped by publisher, for a specified date range

Implementation: URL/adv/[advertiserId]/statistics/publisher/[start_date]/[end_date]

Method: GET

Json example

Method: 
    GET http://api.example.com/adv/2/statistics/publisher/2018-06-07/2018-06-13

Response example

{
    "id": 2,
    "start_date": "2018-06-07",
    "end_date": "2018-06-13",
    "publishers": {
        "data": [
            {
                "impressions": "236",
                "clicks": "4",
                "requests": "306",
                "revenue": "0.1791",
                "publisherid": "4",
                "publishername": "Demo Statistics Website"
            }
        ]
    }
}

Notes

See the notes at the end of the page with regard to date ranges and invalid advertiser IDs.

getAdvertiserZoneStatistics

Description: Returns advertiser’s statistics grouped by zone and publisher, for a specified date range

Implementation: URL/adv/[advertiserId]/statistics/zone/[start_date]/[end_date]

Method: GET

Json example

Method: 
    GET http://api.example.com/adv/2/statistics/zone/2018-06-07/2018-06-13

Response example

{
    "id": 2,
    "start_date": "2018-06-07",
    "end_date": "2018-06-13",
    "zones": {
        "data": [
            {
                "impressions": "236",
                "clicks": "4",
                "requests": "306",
                "revenue": "0.1791",
                "publisherid": "4",
                "publishername": "Demo Statistics Website",
                "zoneid": "11",
                "zonename": "Demo Statistics Zone"
            }
        ]
    }
}

Notes

See the notes at the end of the page with regard to date ranges and invalid advertiser IDs.


Notes

  • The end date in the request is optional. If omitted, the response will consist of just one day (the start date)
  • If you omit both the start date and the end date, or use a invalid date notation for the start date, the end date, or perhaps even both, there will be a response indicating the problem, as follows, for example:
    {
        "error": {
            "type": "DateException",
            "message": "Start date is not valid"
        }
    }
  • Requesting statistics for a date range where the end date is earlier than the start date, results in the following response, for example:
    {
        "error": {
            "type": "Exception",
            "message": "The start date is after the end date"
        }
    }
  • Requesting statistics for a date range that does not have any data, results in the following response, for example:
    {
        "id": 1,
        "start_date": "2017-05-21",
        "end_date": "2017-05-27",
        "days": {
            "data": []
        }
    }
  • Requesting statistics for an advertiser that doesn’t exist results in the following response:
    {
        "error": {
            "type": "Exception",
            "message": "Unknown advertiserId Error"
        }
    }

Current version

The most recently released version of the Revive Adserver REST API is v4.3.0 (publication date May 28, 2018).

See Release Notes

Compatibility

Revive Adserver REST API is compatible with all versions of Revive Adserver v4.0 and higher. 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