> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gleap.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get survey respondent paths

> How respondents moved through the survey, for the Results flow chart. Query `from`, `to` (YYYY-MM-DD) and
`version`. Returns `{ responses, other, sampled, paths: [{ path, status, nps?, count }] }`: identical paths
grouped (biggest 300), `path` = block ids in order (a completed one may end with its ending id, an open one
ends where it stopped), `nps` = detractor | passive | promoter on the first NPS question. Reads the newest
20,000 responses (`sampled: true` beyond that).



## OpenAPI

````yaml https://api.gleap.io/api-docs.json get /engagement/surveys/{surveyId}/paths
openapi: 3.0.0
info:
  title: gleap-server
  version: 14.0.0
  contact: {}
servers:
  - url: https://api.gleap.io/v3
security: []
paths:
  /engagement/surveys/{surveyId}/paths:
    get:
      tags:
        - Engagement Survey
      summary: Get survey respondent paths
      description: >-
        How respondents moved through the survey, for the Results flow chart.
        Query `from`, `to` (YYYY-MM-DD) and

        `version`. Returns `{ responses, other, sampled, paths: [{ path, status,
        nps?, count }] }`: identical paths

        grouped (biggest 300), `path` = block ids in order (a completed one may
        end with its ending id, an open one

        ends where it stopped), `nps` = detractor | passive | promoter on the
        first NPS question. Reads the newest

        20,000 responses (`sampled: true` beyond that).
      operationId: Paths
      parameters:
        - in: path
          name: surveyId
          required: true
          schema:
            type: string
        - in: header
          name: project
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema: {}
      security:
        - jwt: []
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.