get_answer_sets
GET /answer_sets
List all your answer_sets (feedback)
- Rails
require 'rest-client'
RestClient::Request.execute method: :get,
url: 'https://api.diduenjoy.com/api/v1/answer_sets',
user: 'PUT-YOUR-API-KEY-HERE'
---------------Filter[would_recommend]--------------------------
require 'rest-client'
RestClient::Request.execute method: :get,
url: "https://api.diduenjoy.com/api/v1/answer_sets?filter[would_recomend][]=2,3,4",
user: 'PUT-YOUR-API-KEY-HERE'
attributes
| attribute | description |
|---|---|
| created_at datetime | answer_set creation date |
| updated_at datetime | answer_set last modification date |
| comment string | responder comment |
| completed boolean | equal "true" if the responder completed all your survey pages else "false" |
| status string | status of the answer set. Possible values: live or deleted |
| would_recommend integer | responder recommendation note |
| segments hash { string: string|array[string] } | custom data associated with the answer_set |
| tags hash { string: string|array[string] } | custom tags associated with the answer_set |
| root_causes hash { string: string|array[string] } | custom root causes associated with the answer_set |
| action_taken hash { string: string|array[string] } | custom action taken associated with the answer_set |
| resolved boolean | equal "true" if the feedback has been set to resolved |
| dispatch_sent_at datetime | sending date of the feedback |
| completed_at datetime | answer completion date |
| last_opening_date datetime | last opening date of the answer_set |
| first_resolution_date datetime | date of the first resolution |
| last_resolution_date datetime | date of the last resolution |
| resolution_duration integer | the total combined time answer_set was in the new, open, and on-hold statuses |
| full_resolution_duration integer | duration between answer_set creation and its most recent resolution |
| resolver_account | resolver email |
| answers array[hash] | answers ex: [ { "label": "Short Comment", "kind": "short_text_input", "translations": {"ar": "Short Comment - ar","en": "Short Comment - en"}, "value": "short text" }, { "label": "NPS", "kind": "rating", "translations":{"ar": "NPS - ar","en": "NPS - en"}, "value": 8, "rating_scale":{"min": "1","max": "10"} }, { "label": "Multi Select", "kind": "multiple_select", "translations":{"ar":"Multi Select - ar","en": "Multi Select - en"}, "value": ["A","B","C"] } ] |
| company_language string | language of the company |
| comment_translation string | comment translated into company language |
| profile string | respondent profile ('detractor','passive','promoter','unknown') |
| permalink string | link to the answer_set in the dashboard messaging section. |
optional parameters "filter"
| parameter | description |
|---|---|
| completed boolean | filter over answer_sets of the indicated completed status |
| status string | filter over answer_sets status |
| survey_id array | filter over answer_sets of the indicated surveys |
| client_id array | filter over answer_sets of the indicated clients |
| would_recommend array | filter over answer_sets of the indicated ratings |
| start_date date | filter over answer_sets answered after the specified date |
| end_date date | filter over answer_sets answered before the specified date |
| start_sending_date date | filter over answer_sets sent after the specified sending date |
| end_sending_date date | filter over answer_sets sent before the specified sending date |
| start_updated_date date | filter over answer_sets updated after the specified date |
| end_updated_date date | filter over answer_sets updated before the specified date |
| segments hash { string: string|array[string] } | filter over answer_sets with specific segments values, to use if you expect the query to return a large number of results |
| unique_segments hash { string: string|array[string] } | filter over answer_sets with specific segments values, to use if you expect the query to return a small number of results |
| comment string | filter by presence or absence of a comment. Valid values: 'with', 'without'. |
relationships
| relationship | description |
|---|---|
| survey | answer_set survey |
| client | answer_set responder |
| survey_language | answer_set survey_language |
| choices | responder choices |
| answers | responder answers |
| feedback_tags | answer_set tags |
| messages | feedback messages (from client and company) |