getAnalyticsData( )


Retrieves analytics data, given the specified filtering.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Site Analytics - read permissions
Learn more about app permissions.
Method Declaration
Copy
function getAnalyticsData(
  measurementTypes: Array<MeasureNameEnum>,
  options: GetAnalyticsDataOptions,
): Promise<GetAnalyticsDataResponse>;
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>
JavaScript
import { analyticsData } from "@wix/analytics-data"; async function getAnalyticsData(measurementTypes, options) { const response = await analyticsData.getAnalyticsData( measurementTypes, options, ); }
Errors

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

Did this help?