Skip to main content

Assessor.io API v2 (public) - Submissions and Exports

Read assessment submissions for a campaign, and generate a full answer export inline. 1.2.0 ADDED unitKey, ADDITIVELY, to both doors: the list DTO gains an optional unitKey, and the export's Submissions sheet gains a unitKey column beside participantId. It names the unit INSTANCE a submission belongs to, which is what an organisation- or department-level analysis groups by. Nothing was removed or renamed, and a client that ignores the field reads exactly what it read before. 1.1.0 CHANGED THE LIST'S DEFAULT POPULATION. Both doors of this spec now default to the same rows: completed and reopened submissions, no in-progress drafts. The list used to return every row, so its unfiltered meta.total was larger than the export's rowCounts.submissions for the same campaign. DEPRECATED, NOT REMOVED: pass includeDrafts=1 to get the old population back in one call, or ?status=in_progress for the drafts alone. The Public API (v2) guide on docs.assessor.io describes the change. Answer content is gated separately from submission metadata. The list endpoint needs submissions:read and returns answers ONLY when the token additionally holds submissions:read:answers, so a metadata-only token can watch completion without ever seeing responses. The export endpoint is a different gate: results:export always produces a file containing the real answers, so provision it deliberately. AUDITOR REVIEW DATA IS SCOPED SEPARATELY AGAIN. An export always applies the auditor's corrections - withholding them would hand an integrator numbers that disagree with the scorecard the client is reading - but the verdicts, reviewer keys, per-answer review columns and auditor notes are disclosed only to a token that ALSO holds submissions:read:answers. export.reviewsIncluded says which of the two files you received.

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.6.0
  • Visibility: public
  • Operations: 2
  • Tags: PublicSubmissions

Operations​

MethodPathSummaryOperation ID
GET/api/v2/public/accounts/{accountId}/campaigns/{campaignId}/submissionsList a campaign's assessment submissions.v2ListSubmissions
POST/api/v2/public/accounts/{accountId}/campaigns/{campaignId}/exportsGenerate a campaign answer export inline.v2ExportCampaignResults

Raw Contract​