Survey Responses API
- List survey responses
- Get a single survey response
- Create a survey response
- Update a survey response
- Fields
List survey responses
List all survey responses for an account:
GET /survey_responses
Response
Status: 200 OK
[
{
"id": 187,
"created_at": "2021-07-21T06:55:47-05:00",
"updated_at": "2021-07-21T06:55:47-05:00",
"survey": {
"id": 1,
"name": "My Survey",
"nodeID": "..."
},
"service": {
"id": 31,
"name": "Personal Computing",
"...": "..."
},
"year": 2021,
"month": 7,
"rating": null,
"nodeID": "..."
},
"..."
]
The response contains these fields by default. Filtering and pagination are available to reduce/limit the collection of survey responses.
Collection Fields
By default the following fields will appear in collections of survey responses:
id
survey
service
year
month
rating
created_at
updated_at
Obtain a different set of fields using the ?fields= parameter.
Filtering
Filtering is available for the following fields:
id
source
sourceID
created_at
updated_at
responded_at
survey
Sorting
By default a collection of survey responses is sorted ascending by id
.
The following fields are accepted by the ?sort= parameter:
id
sourceID
created_at
updated_at
Get a single survey response
GET /survey_responses/:id
Response
Status: 200 OK
{
"completed": true,
"created_at": "2021-07-21T06:55:44-05:00",
"id": 178,
"rating": null,
"rating_calculation_json": null,
"responded_at": "2021-07-21T06:55:44-05:00",
"service": {
"id": 31,
"name": "Personal Computing",
"...": "..."
},
"source": null,
"sourceID": null,
"survey": {
"id": 1,
"name": "My Survey",
"nodeID": "..."
},
"updated_at": "2021-07-21T06:55:44-05:00",
"nodeID": "..."
}
The response contains these fields.
Create a survey response
POST /survey_responses
When creating a new survey response these fields are available.
Response
Status: 201 Created
{
"id": "...",
"...": "..."
}
The response contains all fields of the created survey response and is similar to the response in Get a single survey response.
Update a survey response
PATCH /survey_responses/:id
When updating an survey response these fields are available.
Response
Status: 200 OK
{
"id": "...",
"...": "..."
}
The response contains all fields of the created survey response and is similar to the response in Get a single survey response.
Fields
- completed
- Optional boolean, default:
false
— The completed flag is used to indicate whether the user completed the survey. - created_at
- Readonly datetime — The date and time at which the survey response was created.
- id
- Readonly integer — The unique ID of the survey response.
- rating
- Optional decimal — Rating calculated based on the answers of this response.
- rating_calculation_json
- Readonly string — How the individual answers were combined to calculate the rating. (String can be parsed to JSON).
- responded_at
- Readonly datetime — The date and time at which the user started the survey.
- service
- Required reference to Service — Service this response is about.
- source
- Optional string (max 30) - See source
- sourceID
- Optional string (max 128) - See source
- survey
- Required reference to Survey — Survey this response is for.
- updated_at
- Readonly datetime — The date and time of the last update of the survey response. If the survey response has no updates it contains the
created_at
value.