Get Objective Completion Rate
GET /v2/partner/objectives/{id}/completion-rate
Required scopes
partner:insights:read
Tokens missing any required scope return 401 scope_missing.
See Auth & Scopes for issuance.
Operation
| Operation ID | getObjectiveCompletionRate |
| Tags | Outcomes |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| id * | path | id | |
| — | |||
| — | |||
| start | query | updated_at | |
| end | query | updated_at |
Responses
200
OK
object
| Field | Type | Description |
|---|---|---|
| objective_id * | id | UUID v4. |
| window * | window | Time-window per `00-conventions.md` §4. `start` inclusive, `end` exclusive. |
| completions * | integer | |
| eligible_contacts * | integer | |
| rate * | number | |
| benchmark | number | |
| vs_benchmark | enum (3) | aboveatbelow |
| computed_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
Example request
GET https://api.digitalonboarding.com/v2/partner/objectives/{id}/completion-rate?<query-params>
Authorization: Bearer <partner-token>