getAnalyticsData( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves analytics data, given the provided filtering.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Site Analytics - read permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
measurementTypesArray<MeasureNameEnum>Required

Measurement types. Supported values:

  • TOTAL_SESSIONS: All site visitor sessions.
  • TOTAL_SALES: All sales.
  • TOTAL_ORDERS: All orders.
  • CLICKS_TO_CONTACT: All clicks of the "contact us" button.

optionsGetAnalyticsDataOptions

Field options.

Returns
Return Type:Promise<GetAnalyticsDataResponse>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?