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.

Permissions
Site Analytics - read permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
measurementTypesArray<MeasureNameEnum>Required
4 enum supported values:
CLICKS_TO_CONTACTTOTAL_ORDERSTOTAL_SALESTOTAL_SESSIONS

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>
Was this helpful?
Yes
No