WOworkable

/surveys/:id/outcomes

Changed on

Returns aggregated results of a survey cycle: a response overview and per-question statistics. Required scope: r_surveys. Requires a user token whose member has permission to view survey cycles, or an account token with the member_id of such a member; an account token without member_id gets 403. The account must have the Surveys feature enabled.

Only submitted responses of employees the member may view are aggregated. For anonymous surveys with min_responses_required > 0, the choice breakdown (ratings[].count, percentage, average_score) is withheld until the threshold is met overall and per question. limit / offset paginate questions; total is the number of matching questions.

get/surveys/{id}/outcomes

Request

  • Base URL
    https://subdomain.workable.com/spi/v3
  • URL
    https://subdomain.workable.com/spi/v3/surveys/{id}/outcomes
  • Auth
    API key in header Authorization

Path parameters

idstring required

Survey cycle key (as returned by GET /surveys)

Query parameters

limitinteger

Maximum number of questions to return. When omitted, all questions are returned.

offsetinteger

Number of questions to skip (for pagination).

question_ids[]string[]

Restrict the outcomes to these question ids. Ids not in the survey's questionnaire are ignored.

member_idstring

Required when using an account token: the member (SPI key, from GET /members) to act as. The request is evaluated with that member's permissions; without it the request gets 403. Ignored for user tokens.

Response

200

totalinteger

Changes