> To build or manage a Wix site with an AI agent, follow https://www.wix.com/headless/skill.md
> It builds a new Wix site or puts your own site online, from a prompt, and keeps changing it afterwards. The pages are code in any web technology, and Wix runs the backend.
> It works through the Wix plugin (the Wix MCP and the Wix skills), the Wix CLI or no Wix login, and puts the site live on Wix hosting or on another host.
> Business features include a store, bookings, events and tickets, a restaurant, a blog, forms, members and many more.
> Read the Wix skills online at https://www.wix.com/skills
> 
> 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`).
> - If a reference page seems to be missing its schema (parameters, return types, or type definitions), append `?schema=true` to its `.md` URL (e.g. `https://dev.wix.com/docs/contexts/contexts/stores/category-info/use-category-info-context.md?schema=true`).
> - 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?apiView=SDK.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/_api/referral-tracker/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.  | validation: minimum 0, maximum 100, format int32
        - 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.  | validation: maxLength 16000
        - 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<Sorting> | description: Sort object.  Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#sorting).  | validation: maxItems 5
           - name: fieldName | type: string | description: Name of the field to sort by.  | validation: maxLength 512
           - name: order | type: SortOrder | description: Sort order.  
                 - enum: ASC, DESC
           - name: origin | type: AddressLocation | description: Origin point for geo-distance sorting on a GEO field results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).  
              - name: latitude | type: number | description: Address latitude.  | validation: format double
              - name: longitude | type: number | description: Address longitude.  | validation: format double
 Query fields:
   - field: referredFriendSignupEvent | operators: $exists | sort: ASC, DESC | aggregatable: undefined | searchable: undefined
   - field: successfulReferralEvent | operators: $exists | sort: ASC, DESC | aggregatable: undefined | searchable: undefined
   - field: actionEvent | operators: $exists | sort: ASC, DESC | aggregatable: undefined | searchable: undefined
   - field: rewardEvent | operators: $exists | sort: ASC, DESC | aggregatable: undefined | searchable: undefined
   - field: createdDate | operators: $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte | sort: ASC, DESC | aggregatable: undefined | searchable: undefined
   - field: updatedDate | operators: $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte | sort: ASC, DESC | aggregatable: undefined | searchable: undefined
 Return type: QueryReferralEventResponse
  - name: referralEvents | type: array<ReferralEvent> | 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.  | validation: format GUID
        - 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.  | validation: format GUID
           - name: referringCustomerId | type: string | description: GUID of the referring customer.  | validation: format GUID
        - 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.  | validation: format GUID
           - name: referringCustomerId | type: string | description: GUID of the referring customer.  | validation: format GUID
           - 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.  
           - ONE-OF: 
              - name: rewardedReferringCustomerId | type: string | description: GUID of the rewarded referring customer.  | read-only: true | validation: format GUID
              - name: rewardedReferredFriendId | type: string | description: GUID of the rewarded referred friend.  | read-only: true | validation: format GUID
           - name: referralRewardId | type: string | description: GUID of the referral reward.  | validation: format GUID
           - 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.  | read-only: true | validation: format 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.  | validation: format int64, immutable
     - name: createdDate | type: string | description: Date and time the referral event was created.  | read-only: true | validation: format date-time
     - name: updatedDate | type: string | description: Date and time the referral event was last updated.  | read-only: true | validation: format date-time
  - name: metadata | type: CursorPagingMetadata | description: Metadata for the paginated results.  
     - name: count | type: integer | description: Number of items returned in current page.  | validation: format int32
     - 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.  | validation: maxLength 16000
        - name: prev | type: string | description: Cursor pointing to the previous page in the list of results.  | validation: maxLength 16000
     - 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: <AUTH>' \
  -H 'Content-Type: application/json' \
  -d '{
        "query": {
            "filter": {
              "createdDate": {
                "$gt": "2024-06-08T00:00:00.000Z"
              }
            }
        }
    }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.referral.tracker.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.  | validation: minimum 0, maximum 100, format int32
        - 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.  | validation: maxLength 16000
        - 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<Sorting> | description: Sort object.  Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#sorting).  | validation: maxItems 5
           - name: fieldName | type: string | description: Name of the field to sort by.  | validation: maxLength 512
           - name: order | type: SortOrder | description: Sort order.  
                 - enum: ASC, DESC
           - name: origin | type: AddressLocation | description: Origin point for geo-distance sorting on a GEO field results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).  
              - name: latitude | type: number | description: Address latitude.  
              - name: longitude | type: number | description: Address longitude.  
 Query fields:
   - field: referredFriendSignupEvent | operators: $exists | sort: ASC, DESC | aggregatable: undefined | searchable: undefined
   - field: successfulReferralEvent | operators: $exists | sort: ASC, DESC | aggregatable: undefined | searchable: undefined
   - field: actionEvent | operators: $exists | sort: ASC, DESC | aggregatable: undefined | searchable: undefined
   - field: rewardEvent | operators: $exists | sort: ASC, DESC | aggregatable: undefined | searchable: undefined
   - field: _createdDate | operators: $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte | sort: ASC, DESC | aggregatable: undefined | searchable: undefined
   - field: _updatedDate | operators: $eq, $ne, $in, $exists, $gt, $gte, $lt, $lte | sort: ASC, DESC | aggregatable: undefined | searchable: undefined
 Return type: PROMISE<QueryReferralEventResponse>
  - name: referralEvents | type: array<ReferralEvent> | 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.  | validation: format GUID
        - 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.  | validation: format GUID
           - name: referringCustomerId | type: string | description: GUID of the referring customer.  | validation: format GUID
        - 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.  | validation: format GUID
           - name: referringCustomerId | type: string | description: GUID of the referring customer.  | validation: format GUID
           - 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.  
           - ONE-OF: 
              - name: rewardedReferringCustomerId | type: string | description: GUID of the rewarded referring customer.  | read-only: true | validation: format GUID
              - name: rewardedReferredFriendId | type: string | description: GUID of the rewarded referred friend.  | read-only: true | validation: format GUID
           - name: referralRewardId | type: string | description: GUID of the referral reward.  | validation: format GUID
           - 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.  | read-only: true | validation: format 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.  | validation: format int64, immutable
     - name: _createdDate | type: Date | description: Date and time the referral event was created.  | read-only: true 
     - name: _updatedDate | type: Date | description: Date and time the referral event was last updated.  | read-only: true 
  - name: metadata | type: CursorPagingMetadata | description: Metadata for the paginated results.  
     - name: count | type: integer | description: Number of items returned in current page.  | validation: format int32
     - 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.  | validation: maxLength 16000
        - name: prev | type: string | description: Cursor pointing to the previous page in the list of results.  | validation: maxLength 16000
     - 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-managed)
Self-managed 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);
};
```

---