Answers

Search answers

Search for answers.

Required scopes: read answers

Accepted comparison values are:

  • is
  • is_not
  • contains
  • does_not_contain
  • is_unknown
  • has_any_value

Accepted key values are:

  • choice_value
  • comment
  • metric
  • sentiment
  • survey (token)
post/api/v1/answers/search

Request

  • Base URL: https://api.simplesat.io
  • URL: https://api.simplesat.io/api/v1/answers/search
  • Auth: API key in header X-Simplesat-Token

Query parameters

pageinteger

The page number to retrieve

page_sizeinteger

The number of records per page

Request body

start_datestring date-time
end_datestring date-time

Example request

{
  "start_date": "2024-01-01T00:00:00",
  "end_date": "2024-12-31T23:59:59Z",
  "filters": [
    {
      "key": "sentiment",
      "values": [
        "positive"
      ],
      "comparison": "is"
    }
  ]
}

Response

Successful response

nextstring nullable
previousstring nullable
countinteger
idinteger
choicestring
choice_labelstring
choicesstring[] nullable
commentstring nullable
follow_up_answerstring nullable
follow_up_answer_choicestring nullable
follow_up_answer_choicesstring[] nullable
published_as_testimonialboolean
createdstring date-time
modifiedstring date-time
sentimentstring
response_idinteger

Example response

{
  "next": null,
  "previous": null,
  "count": 65,
  "answers": [
    {
      "id": 1,
      "choice": "3",
      "choice_label": "Okay, but not great",
      "choices": null,
      "comment": null,
      "follow_up_answer": null,
      "follow_up_answer_choice": "yes",
      "follow_up_answer_choices": null,
      "published_as_testimonial": false,
      "created": "2024-10-11T05:38:19Z",
      "modified": "2024-11-12T03:17:13.413332Z",
      "topics": [
        {
          "id": 1,
          "name": "Response time",
          "description": "How quickly the team responded to the request.",
          "sentiment": "positive"
        }
      ]
    }
  ],
  "question": {
    "id": 1,
    "text": "How did we do?",
    "metric": "csat"
  },
  "sentiment": "neutral",
  "survey": [
    {
      "id": 1,
      "name": "Generic"
    }
  ],
  "response_id": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.