Survey¶

The Survey APIs allow you to get survey results and assess survey status.

GetResults¶

Gets survey results.

URL: base/Survey/GetResults
Method: POST

{
  "Format": "sample string 1",
  "Header": true,
  "Since": "2020-02-04T16:09:42.9927661+00:00",
  "SortOrder": 1,
  "SurveyReference": "sample string 2"
}

Parameters¶

Name	Description
`Format`	Result format. See supported formats below.
`Header`	Whether a header row is supplied in delimited exports.
`Since`	Date/time from which to check results.
`SortOrder`	Minimum question sort order required for results to be included.
`SurveyReference`	Unique survey reference.

Format¶

Format	Description
`CSV`	Comma delimited.
`PIPE`	Pipe delimited.
`TAB`	Tab delimited.
`XML`	XML structured format.
`JSON`	JSON structured format.

Returns¶

The survey results in the requested format.

Statuses¶

Status	Description
404	Not found.
400	There was a problem getting the survey results.
404	No results found since the specified timestamp.

GetSnapshot¶

Warning

This method has been retired and is no longer available.

Gets a snapshot of specific question results.

URL: base/Survey/GetSnapshot
Method: GET

{
  "SurveyReference": "sample string 1",
  "SortOrder": 2
}

Statuses¶

Status	Description
404	This survey does not exist.
400	There was a problem processing the survey snapshot.
400	The survey has not yet shown any activity.
400	The sort order is out of range.

Status¶

Gets the status of a survey.

URL: base/Survey/Status?surveyReference={surveyReference}
Method: POST

Return parameters¶

Name	Description
`Recipients`	Number of recipients in the survey recipient list.
`Anomalies`	Number of anomalies encountered.
`Completed`	Number of completed interviews.
`Started`	Number of started interviews.
`Delivered`	Number of invites delivered.
`Abandoned`	Number of abandoned interviews.
`Outstanding`	Number of outstanding interviews.

Example response:

{
  "Recipients": "recipientCount",
  "Anomalies": "anomalyCount",
  "Completed": "completionCount",
  "Started": "startedCount",
  "Delivered": "deliveredCount",
  "Abandoned": "abandonedCount",
  "Outstanding": "outstandingCount"
}

Statuses¶

Status	Description
404	This survey does not exist.
400	The survey has not yet shown any activity.
400	The sort order is out of range.