API Queries - Domain Report

The domainreport function retrieves statistics on specified list of domains (up to 1,000 at a time - see note below). Additional parameters are required for this function.

Additional Parameters

• domains - The domain or domains to retrieves statistics for, comma separated (up to 1,000 per query - see note below). (Required)
• from_date & to_date - The report date range. Dates must be in the format YYYY-MM-DD. (Required)
• start - The starting offset for results. Default is 0 (Optional)
• num - The number of results to show from the report. Default is 100, maximum is 1,000 (Optional)
• demographics - This will display the hits from the top 10 countries. Default is "0" (disabled). Accepted values are "0" (disabled) and "1" (enabled). (Optional)
• format : Default= xml. Accepted values are 'csv' or 'xml' (Optional)

Note: For larger queries (when adding more than 100 domains at a time), you MUST use a POST request to ensure you do not reach any request length limitations.

Note: Make sure to URL encode all values.

Example query and response:

In this example, we will retrieve a report for domains abc123.com, efg456.com and lmn789.net (domains=abc123.com,efg456.com,lmn789.net) from 2009-03-01 (from_date=2009-03-01) to 2009-03-02 (to_date=2009-03-02).

Example query:
https://www.above.com/api.php?username=user&password=pass&api_key=key&mode=domainreport&domains=abc123.com,efg456.com,lmn789.net&from_date=2009-03-01&to_date=2009-03-31&start=0&num=100

Response:

			<results>
			Domain,Date,Service,Hits,Uniques,Reported,Clicks,Revenue,CTR,EPC,RPM,nCTR,nRPM
			abc123.com,2010-01-01,1,16966,9786,0,0,0,0.00,0.00,0.00,0.00,0.00
			abc123.com,2010-01-01,2,320790,36126,43969,161,123.66,0.37,0.77,2.81,0.45,3.42
			abc123.com,2010-01-02,1,0,0,7,0,0,0.00,0.00,0.00,0.00,0.00
			efg456.com,2010-01-01,4,0,0,1,0,0,0.00,0.00,0.00,0.00,0.00
			efg456.com,2010-01-01,10,0,0,1,0,0,0.00,0.00,0.00,0.00,0.00
			efg456.com,2010-01-02,1,2,2,2,2,0.06,100.00,0.03,30.00,100.00,30.00
			efg456.com,2010-01-02,2,0,0,1,0,0,0.00,0.00,0.00,0.00,0.00
			lmn789.net,2010-01-01,1,531,273,321,61,7.532,19.00,0.12,23.46,22.34,27.59
			lmn789.net,2010-01-01,2,0,0,1,0,0,0.00,0.00,0.00,0.00,0.00
			lmn789.net,2010-01-01,5,1274,706,718,133,30.66,18.52,0.23,42.70,18.84,43.43
			</results>
			

Error Responses:

Possible error responses for this function are:

• 410 - At least one domain must be specified
• 412 - Period, from_date and to_date combination or value is invalid
• General errors, such as 200 - Internal Error or 300 - Username or password invalid.