Reports

Distribution of players results

Distribution of scores and accuracy across the selected players.

get/v1/reports/players/distribution/

Request

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

players'' | 'guests'

Restricts the report to a segment of players. Empty (default) covers every player; guests covers only guest accounts.

idsstring

Comma-separated list of player keys (the key field of the players list) to restrict the report to. At most 100 keys are applied; beyond that the selection is ignored and tooManySelected is returned as true.

Response

Report data for the requested period.

segmentstring

Player segment that was applied.

selectedstring[]

Player keys the report was restricted to.

tooManySelectedboolean

true when more than 100 player keys were supplied and the selection was ignored.

Changes

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