API Queries - Reportlist

The reportlist function retrieves a list of all generated reports and their statuses. To retrieve any report from the list, you can use the Fetch API function. Additional parameters are optional for this function.

Additional Parameters

start - Report record to start from. Default is 0 (Optional)
num - How many report records to show. Default is 100 (Optional)

Note: Make sure to URL encode all values.

Example query and response:

Example query:
https://www.above.com/api.php?username=user&password=pass&api_key=key&mode=reportlist&start=0&num=100

Response:

<results>

<resultgenerated="2010-09-07 03:52:43"group_by="domain"reportid="12348"status="Generating"/>

<resultfrom_date="2010-09-07"generated="2010-09-06 18:25:12"group_by="domain"reportid="12347" 

status="Completed"to_date="2010-09-07"/> 

<resultfrom_date="2009-03-01"generated="2010-09-05 18:23:23"group_by="domain"reportid="12346" 

status="Completed"to_date="2009-03-31"/>  

<resultfrom_date="2010-08-01"generated="2010-09-04 23:24:04"group_by="domain"reportid="12345" 

services="SEDO"status="Completed"to_date="2010-08-02"/> 

</results>

Error Responses:

Possible error responses for this function are:

General errors, such as 200 - Internal Error or 300 - Username or password invalid.

For a complete list of error responses, see the Error Codes manual page.