---
title: "Players KPIs"
method: GET
path: "/v1/reports/players/kpis/"
tags: ["Reports"]
---

# Players KPIs

`GET /v1/reports/players/kpis/`

## Request

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

Headline KPIs of the players report, together with the weekly sparklines that accompany them.

## Query parameters

- `filter` 'lastDay' | 'lastWeek' | 'lastYear' | 'custom'
- `tss` string
- `tse` string
- `players` '' | 'guests'
- `ids` string

## Response `200`

Report data for the requested period.

- PlayersPanelResponse: Selection context echoed back by every endpoint of the players report.
  - `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.
  - `segment` string: Player segment that was applied.
  - `selected` string[]: Player keys the report was restricted to.
  - `tooManySelected` boolean: `true` when more than 100 player keys were supplied and the selection was ignored.

## 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.

---

[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)