Skip to content

Support

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

NameTypeRequiredDescription
idstringResponse id

Response

FieldTypeAlwaysDescription
idstringResponse id
scoreintegerThe 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
answersobjectAnswers keyed by question id, exactly as stored
metadataobjectFree-form client-owned JSON
surveyIdstringThe survey that was answered
completedbooleanWhether the respondent reached the end
createdAtstringISO-8601 creation timestamp
updatedAtstringISO-8601 last-modification timestamp
authorExternalIdstringThe respondent, byte-identical to what was stored
escalatedThreadIdstringThe 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.

navigateselect