Reports: list

Retrieves a list of reports. Try it now.


HTTP request



Parameter name Value Description
Path parameters
profileId long The DFA user profile ID.
Optional query parameters
maxResults integer Maximum number of results to return. Acceptable values are 0 to 10, inclusive. (Default: 10)
pageToken string The value of the nextToken from the previous result page.
scope string The scope that defines which results are returned.

Acceptable values are:
  • "ALL": All reports in account.
  • "MINE": My reports. (default)
sortField string The field by which to sort the list.

Acceptable values are:
  • "ID": Sort by report ID.
  • "LAST_MODIFIED_TIME": Sort by 'lastModifiedTime' field. (default)
  • "NAME": Sort by name of reports.
sortOrder string Order of sorted results.

Acceptable values are:
  • "ASCENDING": Ascending order.
  • "DESCENDING": Descending order. (default)


This request requires authorization with the following scope:


For more information, see the authentication and authorization page.

Request body

Do not supply a request body with this method.


If successful, this method returns a response body with the following structure:

  "kind": "dfareporting#reportList",
  "etag": etag,
  "nextPageToken": string,
  "items": [
    reports Resource
Property name Value Description Notes
kind string The kind of list this is, in this case dfareporting#reportList.
etag etag The eTag of this response for caching purposes.
nextPageToken string Continuation token used to page through reports. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
items[] list The reports returned in this response.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.