Institution Progression Report

Endpoint used to retrieve updated course progression data for your institution in Toolzz LMS.

Request Example

curl --request GET \
  --url 'https://kong.api.toolzz.com.br/api/reports/institution/percentage' \
  --header 'Authorization: Bearer <token>'

Response Example

{
  "data": {
    "current_page": 1,
    "data": [
      {
        "user_id": 1,
        "user_name": "<string>",
        "user_email": "<string>",
        "user_cpf": "<string>",
        "course_name": "<string>",
        "percentual_usage": 5,
        "content_total": 10,
        "percentual_progress": "68%"
      }
    ]
  }
}

---

Request description

Access Token

Parameter	Type	Description	Required
Authorization	String	Access token (“Bearer” must be before the token)	Yes

---

Response description

Key	Type	Description
data	object	Contains the paginated listing of users with course progress.
data.current_page	number	Current page of the listing.
data.data	array	List of users and their progress data.
data.data.user_id	number	Unique identifier of the user.
data.data.user_name	string	Name of the user.
data.data.user_email	string	Email address of the user.
data.data.user_cpf	string	CPF of the user (may be blank).
data.data.course_name	string	Name of the course associated with the progress.
data.data.percentual_usage	number	Number of content items consumed.
data.data.content_total	number	Total content items in the course.
data.data.percentual_progress	string	Percentage progress of the course (e.g., “68%”).

---

Security

To access this endpoint, it is necessary to send a valid access token through the authorization header (Authorization) of the request. Additionally, the API is protected by other security measures to safeguard user data.