> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # QueryMemberReports # Package: activity # Namespace: MemberReports # Method link: https://dev.wix.com/docs/api-reference/crm/members-contacts/members/activity/member-reports/query-member-reports.md ## Permission Scopes: Manage Members: SCOPE.DC-MEMBERS.MANAGE-MEMBERS ## Introduction Retrieves a list of member reports, given the provided paging, filtering, and sorting. Query Member Reports runs with these defaults, which you can override: - `createdDate` is sorted in `ASC` order - `paging.limit` is `100` - `paging.offset` is `0` To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md), [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging.md), and [Field Projection](https://dev.wix.com/docs/rest/articles/getting-started/field-projection.md). --- ## REST API ### Schema ``` Method: queryMemberReports Description: Retrieves a list of member reports, given the provided paging, filtering, and sorting. Query Member Reports runs with these defaults, which you can override: - `createdDate` is sorted in `ASC` order - `paging.limit` is `100` - `paging.offset` is `0` To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md), [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging.md), and [Field Projection](https://dev.wix.com/docs/rest/articles/getting-started/field-projection.md). URL: https://www.wixapis.com/members/v1/member-reports/query Method: POST Method parameters: param name: query | type: QueryV2 - name: filter | type: object | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md) for more details. - name: sorting | type: array | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC - name: paging | type: CursorPaging | description: Paging options to limit and skip the number of items. - name: limit | type: integer | description: The number of items to load. Default: `100` - name: cursor | type: string | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. Return type: QueryMemberReportsResponse - name: memberReports | type: array | description: Retrieved member reports. - name: id | type: string | description: Report GUID. - name: reportedMemberId | type: string | description: GUID of the reported member. - name: reportingMemberId | type: string | description: GUID of the member who created the report. - name: reason | type: Reason | description: Reason for reporting a member. - name: category | type: Category | description: Report reason type. - enum: - UNKNOWN: Unknown category. This value is unused. - SPAM: The member is reported for spam. - IMPERSONATION: The member is reported for impersonation. - HARASSMENT: The member is reported for harassment. - OTHER: The member is reported for other reasons. - name: description | type: string | description: Explanation of why the member is being reported. - name: createdDate | type: string | description: Date and time the report was created. - name: pagingMetadata | type: PagingMetadataV2 | description: Metadata for the paginated results. - name: count | type: integer | description: Number of items returned in the response. - name: offset | type: integer | description: Offset that was requested. - name: total | type: integer | description: Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. - name: tooManyToCount | type: boolean | description: Flag that indicates the server failed to calculate the `total` field. - name: cursors | type: Cursors | description: Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. ``` ### Examples ### Query Member Reports Retrieve member reports with reported member IDs and limit to one page ```curl curl -X POST \ https://www.wixapis.com/members/v1/member-reports/query \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Authorization: ' \ -d '{ "query": { "filter": { "reportedMemberId": [ "50353fbc-b265-4f03-888f-a53aa272758d", "e62e3011-55cf-4de3-a497-e097b52d86b7" ] }, "paging": { "limit": 1 } } }' ``` ### Query Member Reports Retrieve all member reports ```curl curl -X POST \ https://www.wixapis.com/members/v1/member-reports/query \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Authorization: ' \ -d '{}' ``` ### Query Member Reports Retrieve member reports by the reported member ID ```curl curl -X POST \ https://www.wixapis.com/members/v1/member-reports/query \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Authorization: ' \ -d '{ "query": { "filter": { "reportedMemberId": "e62e3011-55cf-4de3-a497-e097b52d86b7" } } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.activity.MemberReports.queryMemberReports(query) Description: Retrieves a list of member reports, given the provided paging, filtering, and sorting. Query Member Reports runs with these defaults, which you can override: - `createdDate` is sorted in `ASC` order - `paging.limit` is `100` - `paging.offset` is `0` To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md), [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging.md), and [Field Projection](https://dev.wix.com/docs/rest/articles/getting-started/field-projection.md). Method parameters: param name: query | type: Member_reportQuery - name: filter | type: object | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md) for more details. - name: sorting | type: array | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC - name: paging | type: CursorPaging | description: Paging options to limit and skip the number of items. - name: limit | type: integer | description: The number of items to load. Default: `100` - name: cursor | type: string | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. Return type: PROMISE - name: memberReports | type: array | description: Retrieved member reports. - name: _id | type: string | description: Report GUID. - name: reportedMemberId | type: string | description: GUID of the reported member. - name: reportingMemberId | type: string | description: GUID of the member who created the report. - name: reason | type: Reason | description: Reason for reporting a member. - name: category | type: Category | description: Report reason type. - enum: - UNKNOWN: Unknown category. This value is unused. - SPAM: The member is reported for spam. - IMPERSONATION: The member is reported for impersonation. - HARASSMENT: The member is reported for harassment. - OTHER: The member is reported for other reasons. - name: description | type: string | description: Explanation of why the member is being reported. - name: _createdDate | type: Date | description: Date and time the report was created. - name: pagingMetadata | type: PagingMetadataV2 | description: Metadata for the paginated results. - name: count | type: integer | description: Number of items returned in the response. - name: offset | type: integer | description: Offset that was requested. - name: total | type: integer | description: Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. - name: tooManyToCount | type: boolean | description: Flag that indicates the server failed to calculate the `total` field. - name: cursors | type: Cursors | description: Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. ``` ### Examples ### queryMemberReports ```javascript import { memberReport } from '@wix/members'; async function queryMemberReports(query) { const response = await memberReport.queryMemberReports(query); }; ``` ### queryMemberReports (with elevated permissions) ```javascript import { memberReport } from '@wix/members'; import { auth } from '@wix/essentials'; async function myQueryMemberReportsMethod(query) { const elevatedQueryMemberReports = auth.elevate(memberReport.queryMemberReports); const response = await elevatedQueryMemberReports(query); } ``` ### queryMemberReports (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { memberReport } from '@wix/members'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { memberReport }, // Include the auth strategy and host as relevant }); async function queryMemberReports(query) { const response = await myWixClient.memberReport.queryMemberReports(query); }; ``` ---