Site Domain Performance report

The Site Domain Performance report can be used to view performance and optimization data by domain for a specific advertiser.

For instructions on retrieving a report, please see Report Service or see the example below. For an advertiser user, the advertiser ID is detected based on the user's authentication. For a network user, however, 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:

• yesterday
• last_7_days
• month_to_date
• month_to_yesterday

If you use the start_date and end_date fields to define the time range, the start_date must not be more than 45 days in the past. Since hourly data is not available for this report, start_date and end_date cannot be identical and must be formatted as "YYYY-MM-DD" rather than "YYYY-MM-DD HH:MM:SS". Report data can be returned only for the UTC timezone.

Data retention period

Data retention period for this report is 45 days.

Dimensions

Metrics

Age buckets

Example

Create a JSON formatted report request

$ cat domain_performance

{
    "report":
    {
        "report_type": "site_domain_performance",
        "columns": [
            "day",
            "campaign",
            "booked_revenue",
            "imps",
            "clicks",
            "click_thru_pct",
            "site_domain"
        ]
        "report_interval": "last_7_days",
        "emails": ["js@mynetwork.com"],
        "format": "csv"
    }
}

POST the request to the reporting service

In this example, we request execution of the report for advertiser 660.

$ curl -b cookies -c cookies -X POST -d @domain_performance 'https://api.appnexus.com/report?advertiser_id=660'

{
    "response":{
        "status":"OK",
        "report_id":"07af1282c9485adcef49c95fa5d7496b"
    }
}

Use the report ID to retrieve the report data

The standard response includes the report data and a Download URL that you can use to save the data to a file. If you want to get just the Download URL without the report data, pass "without_data" in the query string.

$ curl -b cookies -c cookies 'https://api.appnexus.com/report?id=07af1282c9485adcef49c95fa5d7496b'

{
    "response": {
        "status": "OK",
        "report": {
            "name": null,
            "created_on": "2011-11-16 23:51:14",
            "cache_hit": false,
            "fact_cache_hit": false,
            "fact_cache_error": "fact-cache is off for report site_domain_performance",
            "json_request": "{\"report\":{\"report_type\":\"site_domain_performance\",\"columns\":[\"day\",\"campaign",
             "booked_revenue\",\"imps\",\"clicks\",\"click_thru_pct\",\"site_domain\"],\"report_interval\":\"last_7_days\",
             \"emails\":[\"js@mynetwork.com\"],\"filters\":[{\"buyer_member_id\":\"329\"},{\"advertiser_id\":\"660\"}]}}",
            "header_info": "Report type:,site_domain_performance\u000d\u000a,\u000d\u000aRun at:,2011-11-16 23:51:14\u000d\
             u000aStart date:,2011-11-09 00:00:00\u000d\u000aEnd date:,2011-11-16 00:00:00\u000d\u000aTimezone:,\u000d\
             u000aUser:,John Smith (9685)\u000d\u000a",
            "data": "day,campaign,booked_revenue,imps,clicks,click_thru_pct,site_domain\u000d\u000a2011-11-12,ExampleCampaign - 1
             (123456),.000000,24,0,.000000000000000000%,aaaa.com\u000d\u000a2011-11-13,ExampleCampaign - 2 (789012),.000000,9,0,
             .000000000000000000%,bbbb.net\u000d\u000a2011-11-12,ExampleCampaign - 3 (345678),.000000,2,0,.000000000000000000%,
             ccc.com\u000d\u000a2011-11-13,ExampleCampaign - 3 (345678),.000000,2,0,.000000000000000000%,cccc.de\u000du000a
             2011-11-14,ExampleCampaign - 3 (345678),.000000,10,0,.000000000000000000%,dddd.com\u000d\u000a2011-11-13,
             ExampleCampaign - 4 (901234), 2.574900,22,3,13.636363636363636364%,aaaa.com\u000d\u000a2011-11-15,ExampleCampaign - 3
             (345678),8.583000,2431,10,.411353352529823118%,abab.com\
             ...
            "url": "report-download?id=495d03a7667bac467bb488043ae336e9"
        },
        "execution_status": "ready"
    }
}

Use the download URL to save the report data to a file

You use the "url" field in the response to save the report data to a file. Simply make another GET call and identify the location and file that you want to save to. Be sure to use the file the extension of the "format" that you specified in your initial POST request.

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