Response chains
Response chains
GET
https://api.feedbackly.com/v5/response-chains
Gets responses grouped by a single respondent.
Query Parameters
Name | Type | Description |
---|---|---|
skip | number | No. of documents to skip from the start |
createdTo | string | Filter by unix timestamp, ending at given value |
createdFrom | string | Filter by unix timestamp, starting from given value |
touchpointId | string | Filter by touchpoint id |
surveyId | string | Filter by survey ids |
preferredLanguage | string | Preferred language to show the question titles in |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Authentication token to access the API. eg: 'Authorization': 'ey0iuefg.834xcunerun348efnsd' |
Return type description
Field | Type | Example | Description |
data | Response chain with embedded responses | ||
paging | Pagination object |
Response chain by id
GET
https://api.feedbackly.com/v5/response-chains/:id
Gets an individual response chain by id
Path Parameters
Name | Type | Description |
---|---|---|
id | string | Id of the response chain |
Query Parameters
Name | Type | Description |
---|---|---|
preferredLanguage | string | Preferred language to show the question titles in |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Authentication token to access the API. eg: 'Authorization': 'ey0iuefg.834xcunerun348efnsd' |
Response chain data object
Field | Type | Example | Description |
touchpointName | string | Touchpoint 1 | Touch point name |
responseChainId | string | "507f1f77bcf86cd799439013" | Id of the full response chain the response belongs to |
teamId | string | "507f1f77bcf86cd799439013" | Team's id |
metadata | { [key: string]: string} | {phone: "iPhone X"} | metadata attached to response |
createdAtDate | string | "2017-03-27T09:03:59.133Z" | Response's date in Javascript format |
createdAt | number | 1490605439 | Response's date in UNIX timestamp |
touchpointId | string | "507f1f77bcf86cd799439013" | Touchpoint's id |
_id | string | "507f1f77bcf86cd799439013" | id of the response |
language | string | "en" | language the response is given in |
teamName | string | "My team" | Team's name |
data | array | Responses within the response chain | |
> answer | string | string[] | number | 0.5, "Apple", ["Apple", "Orange"] | Mixed-type field related to question type |
> questionType | "Button" | "NPS" | "Word" | "Slider" | "Contact" | "Text" | "Image" | "Button" | |
> fieldId? | string | "507f1f77bcf86cd799439013" | Field id (used in Contact and Slider question types) |
> valueString? | string | "Orange" | String value of the response |
> valueArray? | string[] | ["aoudfsa", "sidfvcx"] | The technical id of the given responses (Word/Image) |
> valueNum | number | 0.5 | Number value of the response |
> questionId | string | "507f1f77bcf86cd799439013" | Question's id |
> question | string | "How did we succeed today?" | The title of the question in the preferred language (if available) |
> fieldName | string | "Email" | Field name (used in Contact and Slider) |
> tags | string[] | ["CSAT"] | Question tags set in the survey editor |
Last updated