The Actor processes one report mode per run. The main form has five fields and one collapsed section of inclusion switches.
| Field | Type | Required | Default / prefill | Description |
|---|---|---|---|---|
mode |
string | Yes | league |
league, team, player, match, player_search or global_trends. |
league |
string | For League | EPL |
EPL, La_liga, Bundesliga, Serie_A, Ligue_1 or RFPL. Ignored by other modes. |
season |
integer | For League and Team | 2024 |
Season start year from 2014 to 2100. 2024 means 2024/25. |
target |
string | Mode-dependent | empty | Team name/slug/URL, player ID/URL, match ID/URL or player-name search text. Empty uses a working example. |
maxItems |
integer | No | 1000 / 1 |
Run-wide limit for saved and billed rows. The web form prefills 1; an API request that omits it defaults to 1000. |
includePlayers |
boolean | No | true |
Adds player summary rows to League and Team reports. |
includeMatches |
boolean | No | true |
Adds match rows to League, Team and Player reports. |
includeShots |
boolean | No | true |
Adds shot rows to Player and Match reports. |
includeBreakdowns |
boolean | No | true |
Adds tactical/statistical breakdown rows to Team reports. |
includeRosters |
boolean | No | true |
Adds player appearance rows to Match reports. |
| Mode | Accepted target examples |
|---|---|
team |
Arsenal, an Understat team slug, or https://understat.com/team/Arsenal/2024 |
player |
7322 or https://understat.com/player/7322 |
match |
26602 or https://understat.com/match/26602 |
player_search |
Saka or another name fragment of 2 to 100 characters |
League and Global trends ignore target. A season included in a Team URL overrides the separate season value.
maxItems: 1 to 5,000 rows.season: 2014 to 2100, although the source does not necessarily contain every accepted season.target: at most 200 characters.- Player and match numeric IDs: 1 to 99,999,999.
- Player search: 2 to 100 characters.
- Extra properties are rejected.
- Network retries and fallback behavior are managed by the Actor; there is no user-facing proxy, retry or timeout input.
The schema retains hidden legacy API fields for backward compatibility. New integrations should use target.