Surveys / REFERENCE

Read survey results

Return aggregate results by question. Requires the separate surveys:results:read scope.

GET/api/v1/surveys/{id}/results

Permissions surveys:results:read

Parameters

Name	Description
`X-Luma-Workspace-Host`header · required	Your workspace host, e.g. acme.lumi-cx.com. Required on api.lumi-cx.com. This header never grants access: the Bearer key must belong to the selected workspace.
`id`path · required	Record identifier in this workspace.
`versionId`query	Optionally restrict results to one survey version.

Responses

200 Successful operation

{
  "ok": true,
  "responseCount": 1,
  "summary": [
    {
      "questionId": "00000000-0000-4000-8000-000000000001",
      "type": "example",
      "count": 1,
      "average": 1,
      "distribution": {},
      "textAnswers": [
        "example"
      ]
    }
  ]
}

400 Invalid request

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

401 Missing, invalid, expired, revoked or wrong-workspace key

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

403 Required key permission missing, module unavailable, or workspace suspended

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

404 Record, workspace or route not found

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

409 Version changed or the resource is locked

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

429 Rate limit exceeded; respect Retry-After

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

502 Upstream or unexpected server error

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}