Skip to main content
GET
Get Assignment Values
← Custom KPI Retrieve the full submission history for a specific campaign-assignment. Returns all KPI values ever submitted by this recipient for this campaign, ordered by submission time.

Request

Headers

string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Path Parameters

string
required
UUID of the parent dataset
string
required
UUID of the campaign
string
required
UUID of the campaign-assignment

Response

Returns an array of value objects (HTTP 200). Each value represents one KPI answer:
string
Value UUID
string
Dataset assignment UUID
string
KPI definition UUID
number
Numeric answer (nullable)
string
Text answer (nullable)
string
Date answer (nullable)
string
The chosen option of a select KPI, or the category this amount belongs to in a number_breakdown KPI (one row per category, all sharing submitted_at) (nullable)
string
ISO 8601 timestamp
string
Who submitted (nullable)

Example

Successful Response

Common Errors

401 Unauthorized

Cause: Missing or invalid API key

403 Forbidden

Cause: The authenticated user is not a member of the organization

404 Not Found

Cause: The dataset, campaign, or assignment does not exist or belongs to another organization

Edit Values

Submit or update KPI values

Campaign Values

View all values across recipients