# Follow guide ⏭️

**GET /navigation/guide/{search_id}/{locale}/follow/{step}**

This endpoint is the core of the guided search. It has a double use case:
  * Get a question of a given step with possible choices
  * Answer to a question of a given step with user choices, in that case the next question + choices is returned directly

It is meant to be used several times in a row to follow the guide until the end, or until the user wants to stop it and show results immediately



## Servers
- https://api.ppe-analytics.com/api/v1: https://api.ppe-analytics.com/api/v1 ()


## Authentication methods
- Api key


## Parameters

### Path parameters
- **search_id** (string)
  The search_id as returned by the `Initialize guide` endpoint.
- **locale** (string)
  The locale in which to go through the guide. It can be changed at any step of the guide. Available languages depend on your corporation settings.
- **step** (string)
  The step for which we want to get the question or the step we want to answer to. If you're not answering a given step, use `current` to automatically jump to latest step.

### Query parameters
- **choice_key** (string)
  The string representation of the choice(s) made by the user for the question at the given step.
  For multiple choices, allowed combinations are given by `available_combination_mode` attribute of the question.
  In order to build the final choice_key, you'll need to concatenate the choice keys with
    * `~` char for `and` combination
    * `|` char for `or` combination

  If the question is marked as skippable, it can be skipped by using _skip_ as a choice

  If you want to go back to the previous proposed question, you should use _back_ as a choice


## Responses
### 200
Submit choices for a given question, and get next question with its choices

#### Body: application/json (object)
- **status** (string)

- **result** (object)



[Powered by Bump.sh](https://bump.sh)