Survey results

Módulo Workforce

GET/surveys/{id}/resultssurveys.results

Results, shown only once the minimum number of responses is met. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requiere la capacidad knowledge.sop.publish.
Alcances de OAuth: knowledge.
Estados de error: 400, 401, 404, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

surveys.results: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the survey.

Respuesta 200: SurveyResults

surveys.results: SurveyResults
Campo	Tipo	Obligatorio	Descripción
survey_id	string (uuid)	Sí	Survey.
responses	integer	Sí	Responses so far.Restricciones: range 0 to any
min_responses	integer	Sí	Responses needed before results show.Restricciones: range 0 to any
threshold_met	boolean	Sí	Whether results show.
audience	integer	Sí	Members in the audience.Restricciones: range 0 to any
questions	array of object	Sí	Per question results; empty below the threshold.

{
  "survey_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "responses": 12,
  "min_responses": 5,
  "threshold_met": true,
  "audience": 40,
  "questions": []
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/surveys/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/results" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data } = await xos.surveys.results("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");

response = xos.surveys.results("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")

xos surveys results 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f