Get Breakout Entity

GET

entities

{entity_id}

breakout

Get Breakout Entity

curl --request GET \
  --url https://api.upriver.ai/v1/entities/{entity_id}/breakout \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.upriver.ai/v1/entities/{entity_id}/breakout', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.upriver.ai/v1/entities/{entity_id}/breakout",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.upriver.ai/v1/entities/{entity_id}/breakout"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.upriver.ai/v1/entities/{entity_id}/breakout")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "entity_id": "<string>",
  "name": "<string>",
  "entity_type": "<string>",
  "velocity": 123,
  "trend_direction": "<string>",
  "last_activity_at": "2023-11-07T05:31:56Z",
  "topics": [
    {
      "topic_id": "<string>",
      "name": "<string>",
      "citations": [
        {
          "source_category": "<string>",
          "source_url": "<string>",
          "title": "<string>",
          "display": ""
        }
      ],
      "source_summary": {},
      "citation_rate": [
        {
          "day": "<string>",
          "count": 123
        }
      ],
      "last_activity_at": "2023-11-07T05:31:56Z"
    }
  ],
  "timeline": [
    {
      "day": "<string>",
      "topic_count": 123
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Path Parameters

entity_id

string

required

Opaque entity identifier

Query Parameters

sort

string

default:recommended

Topic ordering, to match the list view: 'recommended' (default) orders an entity's topics by notability, 'newest' by recency. Pass the same sort you listed with so the expanded topics match the listed rows.

temporal_status

enum<string> | null

Restrict this entity's topics to those tied to an event of this timing relative to now: 'upcoming' (not yet started), 'ongoing' (in progress), or 'past'. Only topics tied to a scheduled event have a timing. Filter a topic by its request-time event temporal status.

Only topics linked to a scheduled event carry a temporal status, so filtering by any of these values implicitly restricts results to event-linked topics.

Available options:

upcoming,

ongoing,

past

Response

Successful Response

A single entity's current breaking topics and recent activity.

There is no ranking score here — that value is only meaningful in the ranked list context, not for a single-entity fetch.

entity_id

string

required

Opaque identifier for this entity

name

string

required

Entity display name

entity_type

string

required

Entity kind: 'player' or 'team'

velocity

number

required

Recent activity relative to the entity's own typical level

trend_direction

string

required

'rising', 'steady', or 'cooling'

last_activity_at

string<date-time> | null

When this entity most recently appeared in breaking coverage (ISO 8601, UTC)

topics

EntityTopicRef · object[]

The entity's current breaking topics

Show child attributes

timeline

EntityTimelineBucket · object[]

Recent daily activity for this entity

Show child attributes

List Breakout TopicsList breakout topics with optional filters. Returns topics ranked by the specified sort mode (recommended / rising / top / newest); see the sort_by parameter. Legacy relevance/importance still work.

⌘I

Get Breakout Entity

curl --request GET \
  --url https://api.upriver.ai/v1/entities/{entity_id}/breakout \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.upriver.ai/v1/entities/{entity_id}/breakout', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.upriver.ai/v1/entities/{entity_id}/breakout",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.upriver.ai/v1/entities/{entity_id}/breakout"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.upriver.ai/v1/entities/{entity_id}/breakout")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "entity_id": "<string>",
  "name": "<string>",
  "entity_type": "<string>",
  "velocity": 123,
  "trend_direction": "<string>",
  "last_activity_at": "2023-11-07T05:31:56Z",
  "topics": [
    {
      "topic_id": "<string>",
      "name": "<string>",
      "citations": [
        {
          "source_category": "<string>",
          "source_url": "<string>",
          "title": "<string>",
          "display": ""
        }
      ],
      "source_summary": {},
      "citation_rate": [
        {
          "day": "<string>",
          "count": 123
        }
      ],
      "last_activity_at": "2023-11-07T05:31:56Z"
    }
  ],
  "timeline": [
    {
      "day": "<string>",
      "topic_count": 123
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

API Reference

Guides

Agents + LLMs

Updates

Authorizations

Path Parameters

Query Parameters

Response