POST

Query Reports

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of reports, given the provided paging, filtering, and sorting. Query Reports runs with these defaults, which you can override:

  • createdDate is sorted in ASC order
  • paging.limit is 100
  • paging.offset is 0

For field support for filters and sorting, see Reports: Supported Filters and Sorting. To learn about working with Query endpoints, see API Query Language.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Reports
Read Reports
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/reports/v2/reports/query
Body Params
queryQuery

Query options. See API Query Language for more details.

Response Object
reportsArray <Report>maxItems 100

List of reports.

pagingMetadataPagingMetadata

Paging metadata.

Query Reports
Request
cURL
Response
JSON
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?