> 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 # QueryReferralEvent # Package: referralProgram # Namespace: ReferralEvents # Method link: https://dev.wix.com/docs/api-reference/business-management/marketing/referral-program/referral-tracker/query-referral-event.md ## Permission Scopes: Manage Referrals: SCOPE.DC-REFERRALS.MANAGE-REFERRALS ## Introduction Retrieves a list of referral events, given the provided paging, filtering, and sorting. To learn about working with Query endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection). --- ## REST API ### Schema ``` Method: queryReferralEvent Description: Retrieves a list of referral events, given the provided paging, filtering, and sorting. To learn about working with Query endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection). URL: https://www.wixapis.com/v1/referral-events/query Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: query Method parameters: param name: query | type: CursorQuery | required: true - name: cursorPaging | type: CursorPaging | description: Cursor paging options. Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#cursor-paging). - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#filters). - name: sort | type: array | description: Sort object. Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#sorting). - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC Return type: QueryReferralEventResponse - name: referralEvents | type: array | description: List of referral events. - ONE-OF: - name: referredFriendSignupEvent | type: ReferredFriendSignupEvent | description: Event triggered when a referred friend signs up. - name: referredFriendId | type: string | description: GUID of the referred friend. - name: successfulReferralEvent | type: SuccessfulReferralEvent | description: Event triggered when a referral is successful. For example, customer places and pays for an order. - name: referredFriendId | type: string | description: GUID of the referred friend. - name: referringCustomerId | type: string | description: GUID of the referring customer. - name: actionEvent | type: ActionEvent | description: Event triggered when an action is performed. For example, placing an order. - name: referredFriendId | type: string | description: GUID of the referred friend. - name: referringCustomerId | type: string | description: GUID of the referring customer. - name: trigger | type: Trigger | description: Trigger for the action. - name: appId | type: string | description: GUID of the app that triggered the event. - name: activityType | type: string | description: Type of activity that triggered the event. - name: amount | type: string | description: Amount associated with the action. - name: currency | type: string | description: Currency of the amount. - name: orderId | type: string | description: GUID of the associated order. - name: rewardEvent | type: RewardEvent | description: Event triggered when a reward is given. - name: referralRewardId | type: string | description: GUID of the referral reward. - name: rewardType | type: Reward | description: Type of reward. - enum: - UNKNOWN: Unknown reward. This field is not used. - COUPON: Reward is a coupon. - LOYALTY_POINTS: Reward is loyalty points. - NOTHING: No reward. - name: id | type: string | description: Referral event GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the referral event is updated. To prevent conflicting changes, the current revision must be passed when updating the referral event. - name: createdDate | type: string | description: Date and time the referral event was created. - name: updatedDate | type: string | description: Date and time the referral event was last updated. - name: metadata | type: CursorPagingMetadata | description: Metadata for the paginated results. - name: count | type: integer | description: Number of items returned in current page. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - 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. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### Query Referral Event ```curl curl -X POST \ 'https://www.wixapis.com/_api/referral-tracker/v1/referral-events/query' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ -d '{ "query": { "filter": { "createdDate": { "$gt": "2024-06-08T00:00:00.000Z" } } } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.referralProgram.ReferralEvents.queryReferralEvent(query) Description: Retrieves a list of referral events, given the provided paging, filtering, and sorting. To learn about working with Query endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection). # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: query Method parameters: param name: query | type: ReferralEventQuery | required: true - name: cursorPaging | type: CursorPaging | description: Cursor paging options. Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#cursor-paging). - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#filters). - name: sort | type: array | description: Sort object. Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#sorting). - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC Return type: PROMISE - name: referralEvents | type: array | description: List of referral events. - ONE-OF: - name: referredFriendSignupEvent | type: ReferredFriendSignupEvent | description: Event triggered when a referred friend signs up. - name: referredFriendId | type: string | description: GUID of the referred friend. - name: successfulReferralEvent | type: SuccessfulReferralEvent | description: Event triggered when a referral is successful. For example, customer places and pays for an order. - name: referredFriendId | type: string | description: GUID of the referred friend. - name: referringCustomerId | type: string | description: GUID of the referring customer. - name: actionEvent | type: ActionEvent | description: Event triggered when an action is performed. For example, placing an order. - name: referredFriendId | type: string | description: GUID of the referred friend. - name: referringCustomerId | type: string | description: GUID of the referring customer. - name: trigger | type: Trigger | description: Trigger for the action. - name: appId | type: string | description: GUID of the app that triggered the event. - name: activityType | type: string | description: Type of activity that triggered the event. - name: amount | type: string | description: Amount associated with the action. - name: currency | type: string | description: Currency of the amount. - name: orderId | type: string | description: GUID of the associated order. - name: rewardEvent | type: RewardEvent | description: Event triggered when a reward is given. - name: referralRewardId | type: string | description: GUID of the referral reward. - name: rewardType | type: Reward | description: Type of reward. - enum: - UNKNOWN: Unknown reward. This field is not used. - COUPON: Reward is a coupon. - LOYALTY_POINTS: Reward is loyalty points. - NOTHING: No reward. - name: _id | type: string | description: Referral event GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the referral event is updated. To prevent conflicting changes, the current revision must be passed when updating the referral event. - name: _createdDate | type: Date | description: Date and time the referral event was created. - name: _updatedDate | type: Date | description: Date and time the referral event was last updated. - name: metadata | type: CursorPagingMetadata | description: Metadata for the paginated results. - name: count | type: integer | description: Number of items returned in current page. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - 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. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### queryReferralEvent ```javascript import { tracker } from '@wix/referral'; async function queryReferralEvent(query) { const response = await tracker.queryReferralEvent(query); }; ``` ### queryReferralEvent (with elevated permissions) ```javascript import { tracker } from '@wix/referral'; import { auth } from '@wix/essentials'; async function myQueryReferralEventMethod(query) { const elevatedQueryReferralEvent = auth.elevate(tracker.queryReferralEvent); const response = await elevatedQueryReferralEvent(query); } ``` ### queryReferralEvent (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 { tracker } from '@wix/referral'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { tracker }, // Include the auth strategy and host as relevant }); async function queryReferralEvent(query) { const response = await myWixClient.tracker.queryReferralEvent(query); }; ``` ---