THthebluealliance
insight

GET /insights/{year}/{category}

Changed on

Gets a list of InsightV2 objects for the given year filtered by category. Use year=0 for all-time insights. Returns only global (non-district-scoped) insights. Valid categories: leaderboard, streak, timeseries, game_stats, clubs.

Request

  • Base URL
    https://www.thebluealliance.com/api/v3
  • Auth
    API key in header X-TBA-Auth-Key

Path parameters

yearinteger required

Competition Year (or Season). Must be 4 digits.

category'leaderboard' | 'streak' | 'timeseries' | 'game_stats' | 'clubs' required

InsightV2 category. One of: leaderboard, streak, timeseries, game_stats, clubs.

Headers

If-None-Matchstring

Value of the ETag header in the most recently cached response by the client.

Response

Successful response

Changes

  • def03c22de3aRevision changes
    • breaking

      added to the response property oneOf list for the response status

    • warning

      added the new clubs enum value to the ///////// response property for the response status

    • warning

      added the new clubs enum value to the ///////// response property for the response status

    • warning

      added the new clubs enum value to the ///////// response property for the response status

    • warning

      added the new clubs enum value to the ///////// response property for the response status

    • warning

      added the new date enum value to the ////////// response property for the response status

    • info

      added the new enum value clubs to the path request parameter category

    • info

      added clubs discriminator mapping keys to the response property for the response status

  • da85cc0194d1Revision changes
    • breaking

      added to the response property oneOf list for the response status

    • warning

      added the new game_stats enum value to the ///////// response property for the response status

    • warning

      added the new game_stats enum value to the ///////// response property for the response status

    • warning

      added the new game_stats enum value to the ///////// response property for the response status

    • info

      added the new enum value game_stats to the path request parameter category

    • info

      added game_stats discriminator mapping keys to the response property for the response status