Campaign statistics

Documentation for all functionality to retrieve campaign statistics using the Revive Adserver REST API, with breakdowns by day, by hourby banner, by publisher, or by zone. The details of the conversions that have been recorded for a campaign can also be retrieved. There are also a number of helpful notes about date ranges.

getCampaignDailyStatistics

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

Implementation: URL/cam/[campaignId]/statistics/daily/[start_date]/[end_date]

Method: GET

Json example

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

Response example

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

Notes

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

getCampaignHourlyStatistics

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

Implementation: URL/cam/[campaignId]/statistics/daily/[start_date]
Method: GET

Json example

Method: 
    GET http://api.example.com/cam/4/statistics/hourly/2018-10-17

Response example

{
    "id": 4,
    "start_date": "2018-10-17",
    "end_date": "2018-10-17",
    "hours": {
        "data": [
            {
                "requests": "10",
                "impressions": "9",
                "clicks": "0",
                "revenue": "0.0068",
                "day": "2018-10-17",
                "hour": "1"
            },
            {
                "requests": "13",
                "impressions": "11",
                "clicks": "0",
                "revenue": "0.0083",
                "day": "2018-10-17",
                "hour": "2"
            },
            {
                "requests": "1",
                "impressions": "0",
                "clicks": "0",
                "revenue": "0.0000",
                "day": "2018-10-17",
                "hour": "3"
            },
(truncated for clarity)
        ]
    }
}

Notes

  • Hourly statistics is supported starting with version 4.4.0 of the Revive Adserver REST API. It also requires the use of the core Revive Adserver software with version 5.0 or higher.
  • The current version supports retrieval of hourly statistics for a single day. If hourly statistics are needed for a range of days, retrieve them for each day separately.
  • If there are no statistics for a specific hour, that hour will be skipped in the results.
  • See the notes at the end of the page with regard to date ranges and invalid campaign IDs.

getCampaignBannerStatistics

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

Implementation: URL/cam/[campaignId]/statistics/banner/[start_date]/[end_date]

Method: GET

Json example

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

Response example

{
    "id": 4,
    "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 campaign IDs.

getCampaignPublisherStatistics

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

Implementation: URL/cam/[campaignId]/statistics/publisher/[start_date]/[end_date]

Method: GET

Json example

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

Response example

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

Notes

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

getCampaignZoneStatistics

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

Implementation: URL/cam/[campaignId]/statistics/zone/[start_date]/[end_date]

Method: GET

Json example

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

Response example

{
    "id": 4,
    "start_date": "2018-06-07",
    "end_date": "2018-06-13",
    "zones": {
        "data": [
            {
                "impressions": "236",
                "clicks": "4",
                "requests": "306",
                "revenue": "0.1791",
                "conversions": "0",
                "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 campaign IDs.

getCampaignConversionStatistics

Description: Returns a campaign’s conversions, for a specified date range

Implementation: URL/cam/[campaignId]/statistics/conversion/[start_date]/[end_date]

Method: GET

Json example

Method: 
    GET http://api.example.com/cam/3/statistics/conversion/2018-04-01/2018-04-30

Response example

{
    "id": 3,
    "start_date": "2018-04-01",
    "end_date": "2018-04-30",
    "conversions": {
        "data": [
            {
                "campaignID": "3",
                "trackerID": "1",
                "bannerID": "11",
                "conversionTime": "2018-04-26 17:53:40",
                "conversionStatus": "4",
                "userIp": "89.200.67.132",
                "action": "1",
                "window": 5,
                "variables": null
            }
        ]
    }
}

Notes

See the notes at the end of the page with regard to date ranges and invalid campaign 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 a campaign that doesn’t exist results in the following response:
    {
        "error": {
            "type": "Exception",
            "message": "Unknown campaignId Error"
        }
    }

Current version

The most recently released version of the Revive Adserver REST API is v4.5.0 (publication date November 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