---
title: "Multiplayer matches overview"
method: GET
path: "/v1/reports/matches/"
tags: ["Reports"]
---

# Multiplayer matches overview

`GET /v1/reports/matches/`

## Request

- Base URL: `https://api.educaplay.com`
- URL: `https://api.educaplay.com/v1/reports/matches/`
- Auth: HTTP bearer

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

## Query parameters

- `filter` 'lastDay' | 'lastWeek' | 'lastYear' | 'custom'
- `tss` string
- `tse` string
- `page` integer

## Response `200`

Report data for the requested period.

- MatchesOverviewResponse: Aggregated results of the multiplayer matches hosted over the period.
  - `filters` ReportsFilters: Reporting period actually applied to the response.
    - `filter` string: Period preset that was applied; empty when the default last month was used.
    - `from` integer: Start of the period. Unix timestamp in seconds.
    - `to` integer: End of the period. Unix timestamp in seconds.
    - `type` string: Activity type filter that was applied, if any.
    - `clampedToLicense` boolean: `true` when the requested period reached further back than the retention window of the account's plan and was therefore shortened.
  - `items` object[]
  - `hasMore` boolean
  - `page` integer
  - `_links` HalLink[]
    - `rel` string, required
    - `href` string, uri, required

## Other responses

- `401`: Authentication is missing or the Bearer token is invalid.
- `429`: The request rate limit for the account has been exceeded. Limits depend on the subscription plan (Basic 120, Advanced 300, Academic 600 and Commercial 1200 requests per minute) and are measured over a fixed 60 second window. Wait the number of seconds given in the `Retry-After` header before retrying.

## Changes

- **2026-10-19** `e31d97013d0d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/educaplay/apis/educaplay-api/changes/v1/reports/matches/get.md)

---

[API](https://skmtc.dev/educaplay/apis/educaplay-api.md) · [All operations](https://skmtc.dev/educaplay/apis/educaplay-api/llms.txt) · [OpenAPI document](https://skmtc.dev/educaplay/apis/educaplay-api/revisions/e31d97013d0d?raw)