{"info":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","description":"

Welcome to the Simplesat API reference!

The public endpoints are stable but still a work in progress. If you have any questions or see any issues, please reach out to us at support@simplesat.io.

Previous API versions

Authentication

You need a Simplesat account with an API key to make requests. To find your key, log into your Simplesat account and head over to Admin > Account Settings.

To authenticate, use the API key in a X-Simplesat-Token header.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
X-Simplesat-Token	Your access token

Pagination

By default, most list endpoints return a maximum of 100 records per page. You can change the number of records on a per-request basis by passing a page_size parameter in the request URL parameters. Example: page_size=50.

When the response exceeds the per-page maximum, you can paginate through the records by incrementing the page parameter. Example: page=3. List results include next and previous URLs in the response body for easier navigation:

{\n    \"answers\": [...],\n    \"count\": 106,\n    \"next\": \"https://api.simplesat.io/api/v1/questions?page=2\",\n    \"previous\": null,\n}\n\n

Stop paging when the next attribute is null.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Pagination","slug":"pagination"}],"owner":"457268","collectionId":"0a012608-29fa-46fd-bed4-05077c9abfa9","publishedId":"UVRDGRZ2","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"4ec677"},"publishDate":"2021-12-23T14:12:27.000Z"},"item":[{"name":"Answers","item":[{"name":"Get an answer","id":"02f177aa-2197-487b-b4be-593c3854e261","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"url":"https://api.simplesat.io/api/v1/answers/{{id}}","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","answers","{{id}}"],"host":["api","simplesat","io"],"query":[],"variable":[]}},"response":[{"id":"ff017dbe-a376-471e-98dc-65e8f225fc2c","name":"Get an answer","originalRequest":{"method":"GET","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"url":"https://api.simplesat.io/api/v1/answers/{{id}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 11060778,\n \"choice\": \"3\",\n \"choice_label\": \"Okay, but not great.\",\n \"comment\": null,\n \"follow_up_answer\": \"Great service, but response time could have been a bit faster.\",\n \"follow_up_answer_choice\": null,\n \"follow_up_question\": null,\n \"created\": \"2021-12-13T10:42:39.410573Z\",\n \"modified\": \"2021-12-13T10:42:39.410608Z\",\n \"question\": {\n \"id\": 44993,\n \"text\": \"How did we do?\",\n \"metric\": \"csat\"\n },\n \"survey\": {\n \"id\": 16738,\n \"name\": \"CSAT survey\"\n },\n \"response_id\": 6134350\n}"}],"_postman_id":"02f177aa-2197-487b-b4be-593c3854e261"},{"name":"Search answers","id":"c79d74a4-b215-4a60-bf93-896b00f4b3c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.simplesat.io/api/v1/answers/search","description":"

Retrieve answers by applying specific filters in the request body.

If the request body is left empty, the API will return all answers from the last 30 days by default. Including only a start_date field will yield answers from the date specified up to 30 days prior.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
start_date	datetime	The date and time in ISO 8601 format to start displaying answers.
end_date	datetime	The date and time in ISO 8601 format to end displaying answers.
operator	string	`\"and\"` - all filters must match. `\"or\"` - at least one filter must match.
filters	array of objects	Includes one or more `key`/`values` pairs to use as filters.
key	string	The field name to filter (see all available fields in the table below).
attribute	string	Use to define the field name for nested customer, ticket, or team member custom attributes. See below for how to find custom attribute field names.
values	array	The value or values for the `key` field. Single values still must be wrapped in brackets. Separate multiple values by a comma within the brackets. Example: `\"values\": [\"tester@example.com\"]`
comparison	string	Supports: `is`, `is_not`, `contains`, `does_not_contain`, `is_unknown`, `has_any_value`. The `is_unknown` and `has_any_value` comparisons still require a value to be present in the filter, but the value is ignored. So for example, you could just use `\"values\": [\"-\"]`.

Key fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Value type	Description
choice_value	integer	Also referred to as \"rating value\".
collaborator	string	The email address of a team member associated with a response (in Simplesat, \"collaborators\" are team members associated with responses, while the \"team_member\" field is the primary collaborator).
company	string	Company name.
comment	string	Use the `has_any_value` comparison to search for responses or answers containing a comment.
customer	string	Customer full name.
customer.email	string	Customer email.
ip	string	Use the `contains` comparison as most feedback are associated with multiple IP addresses.
metric	string	Available options: `NPS`, `CES`, `CSAT`, `5-STAR`.
sentiment	string	Available options: `positive`, `neutral`, `negative`
source	string	`is` and `is_not` comparisons expect the source ID. Use `contains` to search by source name.
survey	string	Expects a 43 character survey key found in rating URLs.
survey_id	integer	Expects the survey ID which you can find through the API.
tag	string	`is` and `is_not` comparisons expect the tag ID. Use `contains` to earch by tag name.
team_member	string	Team member name.
team_member.email	string	Team member email.
team_member.id	string	Team member external ID.
ticket_id	string	Ticket ID.
customer.attributes	string	Add the `attribute` field to define the custom attribute key.
ticket.attributes	string	Add the `attribute` field to define the custom attribute key.

Filtering with custom attributes

Filtering by customer and ticket custom attributes is supported.

To do so, enter customer.attribute or ticket.attribute as the key.

Add the attribute field that includes the field name.

Example:

\"filters\": [\n        {\n            \"key\": \"customer.attribute\",\n            \"attribute\": \"upload_country\",\n            \"values\": [\"United States\"],\n            \"comparison\": \"is_not\"\n        }\n    ]\n\n

Finding the correct attribute field name is currently a little tricky, as Simplesat appends prefixes to custom attributes depending on where they were created.

To find the full attribute value:

Create a filter in the Simplesat dashboard that includes the field that you want to use.
Open the Network tab in developer tools.
Find the request named ?limit=20&offset=0.
Click on the Payload tab.
From there, you should see the full field name. In the example below, the field displayed as latest_nps in the dashboard is int_attribute_latest_nps.

Answer model

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
id	Number
choice	String
choices	Array	Used for multi-select answers.
comment	String
follow_up_answer	String	Used when the answer is in the form of a comment.
follow_up_answer_choice	String	Used when the answer is from a multiple choice or sliding scale question type.
follow_up_answer_choices	Array	Used for multi-select follow-up answers.
modified	DateTime
created	DateTime
survey_id	Number
response_id	Number
published_as_testimonial	Boolean
sentiment	String

","_postman_id":"fc3683b6-2933-425b-b4d1-faa8377de1ac","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","type":"collection"}}},{"name":"Customers","item":[{"name":"Create or update a customer","id":"25efe0ab-0501-49ea-b869-483401d1ed87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.simplesat.io/api/v1/customers","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","customers"],"host":["api","simplesat","io"],"query":[],"variable":[]}},"response":[{"id":"84c636bb-cc16-43f0-a29f-d45030f8c17d","name":"Create or update a customer","originalRequest":{"method":"POST","header":[{"key":"X-Simplesat-Token","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": 456456,\n \"name\": \"John Doe\",\n \"email\": \"jdoe@example.com\",\n \"company\": \"Rindge, Inc.\",\n \"tags\": [\"sassy\",\"snooty\"],\n \"custom_attributes\": {\n \"Company Status\": \"Active\",\n \"Fav color\": \"Blue\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.simplesat.io/api/v1/customers"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 13592933,\n \"external_id\": 456456,\n \"name\": \"John Doe\",\n \"email\": \"jdoe@example.com\",\n \"company\": \"Rindge, Inc.\",\n \"tags\": [\n \"sassy\",\n \"snooty\"\n ],\n \"custom_attributes\": {\n \"Company Status\": \"Active\",\n \"Fav color\": \"Blue\"\n }\n}"}],"_postman_id":"25efe0ab-0501-49ea-b869-483401d1ed87"},{"name":"Update a customer","id":"0b90fa3e-bef2-4ea3-99d1-3d03239847fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.simplesat.io/api/v1/customers/{{id}}","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","customers","{{id}}"],"host":["api","simplesat","io"],"query":[],"variable":[]}},"response":[{"id":"4087d2d7-ca93-442f-baaf-ffa7d1369b2a","name":"Update a customer","originalRequest":{"method":"PUT","header":[{"key":"X-Simplesat-Token","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": 456456,\n \"name\": \"John Doe\",\n \"company\": \"Rindge, Inc.\",\n \"tags\": [\"sassy\",\"snooty\"],\n \"custom_attributes\": {\n \"Company Status\": \"Active\",\n \"Fav color\": \"Blue\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.simplesat.io/api/v1/customers/{{id}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 13592933,\n \"external_id\": 456456,\n \"name\": \"John Doe\",\n \"email\": \"jdoe@example.com\",\n \"company\": \"Rindge, Inc.\",\n \"tags\": [\n \"sassy\",\n \"snooty\"\n ],\n \"custom_attributes\": {\n \"Company Status\": \"Active\",\n \"Fav color\": \"Blue\"\n }\n}"}],"_postman_id":"0b90fa3e-bef2-4ea3-99d1-3d03239847fa"},{"name":"Get a customer","id":"63cd4dd0-fb6d-43e2-b247-58974dfe01ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.simplesat.io/api/v1/customers/{{id}}","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","customers","{{id}}"],"host":["api","simplesat","io"],"query":[],"variable":[]}},"response":[{"id":"d2d2269d-6ab6-490b-acad-83eedcde5047","name":"Get a customer","originalRequest":{"method":"GET","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.simplesat.io/api/v1/customers/{{id}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 13592933,\n \"external_id\": null,\n \"name\": \"John Doe\",\n \"email\": \"jdoe@example.com\",\n \"company\": \"Rindge, Inc.\",\n \"tags\": [\n \"sassy\",\n \"snooty\"\n ],\n \"custom_attributes\": {\n \"Company Status\": \"Active\",\n \"Fav color\": \"Blue\"\n }\n}"}],"_postman_id":"63cd4dd0-fb6d-43e2-b247-58974dfe01ef"},{"name":"Get a customer Copy","id":"df7f3178-56cd-482f-b6db-4298010670dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.simplesat.io/api/v1/customers/{{id}}","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","customers","{{id}}"],"host":["api","simplesat","io"],"query":[],"variable":[]}},"response":[{"id":"84f33c03-02d3-41ff-b99a-c1fc192b56ab","name":"Get a customer","originalRequest":{"method":"GET","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.simplesat.io/api/v1/customers/{{id}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 13592933,\n \"external_id\": null,\n \"name\": \"John Doe\",\n \"email\": \"jdoe@example.com\",\n \"company\": \"Rindge, Inc.\",\n \"tags\": [\n \"sassy\",\n \"snooty\"\n ],\n \"custom_attributes\": {\n \"Company Status\": \"Active\",\n \"Fav color\": \"Blue\"\n }\n}"}],"_postman_id":"df7f3178-56cd-482f-b6db-4298010670dc"}],"id":"b5e36422-2d5c-460b-9662-d9cb105f741b","description":"

Customer model

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
id	Number
external_id	String
name	String
email	String
custom_attributes	Object
tags	Array

","_postman_id":"b5e36422-2d5c-460b-9662-d9cb105f741b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","type":"collection"}}},{"name":"Questions","item":[{"name":"List questions","id":"489e08a6-3a1b-41e8-a7b4-e05a9c5d43f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"url":"https://api.simplesat.io/api/v1/questions","description":"

Query parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
metric	Filter questions by csat, nps, or ces.
survey_id	Filter questions by a survey's ID.

Question model

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
id	Number
survey_id	Number
order	Number
metric	String
text	String
rating_scale	Boolean
required	Boolean
choices	Array
rules	Array

Rules model

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
conditions	Array
action	String
question	Object

","_postman_id":"56147f26-0df2-4421-8515-8d1dcec108ac","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","type":"collection"}}},{"name":"Responses","item":[{"name":"Get a response","id":"48673f44-31b2-4ef4-bc50-ad9ff96ff4ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"url":"https://api.simplesat.io/api/v1/responses/{{id}}","description":"

Retrieve a single response by ID.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","responses","{{id}}"],"host":["api","simplesat","io"],"query":[],"variable":[]}},"response":[{"id":"b1dce25e-eb7b-4466-bc73-15e11197b612","name":"Get a response","originalRequest":{"method":"GET","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"url":"https://api.simplesat.io/api/v1/responses/{{id}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\":6154350,\n \"survey\":{\n \"id\":17072,\n \"name\":\"Satisfaction Survey\"\n },\n \"tags\":[\n \"VIP\",\n \"support request\"\n ],\n \"created\":\"2021-12-13T10:42:39.340742Z\",\n \"modified\":\"2021-12-13T10:43:28.723487Z\",\n \"ticket\":{\n \"id\":6182024,\n \"external_id\":\"119265800000334\",\n \"subject\":\"PRINTER JAM!!!!1\",\n \"custom_attributes\":{\n \n }\n },\n \"team_members\":[\n {\n \"external_id\":\"2340424\",\n \"name\":\"John Doe\",\n \"email\":\"jdoe@example.com\",\n \"custom_attributes\":{\n \"group\":\"Support\",\n \"language\":\"English\"\n },\n \"role\":\"Assignee\",\n \"is_primary\":true\n }\n ],\n \"customer\":{\n \"id\":13592781,\n \"external_id\":\"9942423132967\",\n \"name\":\"Jackson Doe\",\n \"email\":\"jackson@example.com\",\n \"company\":\"Rindge, Inc.\",\n \"tags\":[\n \"funny\",\n \"vip\"\n ],\n \"custom_attributes\":{\n \"area\":\"area51\",\n \"type\":\"IT\"\n }\n },\n \"answers\":[\n {\n \"id\":11261044,\n \"question\": {\n \"id\": 44993,\n \"text\": \"How did we do?\",\n \"metric\": \"csat\"\n },\n \"choice\":\"4\",\n \"choice_label\":\"Great, I'm satisfied.\",\n \"sentiment\":\"positive\",\n \"comment\":null,\n \"follow_up_answer\":\"THE PRINTER IS WORKING AGAIN!!!\",\n \"follow_up_answer_choice\": null,\n \"follow_up_question\": {\n \"id\": 42634,\n \"text\": \"Was there anything in particular we did that delighted you?\",\n \"metric\": \"custom\"\n }\n },\n {\n \"id\":11261046,\n \"question\": {\n \"id\": 4494499793,\n \"text\": \"How is our responsiveness?\",\n \"metric\": \"custom\"\n },\n \"choice\":\"4\",\n \"choice_label\":\"It's great.\",\n \"sentiment\":\"positive\",\n \"comment\":null,\n \"follow_up_answer\":null,\n \"follow_up_answer_choice\": null,\n \"follow_up_question\": null\n },\n {\n \"id\":11261047,\n \"question\": {\n \"id\": 44991,\n \"text\": \"Anything else?\",\n \"metric\": \"custom\"\n },\n \"choice\":null,\n \"choice_label\":null,\n \"sentiment\":null,\n \"comment\":\"Love you!\",\n \"follow_up_answer\":null,\n \"follow_up_answer_choice\": null,\n \"follow_up_question\": null\n }\n ]\n}"}],"_postman_id":"48673f44-31b2-4ef4-bc50-ad9ff96ff4ee"},{"name":"Search responses","id":"8c946dc3-4beb-40d5-bcc8-43983a7a7e6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.simplesat.io/api/v1/responses/search","description":"

Retrieve responses by applying specific filters in the request body.

If the request body is left empty, the API will return all responses from the last 30 days by default.

Including only a start_date field will return all responses from the date specified up to 30 days after.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
start_date	datetime	The date and time in ISO 8601 format to start displaying responses.
end_date	datetime	The date and time in ISO 8601 format to end displaying responses.
operator	string	`\"and\"` - all filters must match. `\"or\"` - at least one filter must match.
filters	array of objects	Includes one or more `key`/`values` pairs to use as filters.
key	string	The field name to filter (see all available fields in the table below).
attribute	string	Use to define the field name for nested customer, ticket, or team member custom attributes. See below for how to find custom attribute field names.
values	array	The value or values for the `key` field. Single values still must be wrapped in brackets. Separate multiple values by a comma within the brackets. Example: `\"values\": [\"tester@example.com\"]`
comparison	string	Supports: `is`, `is_not`, `contains`, `does_not_contain`, `is_unknown`, `has_any_value`. The `is_unknown` and `has_any_value` comparisons still require a value to be present in the filter, but the value is ignored. So for example, you could just use `\"values\": [\"-\"]`.

Key fields

Attribute	Value type	Description
choice_value	integer	Also referred to as \"rating value\".
collaborator	string	The email address of a team member associated with a response (in Simplesat, \"collaborators\" are team members associated with responses, while the \"team_member\" field is the primary collaborator).
company	string	Company name.
comment	string	Use the `has_any_value` comparison to search for responses or answers containing a comment.
customer	string	Customer full name.
customer.email	string	Customer email.
ip	string	Use the `contains` comparison as most feedback are associated with multiple IP addresses.
metric	string	Available options: `NPS`, `CES`, `CSAT`, `5-STAR`.
sentiment	string	Available options: `positive`, `neutral`, `negative`
source	string	`is` and `is_not` comparisons expect the source ID. Use `contains` to search by source name.
survey	string	Expects a 43 character survey key found in rating URLs or retrieved using the `list surveys` endpoint.
tag	string	`is` and `is_not` comparisons expect the tag ID. Use `contains` to earch by tag name.
team_member	string	Team member name.
team_member.email	string	Team member email.
team_member.id	string	Team member external ID.
ticket_id	string	Ticket ID.
customer.attributes	string	Add the `attribute` field to define the custom attribute key.
ticket.attributes	string	Add the `attribute` field to define the custom attribute key.

Filtering with custom attributes

Filtering by customer and ticket custom attributes is supported.

To do so, enter customer.attribute or ticket.attribute as the key.

Add the attribute field that includes the field name.

Example:

\"filters\": [\n        {\n            \"key\": \"customer.attribute\",\n            \"attribute\": \"upload_country\",\n            \"values\": [\"United States\"],\n            \"comparison\": \"is_not\"\n        }\n    ]\n\n

Finding the correct attribute field name is currently a little tricky, as Simplesat appends prefixes to custom attributes depending on where they were created.

To find the full attribute value:

Create a filter in the Simplesat dashboard that includes the field that you want to use.
Open the Network tab in developer tools.
Find the request named ?limit=20&offset=0.
Click on the Payload tab.
From there, you should see the full field name. In the example below, the field displayed as latest_nps in the dashboard is int_attribute_latest_nps.

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","responses","search"],"host":["api","simplesat","io"],"query":[],"variable":[]}},"response":[{"id":"e72a9002-588f-4c3d-a063-3371d07e755c","name":"Search responses","originalRequest":{"method":"POST","header":[{"key":"X-Simplesat-Token","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"start_date\": \"2023-04-11T17:00:00Z\",\n \"end_date\": \"2023-07-10T16:59:59Z\",\n \"operator\": \"and\",\n \"filters\": [\n {\n \"key\": \"customer.email\",\n \"values\": [\"tester@example.com\"],\n \"comparison\": \"is\"\n },\n {\n \"key\": \"team_member_email\",\n \"values\": [\"jane@example.com\",\"john@example.com\"],\n \"comparison\": \"is\"\n },\n\t\t\t\t{\n \"key\": \"question_id\",\n \"values\": [1901],\n \"comparison\": \"is\"\n },\n\t\t\t\t{\n \"key\": \"survey_id\",\n \"values\": [11432, 23234],\n \"comparison\": \"contains\"\n },\n\t\t\t\t{\n \"key\": \"sentiment\",\n \"values\": [\"positive\"],\n \"comparison\": \"is\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.simplesat.io/api/v1/responses/search"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"next\": null,\n \"previous\": null,\n \"count\": 94,\n \"responses\": [\n {\n \"id\": 12304590,\n \"survey\": {\n \"id\": 91021,\n \"name\": \"CSAT Survey\"\n },\n \"tags\": null,\n \"created\": \"2023-07-10T03:20:28.604939Z\",\n \"ticket\": {\n \"id\": 12323413,\n \"external_id\": \"0Xz4zx9eefs\",\n \"subject\": null\n },\n \"team_members\": null,\n \"customer\": {\n \"id\": 18578132,\n \"external_id\": \"45506\",\n \"name\": \"Tom Jones\",\n \"email\": \"tom@example.com\",\n \"company\": \"Test, Inc.\",\n \"tags\": [\n \"Needs follow-up\"\n ],\n \"custom_attributes\": {\n \"plan\": \"pro\"\n }\n },\n \"answers\": [\n {\n \"id\": 23227520,\n \"question\": {\n \"id\": 132021,\n \"text\": \"How did we do?\",\n \"metric\": \"csat\"\n },\n \"choice\": \"4\",\n \"choices\": null,\n \"comment\": null,\n \"sentiment\": \"positive\",\n \"follow_up_answer\": null,\n \"choice_label\": \"Great, I'm satisfied\",\n \"follow_up_answer_choice\": null,\n \"follow_up_answer_choices\": [\n \"moon\"\n ],\n \"follow_up_question\": {\n \"id\": 132032,\n \"text\": \"Was there anything in particular we did that delighted you?\",\n \"metric\": \"custom\"\n }\n }\n ]\n }\n}"}],"_postman_id":"8c946dc3-4beb-40d5-bcc8-43983a7a7e6d"},{"name":"Create or update a response","id":"45180b8c-920c-4021-a2a9-7287a30ab9e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.simplesat.io/api/v1/responses","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","responses"],"host":["api","simplesat","io"],"query":[],"variable":[]}},"response":[{"id":"9ceca7d6-aa49-4842-8743-6177bf4990f9","name":"Create or update a response","originalRequest":{"method":"POST","header":[{"key":"X-Simplesat-Token","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"survey_id\": 10009,\n \"tags\": [\n \"VIP\",\n \"support request\"\n ],\n \"ticket\": {\n \"external_id\": \"119265800000334\",\n \"subject\": \"PRINTER JAM!!!!1\",\n \"custom_attributes\": {}\n },\n \"team_members\": [\n {\n \"id\": 42446,\n \"role\": \"Assignee\",\n \"is_primary\": true\n }\n ],\n \"customer_id\": 12766081,\n \"answers\": [\n {\n \"question_id\": 44993,\n \"choice\": \"4\",\n \"comment\": null,\n \"follow_up_answer\": \"THE PRINTER IS WORKING AGAIN!!!\"\n },\n {\n \"question_id\": 44997,\n \"choice\": \"4\",\n \"comment\": null,\n \"follow_up_answer\": null\n },\n {\n \"question_id\": 44991,\n \"choice\": null,\n \"comment\": \"Love you!\",\n \"follow_up_answer\": null\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.simplesat.io/api/v1/responses/"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"survey\":{\n \"id\":17072,\n \"name\":\"Satisfaction Survey\"\n },\n \"ticket\":{\n \"id\":6287916,\n \"external_id\":\"119265800000334\",\n \"subject\":\"PRINTER JAM!!!!1\",\n \"custom_attributes\":{\n \n }\n },\n \"team_members\":[\n {\n \"external_id\":\"2340424\",\n \"name\":\"John Doe\",\n \"email\":\"jdoe@example.com\",\n \"custom_attributes\":{\n \"group\":\"Support\",\n \"language\":\"English\"\n },\n \"role\":\"Assignee\",\n \"is_primary\":true\n }\n ],\n \"customer\":{\n \"id\":13592781,\n \"external_id\":\"9942423132967\",\n \"name\":\"Jackson Doe\",\n \"email\":\"jackson@example.com\",\n \"company\":\"Rindge, Inc.\",\n \"tags\":[\n \"funny\",\n \"vip\"\n ],\n \"custom_attributes\":{\n \"area\":\"area51\",\n \"type\":\"IT\"\n }\n },\n \"answers\":[\n {\n \"id\":11261044,\n \"question\": {\n \"id\": 44993,\n \"text\": \"How did we do?\",\n \"metric\": \"csat\"\n },\n \"choice\":\"4\",\n \"choice_label\":\"Great, I'm satisfied.\",\n \"sentiment\":\"positive\",\n \"comment\":null,\n \"follow_up_answer\":\"THE PRINTER IS WORKING AGAIN!!!\",\n \"follow_up_answer_choice\": null\n },\n {\n \"id\":11261046,\n \"question\": {\n \"id\": 4494499793,\n \"text\": \"How is our responsiveness?\",\n \"metric\": \"custom\"\n },\n \"choice\":\"4\",\n \"choice_label\":\"It's great.\",\n \"sentiment\":\"positive\",\n \"comment\":null,\n \"follow_up_answer\":null,\n \"follow_up_answer_choice\": null\n }\n ],\n \"id\":6260581,\n \"tags\":[\n \"support request\",\n \"VIP\"\n ],\n \"created\":\"2021-12-23T13:38:54.540655Z\",\n \"modified\":\"2021-12-23T13:38:54.540685Z\"\n}"}],"_postman_id":"45180b8c-920c-4021-a2a9-7287a30ab9e5"},{"name":"Create or update a response (extended)","id":"3c85fde0-f981-4454-a4a0-3429377e25d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the X-Simplesat-Token header generated by Postman.","key":"X-Simplesat-Token","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"survey_id\": 126925,\r\n \"tags\": [\"chocolate\", \"strawberry\"],\r\n \"answers\": [\r\n {\r\n \"question_id\": 162249,\r\n \"choice\": \"10\",\r\n \"comment\": \"\",\r\n \"follow_up_answer\": \"Thank you 10 times!\"\r\n }\r\n ],\r\n \"team_members\": [\r\n {\r\n \"external_id\": null,\r\n \"name\": \"Alexander\",\r\n \"email\": \"Alexander@gmail.com\",\r\n \"custom_attributes\": {\r\n \"group\": \"Support\",\r\n \"language\": \"English\"\r\n },\r\n \"role\": \"Owner\",\r\n \"is_primary\": true\r\n }\r\n ],\r\n \"ticket\": {\r\n \"external_id\": 1234,\r\n \"subject\": \"My printer is on fire!\",\r\n \"custom_attributes\": {\r\n \"priority\": \"Urgent\",\r\n \"type\": \"Help desk\"\r\n }\r\n },\r\n \"customer\": {\r\n \"external_id\": \"9942423132967\",\r\n \"name\": \"Jackson Doe\",\r\n \"email\": \"jackson@example.com\",\r\n \"tags\": [\"vip\", \"funny\"],\r\n \"company\": \"Rindge, Inc.\",\r\n \"custom_attributes\": {\r\n \"type\": \"IT\",\r\n \"area\": \"area51\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.simplesat.io/api/v1/responses/create-or-update","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","responses","create-or-update"],"host":["api","simplesat","io"],"query":[],"variable":[]}},"response":[{"id":"f7626383-7478-428b-939e-10b7a8322299","name":"Create or update a response (extended)","originalRequest":{"method":"POST","header":[{"key":"X-Simplesat-Token","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"survey_id\": 15418,\n \"tags\": [\"chocolate\", \"strawberry\"],\n \"answers\": [\n {\n \"question_id\": 57507,\n \"choice\": \"4\",\n \"comment\": null,\n \"follow_up_answer\": \"Thank you 3 times!\"\n }\n ],\n \"team_members\": [\n {\n \"external_id\": \"2340424\",\n \"name\": \"John Doe\",\n \"email\": \"jdoe@example.com\",\n \"custom_attributes\": {\n \"group\": \"Support\",\n \"language\": \"English\"\n },\n \"role\": \"Assignee\",\n \"is_primary\": true\n },\n {\n \"external_id\": \"23409978\",\n \"name\": \"Jane Doe\",\n \"email\": \"janed@example.com\",\n \"role\": \"Opened by\",\n \"is_primary\": false\n }\n ],\n \"ticket\": {\n \"external_id\": \"2384\",\n \"subject\": \"My printer is on fire!\",\n \"custom_attributes\": {\n \"priority\": \"Urgent\",\n \"type\": \"Help desk\"\n }\n },\n \"customer\": {\n \"external_id\": \"9942423132967\",\n \"name\": \"Jackson Doe\",\n \"email\": \"jackson@example.com\",\n \"tags\": [\"vip\", \"funny\"],\n \"company\": \"Rindge, Inc.\",\n \"custom_attributes\": {\n \"type\": \"IT\",\n \"area\": \"area51\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.simplesat.io/api/v1/responses"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"survey\":{\n \"id\":17072,\n \"name\":\"Satisfaction Survey\"\n },\n \"ticket\":{\n \"id\":6312090,\n \"external_id\":\"2384\",\n \"subject\":\"My printer is on fire!\",\n \"custom_attributes\":{\n \"priority\":\"Urgent\",\n \"type\":\"Help desk\"\n }\n },\n \"team_members\":[\n {\n \"id\":11378,\n \"external_id\":\"2340424\",\n \"name\":\"John Doe\",\n \"email\":\"jdoe@example.com\",\n \"custom_attributes\":{\n \"group\":\"Support\",\n \"language\":\"English\"\n },\n \"role\":\"Assignee\",\n \"is_primary\":true\n },\n {\n \"id\":43901,\n \"external_id\":\"23409978\",\n \"name\":\"Jane Doe\",\n \"email\":\"janed@example.com\",\n \"custom_attributes\":{\n \n },\n \"role\":\"Opened by\",\n \"is_primary\":false\n }\n ],\n \"customer\":{\n \"id\":13592781,\n \"external_id\":\"9942423132967\",\n \"name\":\"Jackson Doe\",\n \"email\":\"jackson@example.com\",\n \"company\":\"Rindge, Inc.\",\n \"tags\":[\n \"funny\",\n \"vip\"\n ],\n \"custom_attributes\":{\n \"area\":\"area51\",\n \"type\":\"IT\"\n }\n },\n \"answers\":[\n {\n \"id\":11305838,\n \"question\": {\n \"id\": 44993,\n \"text\": \"How did we do?\",\n \"metric\": \"csat\"\n },\n \"choice\":\"4\",\n \"choice_label\":\"Great, I'm satisfied.\",\n \"sentiment\":\"positive\",\n \"comment\":null,\n \"follow_up_answer\":\"Thank you 3 times!\",\n \"follow_up_answer_choice\": null\n }\n ],\n \"id\":6284765,\n \"tags\":[\n \"chocolate\",\n \"strawberry\"\n ],\n \"created\":\"2021-12-27T08:43:07.401951Z\",\n \"modified\":\"2021-12-27T08:43:07.401979Z\"\n}"}],"_postman_id":"3c85fde0-f981-4454-a4a0-3429377e25d3"},{"name":"Update a response (extended)","id":"96a8391b-4b50-451b-9223-cedef0c98b21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.simplesat.io/api/v1/responses/13371566/update","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","responses","13371566","update"],"host":["api","simplesat","io"],"query":[],"variable":[]}},"response":[{"id":"1e48bc19-2fdd-4a25-988f-b8227fac4f0c","name":"Update a response (extended)","originalRequest":{"method":"POST","header":[{"key":"X-Simplesat-Token","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"survey_id\": 15418,\n \"tags\": [\"chocolate\", \"strawberry\"],\n \"answers\": [\n {\n \"question_id\": 57507,\n \"choice\": \"4\",\n \"comment\": null,\n \"follow_up_answer\": \"Thank you 3 times!\"\n }\n ],\n \"team_members\": [\n {\n \"external_id\": \"2340424\",\n \"name\": \"John Doe\",\n \"email\": \"jdoe@example.com\",\n \"custom_attributes\": {\n \"group\": \"Support\",\n \"language\": \"English\"\n },\n \"role\": \"Assignee\",\n \"is_primary\": true\n },\n {\n \"external_id\": \"23409978\",\n \"name\": \"Jane Doe\",\n \"email\": \"janed@example.com\",\n \"role\": \"Opened by\",\n \"is_primary\": false\n }\n ],\n \"ticket\": {\n \"external_id\": \"2384\",\n \"subject\": \"My printer is on fire!\",\n \"custom_attributes\": {\n \"priority\": \"Urgent\",\n \"type\": \"Help desk\"\n }\n },\n \"customer\": {\n \"external_id\": \"9942423132967\",\n \"name\": \"Jackson Doe\",\n \"email\": \"jackson@example.com\",\n \"tags\": [\"vip\", \"funny\"],\n \"company\": \"Rindge, Inc.\",\n \"custom_attributes\": {\n \"type\": \"IT\",\n \"area\": \"area51\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.simplesat.io/api/v1/responses/{{id}}/update"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"survey\":{\n \"id\":17072,\n \"name\":\"Satisfaction Survey\"\n },\n \"ticket\":{\n \"id\":6312090,\n \"external_id\":\"2384\",\n \"subject\":\"My printer is on fire!\",\n \"custom_attributes\":{\n \"priority\":\"Urgent\",\n \"type\":\"Help desk\"\n }\n },\n \"team_members\":[\n {\n \"id\":11378,\n \"external_id\":\"2340424\",\n \"name\":\"John Doe\",\n \"email\":\"jdoe@example.com\",\n \"custom_attributes\":{\n \"group\":\"Support\",\n \"language\":\"English\"\n },\n \"role\":\"Assignee\",\n \"is_primary\":true\n },\n {\n \"id\":43901,\n \"external_id\":\"23409978\",\n \"name\":\"Jane Doe\",\n \"email\":\"janed@example.com\",\n \"custom_attributes\":{\n \n },\n \"role\":\"Opened by\",\n \"is_primary\":false\n }\n ],\n \"customer\":{\n \"id\":13592781,\n \"external_id\":\"9942423132967\",\n \"name\":\"Jackson Doe\",\n \"email\":\"jackson@example.com\",\n \"company\":\"Rindge, Inc.\",\n \"tags\":[\n \"funny\",\n \"vip\"\n ],\n \"custom_attributes\":{\n \"area\":\"area51\",\n \"type\":\"IT\"\n }\n },\n \"answers\":[\n {\n \"id\":11305838,\n \"question\": {\n \"id\": 44993,\n \"text\": \"How did we do?\",\n \"metric\": \"csat\"\n },\n \"choice\":\"4\",\n \"choice_label\":\"Great, I'm satisfied.\",\n \"sentiment\":\"positive\",\n \"comment\":null,\n \"follow_up_answer\":\"Thank you 3 times!\"\n }\n ],\n \"id\":6284765,\n \"tags\":[\n \"chocolate\",\n \"strawberry\"\n ],\n \"created\":\"2021-12-27T08:43:07.401951Z\",\n \"modified\":\"2021-12-27T08:43:07.401979Z\"\n}"}],"_postman_id":"96a8391b-4b50-451b-9223-cedef0c98b21"},{"name":"Update a response","id":"aa401104-8eef-4ace-b52e-8c6faa9985d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.simplesat.io/api/v1/responses/13371566","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","responses","13371566"],"host":["api","simplesat","io"],"query":[],"variable":[]}},"response":[{"id":"4d006442-cf59-4698-a922-977b82009cc2","name":"Update a response","originalRequest":{"method":"PUT","header":[{"key":"X-Simplesat-Token","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tags\": [\n \"funny client\",\n \"feature request\"\n ],\n \"ticket\": {\n \"external_id\": \"119265800000334\",\n \"subject\": \"My hair is on fire!\",\n \"custom_attributes\": {\n \"priority\": \"urgent\"\n }\n },\n \"team_members\": [\n {\n \"id\": 42446,\n \"role\": \"Assignee\",\n \"is_primary\": true\n }\n ],\n \"answers\": [\n {\n \"question_id\": 44993,\n \"choice\": \"4\",\n \"comment\": null,\n \"follow_up_answer\": \"MY HAIR IS NO LONGER ON FIRE!!!\"\n },\n {\n \"question_id\": 44997,\n \"choice\": \"4\",\n \"comment\": null,\n \"follow_up_answer\": null\n },\n {\n \"question_id\": 44991,\n \"choice\": null,\n \"comment\": \"Love you!\",\n \"follow_up_answer\": null\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.simplesat.io/api/v1/responses/{{id}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"survey\":{\n \"id\":17072,\n \"name\":\"Satisfaction Survey\"\n },\n \"ticket\":{\n \"id\":6287916,\n \"external_id\":\"119265800000334\",\n \"subject\":\"My hair is on fire!\",\n \"custom_attributes\":{\n \"priority\":\"urgent\"\n }\n },\n \"team_members\":[\n {\n \"external_id\":\"2340424\",\n \"name\":\"John Doe\",\n \"email\":\"jdoe@example.com\",\n \"custom_attributes\":{\n \"group\":\"Support\",\n \"language\":\"English\"\n },\n \"role\":\"Assignee\",\n \"is_primary\":true\n }\n ],\n \"customer\":{\n \"id\":13592781,\n \"external_id\":\"9942423132967\",\n \"name\":\"Jackson Doe\",\n \"email\":\"jackson@example.com\",\n \"company\":\"Rindge, Inc.\",\n \"tags\":[\n \"funny\",\n \"vip\"\n ],\n \"custom_attributes\":{\n \"area\":\"area51\",\n \"type\":\"IT\"\n }\n },\n \"answers\":[\n {\n \"id\":11261044,\n \"question\": {\n \"id\": 44993,\n \"text\": \"How did we do?\",\n \"metric\": \"csat\"\n },\n \"choice\":\"4\",\n \"choice_label\":\"Great, I'm satisfied.\",\n \"sentiment\":\"positive\",\n \"comment\":null,\n \"follow_up_answer\":\"MY HAIR IS NO LONGER ON FIRE!!!\"\n },\n {\n \"id\":11261346,\n \"question\": {\n \"id\": 4494499793,\n \"text\": \"How is our responsiveness?\",\n \"metric\": \"custom\"\n },\n \"choice\":\"4\",\n \"choice_label\":\"Pretty good.\",\n \"sentiment\":\"positive\",\n \"comment\":null,\n \"follow_up_answer\":null\n },\n {\n \"id\":11261347,\n \"question\": {\n \"id\": 44991,\n \"text\": \"Anything else?\",\n \"metric\": \"custom\"\n },\n \"choice\":null,\n \"choice_label\":null,\n \"sentiment\":null,\n \"comment\":\"Love you!\",\n \"follow_up_answer\":null\n }\n ],\n \"id\":6260581,\n \"tags\":[\n \"feature request\",\n \"funny client\"\n ],\n \"created\":\"2021-12-23T13:38:54.540655Z\",\n \"modified\":\"2021-12-23T13:38:54.687639Z\"\n}"}],"_postman_id":"aa401104-8eef-4ace-b52e-8c6faa9985d7"}],"id":"a002ae17-3976-4e14-ac64-541ad9f57258","description":"

Response model

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
id	Number
created	DateTime
modified	DateTime
survey_id	Number
tags	Array
answers	Array	Array of the answer model
team_members	Array	Array of the team member model
ticket	Object	Object of the ticket model
customer_id	Number

Ticket model

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
id	Number
external_id	String
subject	String
custom_attributes	Object

","_postman_id":"a002ae17-3976-4e14-ac64-541ad9f57258","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","type":"collection"}}},{"name":"Surveys","item":[{"name":"List surveys","id":"6c4398fb-a47d-4a47-b303-696e1c799c8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.simplesat.io/api/v1/surveys","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","surveys"],"host":["api","simplesat","io"],"query":[],"variable":[]}},"response":[{"id":"b214859d-9327-4699-abb8-1abcc156ef4e","name":"List surveys","originalRequest":{"method":"GET","header":[],"url":"https://api.simplesat.io/api/v1/surveys"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"surveys\": [\n {\n \"id\": 15418,\n \"name\": \"Ticket satisfaction\",\n \"metric\": \"CSAT\"\n },\n {\n \"id\": 14383,\n \"name\": \"Post-project CES survey\",\n \"metric\": \"CES\"\n },\n {\n \"id\": 13578,\n \"name\": \"Quarterly NPS\",\n \"metric\": \"NPS\"\n }\n ]\n}"}],"_postman_id":"6c4398fb-a47d-4a47-b303-696e1c799c8b"}],"id":"0f46bd1b-b509-432d-95c2-16e2d8d08363","description":"

Survey model

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
id	Number
name	String
metric	String

","_postman_id":"0f46bd1b-b509-432d-95c2-16e2d8d08363","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","type":"collection"}}},{"name":"Team members","item":[{"name":"Get a team member","id":"1865d2d3-4fb9-492f-b6f2-d757f2cc2f14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"url":"https://api.simplesat.io/api/v1/team-members/{{id}}","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","team-members","{{id}}"],"host":["api","simplesat","io"],"query":[],"variable":[]}},"response":[{"id":"a67bbd40-8c21-4be9-a121-2c1150030920","name":"Get a team member","originalRequest":{"method":"GET","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"url":"https://api.simplesat.io/api/v1/team-members/{{id}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 42446,\n \"external_id\": \"5235893\",\n \"name\": \"John Smith\",\n \"email\": \"jsmith@gmail.com\",\n \"custom_attributes\": {\n \"language\": \"English\",\n \"region\": \"North America\"\n }\n}"}],"_postman_id":"1865d2d3-4fb9-492f-b6f2-d757f2cc2f14"},{"name":"Update a team member","id":"ae779706-a260-4265-a87f-3aa565dfb35a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.simplesat.io/api/v1/team-members/{{id}}","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","team-members","{{id}}"],"host":["api","simplesat","io"],"query":[],"variable":[]}},"response":[{"id":"04266a42-9d26-47e6-88b4-712ec04328c9","name":"Update a team member","originalRequest":{"method":"PUT","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"custom_attributes\": {\n \"language\": \"Spanish\",\n \"region\": \"Mexico\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.simplesat.io/api/v1/team-members/{{id}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 43857,\n \"external_id\": \"5235893\",\n \"name\": \"John Smith\",\n \"email\": \"jsmith@gmail.com\",\n \"custom_attributes\": {\n \"language\": \"Spanish\",\n \"region\": \"Mexico\"\n }\n}"}],"_postman_id":"ae779706-a260-4265-a87f-3aa565dfb35a"},{"name":"Create or update a team member","id":"e5615250-2e38-43f7-999f-6a3a6d7d529d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Simplesat-Token","value":"","type":"text"}],"url":"https://api.simplesat.io/api/v1/team-members","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","team-members"],"host":["api","simplesat","io"],"query":[],"variable":[]}},"response":[{"id":"d527fe61-0d1b-4817-b362-7cfa7f203043","name":"Create or update a team member","originalRequest":{"method":"POST","header":[{"key":"X-Simplesat-Token","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"5235893\",\n \"name\": \"John Smith\",\n \"email\": \"jsmith@gmail.com\",\n \"custom_attributes\": {\n \"language\": \"English\",\n \"region\": \"North America\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.simplesat.io/api/v1/team-members/"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 43857,\n \"external_id\": \"5235893\",\n \"name\": \"John Smith\",\n \"email\": \"jsmith@gmail.com\",\n \"custom_attributes\": {\n \"language\": \"English\",\n \"region\": \"North America\"\n }\n}"}],"_postman_id":"e5615250-2e38-43f7-999f-6a3a6d7d529d"}],"id":"70fb2f74-eed0-425b-bcc6-8cec30011d20","description":"

Team member model

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
id	Number
external_id	String
name	String
email	String
custom_attributes	Object

","_postman_id":"70fb2f74-eed0-425b-bcc6-8cec30011d20","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0a012608-29fa-46fd-bed4-05077c9abfa9","id":"0a012608-29fa-46fd-bed4-05077c9abfa9","name":"Simplesat API (v1)","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Simplesat-Token"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"cd1758b5-7adf-49f8-9f24-8786ed2b6747","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2210994b-5037-4dfc-8c76-cb7099f81f29","type":"text/javascript","exec":[""]}}],"variable":[{"key":"access token","value":""},{"key":"simplesat_demo_1316","value":"","type":"string","disabled":true}]}