Metrics

The Metric object defines reusable scoring dimensions used in survey steps to capture quantitative feedback. Metrics are typically used in metric-type steps to collect ratings on (customisable) categories. Common examples include; "Food Quality", "Customer Service", or "Ambiance".

Metrics can be referenced across multiple surveys, enabling consistent data collection and comparative analysis across different feedback flows.

The Metrics Object

Schema Metric not found in OpenAPI spec.

Retrieve Metrics

Retrieve metrics for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the metrics for.

Returns200

The metrics.

The Metric Object

Endpoint

GET /v2/businesses/{business}/metrics

Retrieve a Metric

Retrieve a metric for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the metric for.

metricstringPath RequiredField must be in path.

The ID of the metric to retrieve.

Returns200

The metric was found.

The Metric Object

Endpoint

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

Create a Metric

Create a metric for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the metrics for.

Schema undefined not found in OpenAPI spec.

Returns201

The metric was created.

The Metric Object

Endpoint

POST /v2/businesses/{business}/metrics

Update a Metric

Update a metric for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the metric for.

metricstringPath RequiredField must be in path.

The ID of the metric to retrieve.

Schema undefined not found in OpenAPI spec.

Returns200

The metric was updated.

The Metric Object

Endpoint

PATCH /v2/businesses/{business}/metrics/{metric}

Delete a Metric

Delete a metric for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the metric for.

metricstringPath RequiredField must be in path.

The ID of the metric to delete.

Returns204

The metric was deleted successfully.

Endpoint

DELETE /v2/businesses/{business}/metrics/{metric}