ARarcprize
Scorecards

Open scorecard

Changed on

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

Request body

source_urlstring uri

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

tagsstring[]

Arbitrary labels for later filtering and aggregation.

opaqueunknown
competition_modeboolean

Set to true to enable competition restrictions for this scorecard.

Response

scorecard successfully created.

card_idstring required

Globally unique ID for the newly opened scorecard.

Changes

  • 25b583984ff7Revision changes
    • breaking

      the request property type changed from object to no type

    • info

      added the new optional request property