# About the Member Reports API

The Member Reports API allows site members to report other members for inappropriate behavior, such as spam, impersonation, or harassment. When a member is reported, the site's Wix user receives a notification. The Wix user can then decide how to handle the report, for example by dismissing it or blocking the reported member. Reported members are listed in the site's dashboard.

With the Member Reports API, you can:

- [Report](fallback::https://dev.wix.com/docs/api-reference/crm/members-contacts/members/activity/member-reports/report-member) a member.
- [Query](fallback::https://dev.wix.com/docs/api-reference/crm/members-contacts/members/activity/member-reports/query-member-reports) member reports.
- [Delete](fallback::https://dev.wix.com/docs/api-reference/crm/members-contacts/members/activity/member-reports/delete-member-reports) all reports about a member.

To retrieve a per-member summary of reports, including how many times each member was reported and when they were last reported, use the [Member Report Overviews API](fallback::https://dev.wix.com/docs/api-reference/crm/members-contacts/members/activity/member-report-overview-v1/introduction).

## Before you begin

It's important to note the following points before starting to code:

- A site must have the [Wix Members Area](fallback::https://www.wix.com/app-market/web-solution/members-area) installed from the App Market.
- [Report Member](fallback::https://dev.wix.com/docs/api-reference/crm/members-contacts/members/activity/member-reports/report-member) must be called by a site member. The member who creates the report is identified from the call's identity.
- A member can't report themselves, and blocked or offline members can't be reported. The site owner and site contributors can't report other members or be reported.
- When a member is deleted from the site, all reports they created and all reports about them are deleted.

## Use cases

- [Notify members who are reported for spam](fallback::https://dev.wix.com/docs/api-reference/crm/members-contacts/members/activity/member-reports/sample-use-cases-and-flows#notify-members-who-are-reported-for-spam)
- [Prevent abuse of the reporting system](fallback::https://dev.wix.com/docs/api-reference/crm/members-contacts/members/activity/member-reports/sample-use-cases-and-flows#prevent-abuse-of-the-reporting-system)
- [Clear reports after resolving them](fallback::https://dev.wix.com/docs/api-reference/crm/members-contacts/members/activity/member-reports/sample-use-cases-and-flows#clear-reports-after-resolving-them)

## Terminology

- **Member**: A person who signed up to a site's Members Area. Members can access features or content that aren't available to site visitors.
- **Member report**: A report submitted by a member to inform the Wix user about inappropriate behavior by another member. Each report has a reason category, such as spam or harassment.
- **Reported member**: A member who has at least 1 report about them.

@sdk_package_setup

# Member Reports: Supported Filters and Sorting

The following table shows field support for filters and sorting for the Member Report object:

| Fields                | Supported Filters                                                              | Sortable |
|-----------------------|--------------------------------------------------------------------------------|----------|
| `id`                  | `$eq`, `$ne`, `$in`, `$nin`, `$exists`, `$hasSome`, `$startsWith`               | Sortable |
| `reportedMemberId`    | `$eq`, `$ne`, `$in`, `$nin`, `$exists`, `$hasSome`, `$startsWith`               | Sortable |
| `reportingMemberId`   | `$eq`, `$ne`, `$in`, `$nin`, `$exists`, `$hasSome`, `$startsWith`               | Sortable |
| `reason`              | `$eq`, `$ne`, `$in`, `$nin`, `$exists`, `$hasSome`, `$startsWith`               | Sortable |
| `createdDate`         | `$eq`, `$ne`, `$in`, `$nin`, `$exists`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte`| Sortable |

# Member Reports: Sample Flows

This article presents possible use cases and corresponding sample flows that you can support. It provides a useful starting point as you plan your implementation.

## Notify members who are reported for spam

You may want to notify members when they're reported for spam. For example, if a member repeatedly posts promotional links in a forum and is reported for spam, a notification gives them a chance to correct their behavior or appeal.

> **Prerequisite:** [Create an email template](fallback::https://support.wix.com/en/article/email-marketing-creating-and-sending-a-campaign-from-start-to-finish) to send to members who are reported for spam.

To notify members who are reported for spam:

1. Listen for [Member Report Created](fallback::https://dev.wix.com/docs/api-reference/crm/members-contacts/members/activity/member-reports/member-report-created). When the event is triggered, check whether `createdEvent.entity.reason.category` is `"SPAM"`. If it is, save `createdEvent.entity.reportedMemberId`.
1. Call [Get Member](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::c2c7e954-db95-4415-b007-b20819f79374slug::get-member*fallback::https://dev.wix.com/docs/rest/crm/members-contacts/members/members/get-member) with the saved reported member ID as `id`, and save `member.loginEmail`.
1. Send the email template to the saved email address.

## Prevent abuse of the reporting system

Members could misuse the reporting system, for example by submitting false or repeated reports to target another member. Tracking how often each member submits reports helps you detect this and keeps the Wix user's review workload manageable.

To prevent abuse of the reporting system:

1. Listen for [Member Report Created](fallback::https://dev.wix.com/docs/api-reference/crm/members-contacts/members/activity/member-reports/member-report-created). When the event is triggered, save `createdEvent.entity.reportingMemberId`.
1. Call [Query Member Reports](fallback::https://dev.wix.com/docs/api-reference/crm/members-contacts/members/activity/member-reports/query-member-reports), filtering by the saved reporting member ID and by `createdDate` for the time frame you want to check. Count the returned reports.
1. If the count exceeds your threshold, [block](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::c2c7e954-db95-4415-b007-b20819f79374slug::block-member*fallback::https://dev.wix.com/docs/rest/crm/members-contacts/members/members/block-member) the reporting member.

## Clear reports after resolving them

After the Wix user handles reports about a member, for example by contacting the member or confirming the reports were unfounded, you may want to clear those reports so the member no longer appears as reported.

To clear reports about a member:

1. Call [Query Member Reports](fallback::https://dev.wix.com/docs/api-reference/crm/members-contacts/members/activity/member-reports/query-member-reports), filtering by `reportedMemberId`, to retrieve the reports about the member and show them to the Wix user.
1. After the Wix user resolves the reports, call [Delete Member Reports](fallback::https://dev.wix.com/docs/api-reference/crm/members-contacts/members/activity/member-reports/delete-member-reports) with the member's ID as `memberId`.
1. Optionally, listen for [Reported Member Deleted](fallback::https://dev.wix.com/docs/api-reference/crm/members-contacts/members/activity/member-reports/member-report-reported-member-deleted) to update any external system that tracks reported members.