---
title: "Feedback analytics metrics"
method: GET
path: "/feedback/analytics/metrics"
tags: ["Feedback analytics"]
---

# Feedback analytics metrics

`GET /feedback/analytics/metrics`

**⚠️ This feature is available only for organisations subscribed to Feedback Management. ⚠️**

Retrieve aggregated feedback analytics data for your organisation.

A request is composed of:
- One or more **`metrics`** — the data you want to compute (required)
- An optional **`dimensions`** — how the data is grouped
  - If omitted, the request returns the aggregated totals across all data matching the filters
- An optional **`order_by`** — how the rows are sorted
- **Filters** to narrow the data:
  - By business (`business__in`, `business__notin`)
  - By group or group section (`groups`, `group_section_id`)
  - By date range (`filter_date__gte`, `filter_date__lte`)
  - By survey or field (`survey__in`, `survey_field__in`, `survey_field_type__in`)
  - By NPS score (`result_nps_score__in`)
  - By free-text comment (`verbatim_query`)
  - By data quality issues (`issues__in`, `issues__notin`)
  - By business location (`city`, `query`)

**Metrics** are grouped into five categories:

| Category | Prefix | Examples |
|---|---|---|
| Survey | `survey.` | `survey.response_rate`, `survey.nb__sent` |
| CSAT | `result.csat.` | `result.csat.score`, `result.csat.avg_score` |
| NPS | `result.nps.` | `result.nps.score`, `result.nps.promoters` |
| Response | `response.` | `response.avg_response_time`, `response.method.nb__ai` |
| Result field | `result_field.` | `result_field.rating`, `result_field.choices` |

**Dimensions** control how rows are grouped:
- Entity: `business`, `user`, `feedback_form`, `group`, `group_section`, `feedback_form_field`, `result`
- Time: `day`, `month`, `year`

**Excel download**: add `download=true` to receive the data as an `.xlsx` file instead of JSON.
Use `table_name` to customise the filename.

**Metadata**: add `metadata=true` to include full entity objects (businesses, forms, users…)
alongside the `data` array. Useful for resolving IDs to display names without extra API calls.

## Query parameters

- `metrics` string, required
- `dimensions` 'business' | 'user' | 'feedback_form' | 'group' | 'group_section' | 'feedback_form_field' | 'result' | 'day' | 'month' | 'year'
- `order_by` string
- `business__in` string
- `business__notin` string
- `user__in` string
- `groups` string
- `group_section_id` integer
- `city` string
- `query` string
- `filter_date__gte` string, datetime
- `filter_date__lte` string, datetime
- `survey__in` string
- `survey_field__in` string
- `survey_field_type__in` string
- `result_nps_score__in` string
- `result_id__in` string
- `verbatim_query` string
- `issues__in` 'deleted_business' | 'missing_store_code'
- `issues__notin` 'deleted_business' | 'missing_store_code'
- `metadata` boolean
- `download` boolean
- `table_name` string
- `page` integer
- `per_page` integer

## Response `200`

OK.

When `download=true`, the response is an Excel file (`.xlsx`) with a
`Content-Disposition: attachment` header containing the generated filename,
instead of the JSON body described below.

- FeedbackAnalyticsResponse
  - `data` FeedbackAnalyticsDataItem[] — Array of analytics rows. Each row contains metric values and dimension identifiers.
  - `metadata` FeedbackAnalyticsMetadata — Entity details referenced by IDs in the `data` array. Only present when `metadata=true` is passed in the request. Each key is a dimension name; its value is an array of the corresponding entities.
    - `feedback_form` FeedbackFormSummary[] — Feedback forms referenced in the data.
      - `id` string — Unique identifier of the feedback form.
      - `display_name` string — Human-readable name of the feedback form.
    - `feedback_form_field` FeedbackFormFieldSummary[] — Form fields referenced in the data.
      - `id` string — Unique identifier of the field.
      - `field_type` string — Type of the field (e.g. CSAT, NPS, TEXT).
      - `field_label` string — Display label of the field.
      - `form_id` string — ID of the parent feedback form.
      - `form_display_name` string — Display name of the parent feedback form.
    - `business` object[] — Businesses referenced in the data.
    - `group` object[] — Business groups referenced in the data.
    - `group_section` object[] — Group sections referenced in the data.
    - `user` object[] — Users referenced in the data.
    - `result` object[] — Individual feedback results referenced in the data.
  - `page` integer — Current page number.
  - `count` integer — Total number of results matching the query.
  - `max_page` integer, nullable — Total number of pages available.

## Other responses

- `401` — You are not authenticated
- `403` — You are not allowed to perform this action

---

[API](https://skmtc.net/partoo/apis/partoo-rest-api.md) · [All operations](https://skmtc.net/partoo/apis/partoo-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/partoo/partoo-rest-api/revisions/3652d8b1a8b3/schema)