Skip to main content

Request headers

string
required
The service user’s API token in the Bearer YOUR_TOKEN format. The school owner issues the token in the admin panel: Manage → School → For developers → API keys — see the “Authentication” section for details.
integer
required
The numeric ID of the seller — the account the school belongs to. Copy it on the API keys page, in the Integration data → Identifiers card. The token’s permissions are checked against this ID.
integer
required
The numeric ID of the school, found in the same place as Seller-Id. The value must match the seller’s school — otherwise a 400 error with cause: "ForbiddenSchoolMismatch" is returned.

Getting the report result

Use the uuid you received when creating the generation task. Send the request periodically (polling) at 2–5 second intervals until status becomes Completed or Failed. This method is not subject to the generation rate limit, but frequent polling does not speed up the export.
Right after the task is created, payload may be null: the task is queued and has not reported progress yet. Keep polling. If payload stays null for a uuid you have already received a status for, the result’s retention period has expired; start the generation again. Add an overall polling timeout to your code so you do not poll an unknown uuid forever.

Path parameters

string
required
UUID of the generation task, taken from the POST /generate response.

Response fields

boolean
The result of the request.
number
HTTP response code (for example, 200).
object | null
Data on the generation progress and result. null if the task has not started yet, if no task with this executionUuid was found, or if the result’s retention period has expired.
The result is stored for 24 hours after generation completes. After that, the method returns payload: null; to get the data again, start the generation again.

Permission requirements

Token authentication is required. The method does not require any specific permissions: data permissions are checked at generation time (see permissions by report type).

Updated: 2026-09-25 14:33 UTC