Get User Performance Report
Return the performance report per user, with the metrics used to compare
progress across the organization.
Authentication
Api-Keystring
API key of the organization. Always sent together with the Secret-Access header.
Path parameters
organization_slug
Headers
Secret-Access
Query parameters
user_id
user_email
user_status
from_date
Start of the range, in YYYY-MM-DD format. Inclusive. With no to_date the range stays open going forward. Applies to the course enrollment date — the course_enroll_date field of the response —, interpreted in the organization’s time zone, the same one the report returns that date in.
to_date
End of the range, in YYYY-MM-DD format. Inclusive: the whole day is covered, not just its midnight. For a single day, send the same date in `from_date` and in `to_date`. Applies to the course enrollment date — the `course_enroll_date` field of the response —, interpreted in the organization's time zone, the same one the report returns that date in.
limit
Rows per page, up to 100. Defaults to 100 when omitted.
offset
Rows to skip before the page. Use it together with limit to walk the report: 0, then limit, then twice limit, and so on.
Response
Successful Response
results
total
Errors
400
Bad Request Error
422
Unprocessable Entity Error