The API gives your own tools the same numbers your dashboard shows: for each student, how many tickets they worked and resolved, how many calls they took, and how many hours they logged, for one day or a range of days. A teacher who sends an end-of-day progress report can pull today’s figures into it automatically.

It only reads. Nothing you do through it changes a classroom, a student or an assignment.

Get a key

  1. Open the teacher dashboard and go to the Developers tab.
  2. Select Create key.
  3. Give the key a name you will recognize later, for example the name of the app that will use it, and select Create key again.
  4. A window shows the key under Save your API key. Click the key to copy it. It starts with sds_ and is shown only once.
  5. Select Done. The key is now listed by name with its secret hidden.

If you lose a key, select Reset beside it. The old secret stops working right away and a new one is shown once. Revoke removes a key for good.

You can hold up to five keys at once. Each one shows when it was created and when it was last used, so you can tell which are still in use.

Treat a key like a password: it opens your classrooms’ student names, emails and activity. Keep it on your own computer or server, not in a page your students can open.

Make a request

Send the key in an Authorization header.

List the classrooms the key can read:

curl -H "Authorization: Bearer sds_your_key" \
  https://servicedesk-simulator.com/api/v1/classrooms

Each classroom comes back with its id. Use it to read one day:

curl -H "Authorization: Bearer sds_your_key" \
  "https://servicedesk-simulator.com/api/v1/classrooms/CLASSROOM_ID/activity?date=2026-11-10"

Or a range of up to a year, with from and to:

.../activity?from=2026-11-03&to=2026-11-07

What comes back

One row per student in the classroom:

FieldMeaning
username, emailWho the row is about
ticketsWorkedTickets they finished that day, resolved or not
ticketsResolvedTickets they actually resolved
callsPhone calls they handled
hoursLoggedHours of active work, to one decimal place

A range also returns a days object with the same four numbers for each day.

Days count in each student’s own time zone, the same way their hours are logged.

ticketsResolved and calls are counted from 10 November 2026 onward. For earlier days they come back as null, which means “not recorded”, not zero; ticketsWorked and hoursLogged go further back.

Who can use it

The account that owns the Teacher Module and its co-administrators can each create their own keys. A key reads exactly the classrooms its owner can open on the dashboard. If that person’s access ends, the key stops working with it.

Revoking a key on the card takes effect immediately.

Limits

Up to 30 requests a minute per account. A request past that gets status 429; wait a minute and try again.

The same numbers without code

Not writing an app? On the Students tab, pick Today (or any range) above the list and export the CSV. With a range picked, the Tickets Resolved, Tickets Worked and Calls Handled columns count that window only, next to Hours Logged.