Wix openapi-node

Global

Type Definitions

GetActivitiesOptions

Get Activities Query Options

Type:
  • Object
Properties:
Name Type Argument Description
pageSize Number <nullable>

The number of results to return per page of data. Valid options are: 25, 50 and 100. Defaults to 25
activityTypes string <nullable>

The activity types to filter against. Multiple activity types are separated by a comma
until dateTime <nullable>

The ending date for activities we want to return, as an ISO 8601 timestamp This field is only relevant when a cursor is not present
from dateTime <nullable>

The beginning date for activities we want to return, as an ISO 8601 timestamp. This field is only relevant when a cursor is not present
scope string <nullable>

The scope of the results to return, either for the entire site or limited to the current application. Can either be site or app. By default, all activities for the site will be returned
Source:
  • WixClient.js

GetActivitiesOptions

Get Activities Query Options

Type:
  • Object
Properties:
Name Type Argument Description
pageSize Number <nullable>

The number of results to return per page of data. Valid options are: 25, 50 and 100. Defaults to 25
activityTypes string <nullable>

The activity types to filter against. Multiple activity types are separated by a comma
until dateTime <nullable>

The ending date for activities we want to return, as an ISO 8601 timestamp This field is only relevant when a cursor is not present
from dateTime <nullable>

The beginning date for activities we want to return, as an ISO 8601 timestamp. This field is only relevant when a cursor is not present
scope string <nullable>

The scope of the results to return, either for the entire site or limited to the current application. Can either be site or app. By default, all activities for the site will be returned
Source:
  • WixClient.js

GetContactsOptions

Get Contacts Query Options

Type:
  • Object
Properties:
Name Type Argument Description
pageSize Number <nullable>

The number of results to return per page of data. Valid options are: 25, 50 and 100. Defaults to 25
Source:
  • WixClient.js

GetContactsSubscribersOptions

Get Contacts Subscribers Query Options

Type:
  • Object
Properties:
Name Type Argument Description
pageSize Number <nullable>

The number of results to return per page of data. Valid options are: 25, 50 and 100. Defaults to 25
subscriberStatus String <nullable>

The contact's subscription status in relation to the site. Can either be notSet or optIn. By default, contacts who have explicitly opted in will be returned.
Source:
  • WixClient.js