EndpointsExperience Requests

List counterfactual evaluations

GET/v2/counterfactual-evals

Returns the counterfactual evaluations visible to the caller, newest first.

Authorization

BearerAuth
AuthorizationBearer <token>

Bearer token issued by Softmax

In: header

Query Parameters

candidate_policy_version_id?|

Return evaluations for this candidate policy version.

league_id?|

Return evaluations configured by this league.

player_id?|

Return evaluations whose candidate belongs to this player.

player_name?|

Return evaluations whose candidate player name contains this text.

mine?Mine

Return only evaluations created by the caller.

Defaultfalse
limit?Limit

Maximum evaluations returned.

Range1 <= value <= 200
Default50
cursor?|

Opaque cursor returned by the previous page.

curl -X GET "https://softmax.com/api/observatory/v2/counterfactual-evals"
{  "entries": [    {      "id": "string",      "candidate_policy_version_id": "b63b910e-ed55-43c0-be2c-6fd9d66eb022",      "baseline_policy_version_id": "353a49c0-b329-40ab-bec7-26c418899e74",      "candidate_policy_label": "string",      "baseline_policy_label": "string",      "candidate_player_name": "string",      "candidate_owner_name": "string",      "baseline_player_name": "string",      "baseline_owner_name": "string",      "league_id": "string",      "league_name": "string",      "source": "tournament",      "n_requested": 0,      "n_paired": 0,      "status": "pending",      "skip_reason": "string",      "error": "string",      "verdict": "progression",      "net_score": 0,      "wins": 0,      "losses": 0,      "neutrals": 0,      "mean_score_delta": 0,      "experience_request_id": "256083de-09b1-42d4-acb9-be39dd53448f",      "submission_id": "945dfedc-ad7f-4af7-b20c-06082ffa3cb3",      "league_policy_membership_id": "93c17082-599d-4779-9bb4-07972e51d754",      "idempotency_key": "string",      "created_by_user_id": "string",      "started_at": "2019-08-24T14:15:22Z",      "completed_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "pairs": [        {          "job_index": 0,          "baseline_episode_request_id": "string",          "candidate_episode_request_id": "string",          "candidate_episode_id": "442ebfae-0775-4701-b3ea-a6e05152d140",          "seed": 0,          "probe_slot": 0,          "opponent_policy_version_ids": [            "string"          ],          "coworld_id": "string",          "variant_id": "string",          "baseline_score": 0,          "candidate_score": 0,          "score_delta": 0,          "outcome": 0        }      ]    }  ],  "next_cursor": "string"}