get https://api.zenloop.com/v1/survey_groups/
This endpoint is used for fetching basic survey data and NPS scores.
{
"date_shortcut": "all_time"
}
Response attributes
Attribute | Type | Description |
---|---|---|
survey_group | object | Survey group information data. |
survey_group.name | string | Survey group title. |
survey_group.public_hash_id | string | Survey group public hash id used to identify survey group. |
survey_group.promoters | object | Summary data about promoters from survey group answers. |
survey.promoters.percentage | number | Percentage of answers that were promoters. |
survey_group.promoters.delta | number | Promoters delta - describing the +/- change for the similar period we measure against. |
survey_group.passives | object | Summary data about passives from survey group answers. |
survey_group.passives.percentage | number | Percentage of answers that were passives. |
survey_group.passives.delta | number | Passives delta - describing the +/- change for the similar period we measure against. |
survey_group.number_of_responses | number | Number of answers. |
survey_group.nps | object | Summary data about NPS from survey group answers. |
survey_group.nps.percentage | number | The NPS score. |
survey_group.nps.delta | number | NPS delta - describing the +/- change for the similar period we measure against. |
survey_group.inserted_at | date | Survey group creation date. |
survey_group.detractors | object | Summary data about detractors from survey group answers. |
survey_group.detractors.percentage | number | Percentage of answers that were detractors. |
survey_group.detractors.delta | number | Detractors delta - describing the +/- change for the similar period we measure against. |
survey_group.surveys | object | Surveys information data. |
survey_groups.surveys.title | string | Survey title. |
survey_groups.surveys.status | string | Survey status. One of: draft , active . |
survey_groups.surveys.public_hash_id | string | Survey public hash id used to identify survey. |
survey_groups.surveys.inserted_at | date | Survey creation date. |