v1

latestOpenAPI 3.0.32026-07-26131237.0 KB

Scorecards

Open scorecard

Creates a new scorecard to aggregate statistics across one or more plays. The server returns a card_id, which must be included in all subsequent RESET commands and in the final /scorecard/close call. You may attach optional metadata (URL, tags, opaque JSON) that will be echoed back in summary responses.

post/api/scorecard/open

Request body

source_urlstring uri

Link to code, notebook, or write-up associated with the run.

tagsstring[]

Arbitrary labels for later filtering and aggregation.

opaqueobject

Free-form JSON data (≤ 16 KB). Stored verbatim; the service does not inspect or validate its structure.

Response

scorecard successfully created.

card_idstring required

Globally unique ID for the newly opened scorecard.