Reports

Multiplayer matches overview

Changed on

Aggregated results of the multiplayer matches hosted by the authenticated user over the selected period.

get/v1/reports/matches/

Request

  • Base URL: https://api.educaplay.com
  • URL: https://api.educaplay.com/v1/reports/matches/
  • 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.

Response

Report data for the requested period.

itemsobject[]
hasMoreboolean
pageinteger

Example response

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

Changes