Sign in
Scorecards

Close scorecard

Finalises a previously opened scorecard, locking its data and returning the aggregate results.
After a scorecard is closed, additional RESET or ACTION commands using its card_id are rejected.
You must supply the card_id obtained from /scorecard/open.

post/api/scorecard/close

Request body

card_idstring required

Identifier of the scorecard to close—use the card_id returned by OpenScorecardResponse.

Response

scorecard closed; final aggregate results returned.

card_idstring required

The scorecard ID returned by OpenScorecardResponse.

scoreinteger required

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

source_urlstring uri

Link originally supplied in the OpenScorecardRequest.

tagsstring[]

Arbitrary labels echoed back from the open request.

user_namestring

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

user_idstring

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

published_atstring date-time

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

opaqueobject

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

open_atstring date-time required

When the scorecard was opened.

last_updatestring date-time required

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

total_environments_completedinteger required

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

total_environmentsinteger required

Total number of environments in this scorecard.

total_levels_completedinteger required

Cumulative levels completed across all runs.

total_levelsinteger required

Total number of levels across all environments.

total_actionsinteger required

Cumulative number of actions taken across all plays.

Changes

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