Skip to content

support_response_get

Get one survey response by id, with its answers exactly as they were submitted.

Tool

support_response_get

Get one survey response by id, with its answers exactly as they were submitted.

Get one survey response by id, with its answers exactly as they were submitted. A response belonging to another product is reported as not found

Behavior

HTTP
GET /support/responses/:id

Arguments

Name
Type
Required
Description
id
string
•
Response id

Response

Field
Type
Always
Description
id
string
•
Response id
score
integer
•
The answer of the first nps or rating question, raw and never rescaled, or null when neither was answered. Null is not zero — 0 is a real score at the bottom of an NPS scale
answers
object
•
Answers keyed by question id, exactly as stored
metadata
object
•
Free-form client-owned JSON
surveyId
string
•
The survey that was answered
completed
boolean
•
Whether the respondent reached the end
createdAt
string
•
ISO-8601 creation timestamp
updatedAt
string
•
ISO-8601 last-modification timestamp
authorExternalId
string
•
The respondent, byte-identical to what was stored
escalatedThreadId
string
•
The feedback thread this response was escalated into, or null while it has not been

Try it

Get one survey response by id, with its answers exactly as they were submitted.

When to use

Get one survey response by id, with its answers exactly as they were submitted. A response belonging to another product is reported as not found

Example

Ask your agent something like this:

Get one survey response by id, with its answers exactly as they were submitted.

The agent will invoke support_response_get with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select