GET /admin/api/{api_version}/reports/{report_id}.json

Retrieves a list of reports. 

Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Make paginated requests to the REST Admin API.

Servers

Path parameters

Name Type Required Description
api_version String Yes
report_id String Yes

Request headers

Name Type Required Description
x-shopify-access-token String No

Query parameters

Name Type Required Description
fields String No

A comma-separated list of fields to include in the response.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.