Submission analytics

The Submission analytics endpoint returns aggregated data from customer survey submissions. It provides information on ratings, usage, and distribution of answers across survey questions. Data can be filtered by date range, survey, or location. This endpoint is primarily used to analyze customer feedback trends and measure survey-based performance indicators.

The Submission analytics Object

Schema SubmissionAnalytics not found in OpenAPI spec.

Retrieve Submission analytics

Retrieve submission analytics for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the analytics for.

periodStartintegerQuery RequiredField must be in query parameters.

The start of the period to query, in milliseconds since epoch.

periodEndintegerQuery RequiredField must be in query parameters.

The end of the period to query, in milliseconds since epoch.

interval

The interval for the analytics data. Can be 'day', 'week', or 'month'.

offsetinteger

The time offset in milliseconds to apply to the analytics time-buckets.

locationstring

The location for which to return analytics specific data for. Pass the literal string "null" to return analytics for submissions that have no location associated.

surveystring

The survey for which to return analytics specific data for.

locationLabelsarray

Labels for the locations to be used in the analytics.

Returns200

The submission analytics

No external docs found for ObjectResponse_SubmissionAnalytics.

Endpoint

GET /v2/businesses/{business}/analytics/submissions