---
title: "Get Survey Summary"
method: GET
path: "/feedback/surveys/{survey_id}/summary"
tags: ["Surveys"]
---

# Get Survey Summary

`GET /feedback/surveys/{survey_id}/summary`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/feedback/surveys/{survey_id}/summary`
- Auth: HTTP bearer

Headline score, response rate and distribution for one survey.

## Path parameters

- `survey_id` string, required: Survey id (UUID) — from GET /feedback/surveys

## Query parameters

- `bucket` string: Trend bucket: day, week or month.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseSummaryDTO
  - `data` SummaryDTO, required
    - `survey_id` string, required
    - `type` string, required
    - `delivery_channel` string, required
    - `nps_score` number, nullable
    - `csat_avg` number, nullable
    - `promoters` integer, required
    - `passives` integer, required
    - `detractors` integer, required
    - `satisfied` integer, nullable
    - `neutral` integer, nullable
    - `dissatisfied` integer, nullable
    - `total_respondents` integer, required
    - `response_rate` ResponseRateDTO, required
      - `sent` integer, required
      - `responded` integer, required
      - `rate` number, required
    - `bucket` string, required
    - `time_series` TrendBarDTO[], required
      - `period` string, required
      - `nps_score` number, nullable
      - `csat_avg` number, nullable
      - `promoters` integer, required
      - `passives` integer, required
      - `detractors` integer, required
      - `total` integer, required
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)