Skip to main content
GET
Retrieve scorecard (one game)

Authorizations

X-API-Key
string
header
required

Path Parameters

card_id
string
required

Identifier returned by /scorecard/open.

game_id
string
required

Game identifier to filter by (e.g. ls20-1d57d6daeb05).

Response

scorecard found; statistics for the requested game.

Aggregate results for an entire scorecard run.
Returned when closing a scorecard or when retrieving a scorecard (open or closed). Includes cumulative totals, optional metadata echoed from the open request (e.g. source_url, tags, opaque), user identity (user_name, user_id), timestamps (open_at, last_update, published_at), and a per-environment breakdown in environments. The tags_scores array provides per-tag aggregates for runs that were tagged.

card_id
string
required

The scorecard ID returned by OpenScorecardResponse.

score
integer
required

Aggregate score for this scorecard (sum of per-level scores).

environments
object[]
required

Per-environment breakdown; each entry is one game/environment with its runs.

open_at
string<date-time>
required

When the scorecard was opened.

last_update
string<date-time>
required

When the scorecard was last updated (e.g. last action or close).

total_environments_completed
integer
required

Number of environments that reached a terminal state (WIN or GAME_OVER).

total_environments
integer
required

Total number of environments in this scorecard.

total_levels_completed
integer
required

Cumulative levels completed across all runs.

total_levels
integer
required

Total number of levels across all environments.

total_actions
integer
required

Cumulative number of actions taken across all plays.

source_url
string<uri>

Link originally supplied in the OpenScorecardRequest.

tags
string[]

Arbitrary labels echoed back from the open request.

user_name
string

Display name of the user who opened/ran this scorecard.

user_id
string

Stable identifier of the user (e.g. provider subject id).

published_at
string<date-time>

When the scorecard was closed/published (absent if still open).

opaque
object

Free-form JSON blob (≤ 16 KB) exactly as provided when the scorecard was opened. Absent if none was supplied.

tags_scores
object[]

Per-tag aggregate statistics for runs that were tagged.