Get league featured match

GET/v2/leagues/{league_id}/featured-match

Return the single episode one featured-match lens lands on right now, or null when the lens has no match in the league's recent competition rounds. The default lens tries 1st-vs-2nd, then the given player's latest game, then the showcase heuristic.

Authorization

BearerAuth

AuthorizationBearer <token>

Bearer token issued by Softmax

In: header

Path Parameters

league_id*League Id

League associated with the requested resource.

Match^league_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Query Parameters

mode?Mode

Featured-match lens to evaluate.

Default"default"

Value in

"default"
"showcase"
"closest"
"top-two"
"title"
"upset"
"blowout"
"mine"
"player"
"latest"
"live"
"random"
"step"

division_id?|

Division whose standings scope the rank lenses (1st vs 2nd, Title match, Upset).

player_id?|

Player featured by the 'mine' and 'player' lenses and the default chain.

seed?Seed

Seed for the random lens.

Range0 <= value <= 2147483647

Default0

from_episode?|

Episode the step lens starts from (a round episode entry ID).

step?|

Step direction for the step lens.

bash

curl -X GET "https://example.com/v2/leagues/string/featured-match"

json

{
  "mode": "default",
  "kind": "live",
  "round": {
    "id": "string",
    "round_number": 0,
    "commissioner_key": "string",
    "execution_backend": "dispatch",
    "round_config": {},
    "round_display": {},
    "status": "pending",
    "scheduled_by": "ladder",
    "error": "string",
    "skip_kind": "budget_refused",
    "started_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z",
    "division": {
      "id": "string",
      "name": "string",
      "level": 0,
      "type": "string",
      "description": "string",
      "hidden": true,
      "archived_at": "2019-08-24T14:15:22Z",
      "round_schedule": {},
      "notes": "string",
      "league": {
        "name": "string",
        "short_name": "string",
        "description": "string",
        "commissioner_key": "string",
        "commissioner_config": {},
        "commissioner_migration_version": "string",
        "rounds_paused_at": "2019-08-24T14:15:22Z",
        "submissions_locked_at": "2019-08-24T14:15:22Z",
        "settings": {},
        "filler_policy_version_ids": [
          "19818f13-26cb-4fdd-9b0c-2e0096e5f70d"
        ],
        "seed_policy_version_ids": [
          "9b626be7-cdd2-4e22-8014-dab46ae046a1"
        ],
        "seed_policy_number": 0,
        "rules": {},
        "public": false,
        "hidden": false,
        "is_game_of_week": false,
        "disabled_at": "2019-08-24T14:15:22Z",
        "notes": "string",
        "id": "string",
        "game": {
          "name": "string",
          "coworld_name": "string",
          "description": "string",
          "owner_user_id": "string",
          "notes": "string",
          "id": "string",
          "default_league_id": "string",
          "coworld_id": "string",
          "canonical_coworld_id": "string",
          "coworld_tags": [
            "string"
          ],
          "created_at": "2019-08-24T14:15:22Z"
        },
        "mod": {
          "name": "string",
          "description": "string",
          "owner_user_id": "string",
          "notes": "string",
          "id": "string",
          "game": {
            "name": "string",
            "coworld_name": "string",
            "description": "string",
            "owner_user_id": "string",
            "notes": "string",
            "id": "string",
            "default_league_id": "string",
            "coworld_id": "string",
            "canonical_coworld_id": "string",
            "coworld_tags": [
              "string"
            ],
            "created_at": "2019-08-24T14:15:22Z"
          },
          "created_at": "2019-08-24T14:15:22Z"
        },
        "created_at": "2019-08-24T14:15:22Z",
        "participation_url": "string",
        "forum_markdown_url": "string",
        "wiki_markdown_url": "string",
        "logs_reporter_id": "string",
        "handicaps": {
          "property1": 0,
          "property2": 0
        },
        "handicap_dynamic": {
          "max_handicap": 0.5,
          "curve": 1,
          "min_entrants": 3,
          "dominance_ratio_for_max": 3,
          "winrate_for_max": 0.85
        }
      },
      "created_at": "2019-08-24T14:15:22Z",
      "commissioner_description": {
        "round_schedule": "string",
        "next_round": "string",
        "round_structure": "string",
        "leaderboard_rules": "string",
        "scoring_mechanics": "string",
        "changelog": [
          {
            "date": "string",
            "title": "string",
            "detail": "string",
            "category": "string"
          }
        ]
      }
    },
    "created_at": "2019-08-24T14:15:22Z"
  },
  "episode": {
    "id": "string",
    "inspect_url": "string",
    "episode_id": "a7b62598-1927-4181-99d5-5d746c0bbcfe",
    "coworld_id": "string",
    "coworld_name": "string",
    "coworld_version": "string",
    "variant_name": "string",
    "job_index": 0,
    "status": "pending",
    "policy_version_ids": [
      "de6640ed-6e83-4f61-9613-b56ec10dde91"
    ],
    "participants": [
      {
        "position": 0,
        "kind": "policy",
        "policy_version_id": "7cd41427-f4be-4006-ab17-5ead7f8f8446",
        "policy_id": "ee9b03e0-6495-427a-85a5-34444d24ae04",
        "policy_name": "string",
        "version": 0,
        "player_id": "string",
        "player_name": "string",
        "is_filler": false,
        "is_seed": false
      }
    ],
    "replay_url": "string",
    "live_url": "string",
    "error_type": "string",
    "error": "string",
    "failed_policy_index": 0,
    "failed_agent_index": 0,
    "scores": [
      {
        "policy_version_id": "7cd41427-f4be-4006-ab17-5ead7f8f8446",
        "score": 0
      }
    ],
    "participant_scores": [
      {
        "position": 0,
        "score": 0
      }
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "dispatched_at": "2019-08-24T14:15:22Z",
    "running_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z"
  },
  "episode_number": 0,
  "replay_position": 0,
  "replay_total": 0,
  "has_newer_replay": true,
  "has_older_replay": true,
  "reason": {
    "peak_score": 0,
    "scored": true,
    "margin": 0,
    "first_player_name": "string",
    "second_player_name": "string",
    "leader_name": "string",
    "winner_rank": 0,
    "beaten_rank": 0,
    "field_size": 0,
    "replay_count": 0
  }
}