Metric Analytics

The Metric Analytics endpoint exposes key performance indicators (KPIs) derived from feedback and survey data. Metrics are defined by keywords or categories such as “Food Quality” or “Customer Service.” The endpoint returns metric-level scores, averages, and trend data over time. It enables quantitative tracking of performance across multiple metrics and dimensions.

The Metric Analytics Object

Schema MetricAnalytics not found in OpenAPI spec.

Retrieve Metric Analytics

Retrieve metrics 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'.

locationstring

The location for which to return analytics specific data for.

metricstring

The metric for which to return analytics specific data for.

locationLabelsarray

Labels for the locations to be used in the analytics.

metricLabelsarray

Labels for the metrics to be used in the analytics.

Returns200

The metrics analytics.

The Metric Analytics object

Endpoint

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