School Unit Dashboard

Endpoint used to retrieve the consumption data displayed in the desired school unit dashboard in Toolzz LMS.

Request Example

curl --request GET \
  --url 'https://kong.api.toolzz.com.br/api/reports/school/{school_id}/dashboard' \
  --header 'Authorization: Bearer <token>'

Response Example

{
  "data": {
    "consumeContent": [],
    "access": {
      "monthly": [
        {
          "month": "<string>",
          "access": 123
        }
      ],
      "daily": [],
      "hourly": []
    },
    "numbers": {
      "responsibles": 10,
      "teachers": 5,
      "students": 100,
      "matriculations": 200,
      "courses": 15,
      "classes": 8,
      "contents": 50
    }
  }
}

---

Request description

Access Token

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

URL Parameters (Path)

Parameter	Type	Description	Required
school_id	string	School numeric identifier.	Yes

---

Response description

Key	Type	Description
data	object	Contains the statistical data.
data.consumeContent	array	List of consumed content.
data.access	object	Access statistics categorized by time period.
data.access.monthly	array	Monthly access data.
data.access.monthly.month	string	Month name.
data.access.monthly.access	number	Number of accesses in the month.
data.access.daily	array	Daily access data.
data.access.hourly	array	Hourly access data.
data.numbers	object	Summary of key metrics.
data.numbers.responsibles	number	Number of responsible users.
data.numbers.teachers	number	Number of teachers.
data.numbers.students	number	Number of students.
data.numbers.matriculations	number	Total enrollments.
data.numbers.courses	number	Total courses.
data.numbers.classes	number	Total classes.
data.numbers.contents	number	Total content items.

---

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.