Skip to main content

Assessor.io API v2 (public) - Assessment inventory (the codebook)

The INSTRUMENT behind a campaign's answers. Every other v2 read hands you answers keyed by machine name; this hands you what those names asked. Per assessment, the question inventory is projected from the SurveyJS body the assessment was ANSWERED against (the pinned template version, not whatever the template row holds today): name, type, the page it sat on, the question title and every part label per locale, the values a stored answer can take (matrix rows and columns, multipletext items, choices), the BIMMaS coding frame, and the visibleIf routing condition verbatim. Each question also carries exportColumns - the ans: column headers the results export writes, in the same fields export.codebook uses - so a downloaded column and a question can be joined by string equality. No respondent data is returned. Requires a service token holding campaigns:read and scoped to the accountId in the path.

Getting a token, the scopes and the response envelope are explained in Make your first API call and Public API (v2).

Contract Summary​

  • Version: 1.1.1
  • Visibility: public
  • Operations: 1
  • Tags: PublicAssessments

Operations​

MethodPathSummaryOperation ID
GET/api/v2/public/accounts/{accountId}/campaigns/{campaignId}/assessmentsThe campaign's assessment inventory - the codebook.v2ListCampaignAssessments

Raw Contract​