Reports

Results of a single activity

Detailed report of one activity: KPIs, charts and the most frequent wrong answers over the selected period.

get/v1/reports/games/{gameId}/

Request

  • Base URL: https://api.educaplay.com
  • URL: https://api.educaplay.com/v1/reports/games/{gameId}/
  • Auth: HTTP bearer

Path parameters

gameIdinteger required

Numeric identifier of the activity.

Query parameters

filter'lastDay' | 'lastWeek' | 'lastYear' | 'custom'

Reporting period preset. When omitted, the last month is used. Use custom together with tss and tse to define an explicit range. The range is always clamped to the retention window of the account's plan (see filters.clampedToLicense in the response).

tssstring
Example:20260801

Start date of the reporting period, in YYYYMMDD format. Only used when filter=custom.

tsestring
Example:20260821

End date of the reporting period, in YYYYMMDD format. Only used when filter=custom.

Response

Report data for the requested period.

playUrlstring

Public URL of the activity.

statsobject
kpisobject
chartsobject
topErrorsobject[]

Most frequent wrong answers.

Example response

{
  "_links": [
    {
      "rel": "self"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.