Instances List

Returns a list of instances for a report that you requested to be run asynchronously. Each item in the list is treated as a separate instance of the report run with metadata in that snapshot of time.

Resource URL 

1/services/data/<latest API version>/analytics/reports/<report ID>/instances

Formats 

JSON

HTTP Methods 

MethodDescription
GETReturn a list of asynchronous runs of a report. See this example.

Response Body 

PropertyTypeDescription
idStringUnique ID for a report instance that was requested for a run. The ID is used to obtain results of the report run for that instance.
statusStringNew if the report run has just been triggered through a POST request, Success if the report ran, Running if the report is being run, or Error if the report run failed. The instance of a report run can return an error if, for example, your permission to access the report has been removed since you requested the run.
urlStringURL where results of the report run for that instance are stored. The value is null if the report couldn’t be run because of an error.
ownerIdStringAPI name of the user that created the instance.
hasDetailRowsBooleanWhen false, indicates that summary level data was requested for the report run. When true, indicates that detailed data, which includes summary level data, was requested for the report run.
completionDateDate, time stringDate, time when the instance of the report run finished. Only available if the report instance ran successfully or couldn’t be run because of an error. Date-time information is in ISO-8601 format.
requestDateDate, time stringDate and time when an instance of the report run was requested. Date-time information is in ISO-8601 format.

See Also