Skip to navigation
EndpointsReportsLearning

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_slugstringRequired

Headers

Secret-AccessstringRequired

Query parameters

user_idintegerOptional
user_emailstringOptional
user_statusstringOptional
limitintegerOptional1-500Defaults to 100
Rows per page, up to 500. Defaults to 100 when omitted.
offsetintegerOptional>=0

Rows to skip before the page. Use it together with limit to walk the report: 0, then limit, then twice limit, and so on.

from_datestringOptional

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_datestringOptional

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.

Response

Successful Response
resultslist of objects
totalintegerOptional

Errors

400
Bad Request Error
422
Unprocessable Entity Error