getAnalyticsData( )

Retrieves analytics data, given the specified filtering.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
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?