About the Reports API

Developer Preview
APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving this API. Your feedback is valuable to us.

With the Reports API you can create and manage reports for items that are reported by site visitors, such as comments. For example, if a site visitor finds offensive content, such as hate speech, they can report it, and the report will appear in the Wix user's dashboard.

With the Reports API, you can:

  • Create reports for the reported items.
  • Count how many times an item is reported for a specific reason.
  • Query all reports on the site, or use a filter to get the specific ones.
  • Delete individual reports or delete them in bulk using filters.

Terminology

  • Report: A record created when a site visitor reports content (for example, a comment) as inappropriate or against community guidelines. Each report includes details such as the reason for reporting, the identity of the reporter, and timestamps for creation and updates.
  • Resource: A component or feature within a Wix site that hosts content, such as a comment section, blog, or forum. A resource serves as the context in which entities, like individual comments, can be reported.
  • Reported item: The specific item flagged by a site visitor within a resource, such as a comment or post. Each reported item is identified by an entityName and an entityId.
  • Identity: Identity that can report a comment. For more information about identities, see this article.
Did this help?