Reports

List activities with their results

Paginated list of the user's activities with the aggregated results of the period: number of plays, average accuracy, average time and rating. Pages hold up to 50 items.

get/v1/reports/games/list/

Request

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

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.

pageinteger

Zero-based page number. Use the hasMore flag in the response to know whether another page is available.

qstring

Free-text search filter applied to the name of the listed items.

typestring

Restricts the list to a single activity type, such as TEST, SOPA or FROGGY_JUMPS.

Response

Report data for the requested period.

hasMoreboolean
pageinteger

Example response

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

Changes

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