Advertiser analytics

The Advertiser Analytics report can be used to view performance, revenue, and profit data across a specific advertiser's creatives and campaigns. This report is available to network and advertiser users.

For instructions on retrieving a report, see Report Service or the example below. This report requires specifying the advertiser ID as part of the URL, for example:

https://api.appnexus.com/report?advertiser_id=ADVERTISER_ID

Time frame

The report_interval field in the JSON request can be set to one of the following:

• current_hour
• last_hour
• today
• yesterday
• last_48_hours
• last_2_days
• last_7_days
• last_30_days
• month_to_date
• month_to_yesterday
• quarter_to_date
• last_month
• lifetime

Data retention period

Most data in this report is maintained permanently (exceptions noted below). After:

• 100 days, you are no longer able to report on hourly data. However, daily, monthly and cumulative intervals are still available.
• 14 months, you are no longer able to report on individual:
  • Creatives
  • Placements
  • Brands

In some cases Analytics reports can show delivery that does not match statistics shown elsewhere in Microsoft Invest or Microsoft Monetize for a given advertiser or publisher. This is due to the way that Analytics reporting data older than 100 days and 14 months are aggregated. The data from Billing reports are kept in non-aggregated form indefinitely. For more information, see Dates and Times in Reporting in the UI documentation.

Dimensions

Metrics

Examples

Create a JSON-formatted report request

$ cat advertiser_analytics 
 
{ 
    "report": { 
        "report_type":"advertiser_analytics", 
        "columns": [ 
            "hour", 
            "seller_member_id", 
            "campaign_id", 
            "gender", 
            "imps", 
            "clicks", 
            "total_convs", 
            "ctr", 
            "convs_rate"
        ], 
        "report_interval": "last_48_hours", 
        "format":"csv" 
    } 
}

POST the request to the reporting service

You POST the JSON request and get back a report ID.

$ curl -b cookies -c cookies -X post -d @advertiser_analytics "https://api.appnexus.com/report?advertiser_id=690" 
 
{
    "response": {
        "status": "OK",
        "report_id": "2790c6627d058cd467f4267add49bedc",
        "existing": true,
        "dbg_info": {
            ...
        }
    }
}

GET the report status from the report service

Make a GET call with the report ID to retrieve the status of the report. Continue making this call until the execution_status is "ready". Then use the report-download service to save the reporting data to a file (described in the next step).

$ curl -b cookies -c cookies "https://api.appnexus.com/report?id=dc0314bda06597582518c5fc3e1c47ef" 
 
{
    "response": {
        "status": "OK",
        "report": {
            "name": null,
            "created_on": "2014-04-17 01:26:00",
            "cache_hit": false,
            "fact_cache_hit": false,
            "fact_cache_error": "did not find any cache table for 1,3,6,44,30,31,32,34,15",
            "json_request": "{\"report\":{\"report_type\":\"advertiser_analytics\",\"columns\":[\"hour\",\"seller_member_id\",\"campaign_id\",\"gender\",\"imps\",\"clicks\",\"total_convs\",\"ctr\",\"convs_rate\"],\"report_interval\":\"last_48_hours\",\"format\":\"csv\",\"filters\":[{\"buyer_member_id\":\"948\"},{\"advertiser_id\":\"78216\"},{\"imp_type_id\":{\"operator\":\"!=\",\"value\":6}}]}}",
            "header_info": "Report ID:,2790c6627d058be467f4267add49bedc\r\nRun at:,2014-04-17 01:26:00\r\nStart date:,2014-04-15 01:00:00\r\nEnd date:,\r\nTimezone:,\r\nUser:,Jesse Seldess (9685)\r\n",
            "row_count": "0",
            "report_size": "75",
            "user_id": "9685",
            "entity_id": "0",
            "started_on": "2014-04-17 01:26:03",
            "finished_on": "2014-04-17 01:28:02",
            "query_time": "118",
            "url": "report-download?id=2790c6627d058be467f4267add49bedc"
        },
        "execution_status": "ready",
        "dbg_info": {
            ...
        }
    }
}

GET the report data from the report download service

To download the report data to a file, make another GET call with the report ID, but this time to the report-download service. You can find the service and report ID in the url field of the previous GET response. When identifying the file that you want to save to, be sure to use the file extension of the "format" that you specified in your initial POST.

$ curl -b cookies -c cookies 'https://api.appnexus.com/report-download?id=b97897a7864dd8f34e7457226c7af592' > /tmp/advertiser_analytics.csv