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
curl -X POST \ https://www.wixapis.com/reports/v2/reports/query \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'Authorization: <AUTH>' \
  -d '{
        "query": {
            "filter": {
              "entityId": {
                "$eq": "50353fbc-b265-4f03-888f-a53aa272758d"
              }
            }
        }
  }'
Response
JSON
{
  "reports": [
    {
      "id": "dd7cfd02-1837-4fb8-bc6f-86316f0984a9",
      "entityName": "comment",
      "entityId": "50353fbc-b265-4f03-888f-a53aa272758d",
      "identity": {
        "identityType": "MEMBER",
        "memberId": "141a3e01-da55-4b3a-a44a-2f194bfc8897"
      },
      "reason": {
        "reasonType": "DRUGS",
        "description": "This person promotes drug usage."
      },
      "revision": "1",
      "createdDate": "2021-10-26T17:22:10.299Z",
      "updatedDate": "2021-10-26T17:22:10.299Z"
    },
    {
      "id": "2e776fae-80b6-4a5e-b6b9-891d8bc4d481",
      "entityName": "comment",
      "entityId": "50353fbc-b265-4f03-888f-a53aa272758d",
      "identity": {
        "identityType": "MEMBER",
        "memberId": "141a3e01-da55-4b3a-a44a-2f194bfc8897"
      },
      "reason": {
        "reasonType": "UNAUTHORIZED_SALES",
        "description": "This person sells illegal stuff."
      },
      "revision": "1",
      "createdDate": "2021-10-26T17:22:10.299Z",
      "updatedDate": "2021-10-26T17:22:10.299Z"
    }
  ]
}
Errors

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

Did this help?