v1

latestOpenAPI 3.0.02026-07-24378968.5 KB
Survey

/survey/submissions

Get all survey submissions or filter using search criteria

get/survey/submissions

Query parameters

baseSurveyKeystring

UUID Key of a Survey.

currentVersionKeystring

UUID Key of Survey current version.

{"stackTrail":"paths:/survey/submissions:get:parameters:3:schema","oasType":"schema","type":"unknown"}

Domain Type of a Survey (chat or ticket).

roomstring

UUID Key of a Room if type equals "chat".

ticketnumber

Number of a Ticket if type equals "ticket".

isAnsweredboolean

Filter if submission Survey is answered.

createdBetweenstring

Searches by the creation date of the research submission. If you pass one createdBetween parameter, then submissions from this date to the current date will be filtered. If you pass two createdBetween parameters, then submissions created between the past dates will be filtered.

sizenumber

Number of items retrieved per page.

pagenumber

Number of the page viewed.

Headers

octa-agent-emailstring

Response

baseSurveyKeystring required

UUID Key of a Survey.

typestring required

Domain Type of a Survey (chat or ticket).

isAnsweredboolean required

Flag if submission Survey is answered.

statusstring required

Current survey status.

versionstring required

UUID Key of survey current version.

subdomainnumber required

Subdomain of the survey.

codestring required

Encripted unique code of a survey submission.