Sign in

v1

latestOpenAPI 3.1.02026-07-175212.7 KB
responses

Get responses

Gets responses from the database.

get/responses

Query parameters

surveyIdstring required
limitnumber
skipnumber
sortBy'createdAt' | 'updatedAt'
order'asc' | 'desc'
startDatestring required
endDatestring required
contactIdstring required

Response

Responses retrieved successfully.

idstring required

The ID of the response

createdAtstring required

The date and time the response was created

updatedAtstring required

The date and time the response was last updated

finishedboolean required

Whether the response is finished

surveyIdstring required

The ID of the survey

contactIdstring nullable required

The ID of the contact

endingIdstring nullable required

The ID of the ending

dataobject required

The data of the response

variablesobject required

The variables of the response

ttcobject required

The TTC of the response

contactAttributesobject nullable required

The attributes of the contact

singleUseIdstring nullable required

The single use ID of the response

languagestring nullable required

The language of the response

displayIdstring nullable required

The display ID of the response

Example response

[
  {
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z",
    "finished": true,
    "data": {
      "question1": "answer1",
      "question2": 2,
      "question3": [
        "answer3",
        "answer4"
      ],
      "question4": {
        "subquestion1": "answer5"
      }
    },
    "variables": {
      "variable1": "answer1",
      "variable2": 2
    },
    "ttc": {
      "question1": 10,
      "question2": 20
    },
    "meta": {
      "source": "https://example.com",
      "url": "https://example.com",
      "userAgent": {
        "browser": "Chrome",
        "os": "Windows",
        "device": "Desktop"
      },
      "country": "US",
      "action": "click"
    },
    "contactAttributes": {
      "attribute1": "value1",
      "attribute2": "value2"
    },
    "language": "en"
  }
]