Skip to main content
GET
/
v1
/
entities
/
breakout
/
tags
List Breakout Entity Tags
curl --request GET \
  --url https://api.upriver.ai/v1/entities/breakout/tags \
  --header 'X-API-Key: <api-key>'
{
  "facets": [
    {
      "relation": "<string>",
      "tag": "<string>",
      "label": "<string>",
      "display_name": "<string>",
      "entity_count": 123
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
entity_type
string
required

Entity kind: 'player' or 'team'

​
relation
string
default:sport

Tag kind to list, e.g. 'sport', 'team', 'league', 'country'

​
vertical
string
default:sports

Vertical; only 'sports'

​
locale
string
default:en-US

Locale for display names, e.g. 'en-US' or 'en-GB'

Response

Successful Response

Available tags to filter the breakout entity list by.

​
facets
EntityFacet · object[]

Tags present among the currently-breaking entities, most common first