get https://api.zenloop.com/v1/surveys/
This endpoint is used for fetching basic survey data and NPS scores.
{
"date_shortcut": "all_time"
}
Response attributes
| Attribute | Type | Description |
|---|---|---|
| survey | object | Survey information data. |
| survey.title | string | Survey title. |
| survey.status | string | Survey status. One of: draft, active |
| survey.response_rate | string | Survey response rate. |
| survey.public_hash_id | string | Survey public hash id used to identify survey. |
| survey.promoters | object | Summary data about promoters from survey answers. |
| survey.promoters.percentage | number | Percentage of answers that were promoters. |
| survey.promoters.delta | number | Promoters delta - describing the +/- change for the similar period we measure against. |
| survey.passives | object | Summary data about passives from survey answers. |
| survey.passives.percentage | number | Percentage of answers that were passives. |
| survey.passives.delta | number | Passives delta - describing the +/- change for the similar period we measure against. |
| survey.number_of_responses | number | Number of answers. |
| survey.nps | object | Summary data about NPS from survey answers. |
| survey.nps.percentage | number | The NPS score. |
| survey.nps.delta | number | NPS delta - describing the +/- change for the similar period we measure against. |
| survey.inserted_at | date | Survey creation date. |
| survey.detractors | object | Summary data about detractors from survey answers. |
| survey.detractors.percentage | number | Percentage of answers that were detractors. |
| survey.detractors.delta | number | Detractors delta - describing the +/- change for the similar period we measure against. |
| survey.additional_questions | object | Additional questions. |
| survey.additional_questions.options | array | List of options to select if type of the question is single_select or multi_select. |
| survey.additional_questions.position | number | Position of the additional question. |
| survey.additional_questions.public_hash_id | string | Additional question public hash id used to identify. |
| survey.additional_questions.question | string | Content of the additional question. |
| survey.additional_questions.type | string | Additional question type. One of: single_select, multi_select, free, scale. |