> ## Documentation Index
> Fetch the complete documentation index at: https://docs.upriver.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Breakout Entity

> Get one entity's current breaking topics and a coarse timeline.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/entities/{entity_id}/breakout
openapi: 3.1.0
info:
  title: Upriver API
  description: >-
    A social insights API for ad generation platforms. It provides structured
    signals, like psychographics, behavioral insights, trends, and audience
    language, to help AI models generate relevant, higher-converting ads.
  version: 1.0.0
servers:
  - url: https://api.upriver.ai
    description: Production API server
security: []
tags:
  - name: Brands
  - name: Products
  - name: Creators
  - name: Audience
  - name: Sponsorships
  - name: Trends
  - name: Breakout Topics
  - name: Taxonomy
paths:
  /v1/entities/{entity_id}/breakout:
    get:
      tags:
        - Breakout Topics
      summary: Get Breakout Entity
      description: Get one entity's current breaking topics and a coarse timeline.
      operationId: get_breakout_entity
      parameters:
        - name: entity_id
          in: path
          required: true
          schema:
            type: string
            description: Opaque entity identifier
            title: Entity Id
          description: Opaque entity identifier
        - name: sort
          in: query
          required: false
          schema:
            type: string
            description: >-
              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.
            default: recommended
            title: Sort
          description: >-
            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.
        - name: temporal_status
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/TemporalStatusFilter'
              - type: 'null'
            description: >-
              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.
            title: Temporal Status
          description: >-
            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.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityBreakoutDetailResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    TemporalStatusFilter:
      type: string
      enum:
        - upcoming
        - ongoing
        - past
      title: TemporalStatusFilter
      description: >-
        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.
    EntityBreakoutDetailResponse:
      properties:
        entity_id:
          type: string
          title: Entity Id
          description: Opaque identifier for this entity
        name:
          type: string
          title: Name
          description: Entity display name
        entity_type:
          type: string
          title: Entity Type
          description: 'Entity kind: ''player'' or ''team'''
        velocity:
          type: number
          title: Velocity
          description: Recent activity relative to the entity's own typical level
        trend_direction:
          type: string
          title: Trend Direction
          description: '''rising'', ''steady'', or ''cooling'''
        last_activity_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Activity At
          description: >-
            When this entity most recently appeared in breaking coverage (ISO
            8601, UTC)
        topics:
          items:
            $ref: '#/components/schemas/EntityTopicRef'
          type: array
          title: Topics
          description: The entity's current breaking topics
        timeline:
          items:
            $ref: '#/components/schemas/EntityTimelineBucket'
          type: array
          title: Timeline
          description: Recent daily activity for this entity
      type: object
      required:
        - entity_id
        - name
        - entity_type
        - velocity
        - trend_direction
      title: EntityBreakoutDetailResponse
      description: >-
        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.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    EntityTopicRef:
      properties:
        topic_id:
          type: string
          title: Topic Id
          description: Topic identifier; reuse with the breakout topic endpoints
        name:
          type: string
          title: Name
          description: Topic name
        citations:
          items:
            $ref: '#/components/schemas/EntityTopicCitation'
          type: array
          title: Citations
          description: A few supporting sources for this topic
        source_summary:
          additionalProperties:
            type: integer
          type: object
          title: Source Summary
          description: 'Supporting-source count by category: {news: 5, reddit: 12, web: 3}'
        citation_rate:
          items:
            $ref: '#/components/schemas/CitationRateBucket'
          type: array
          title: Citation Rate
          description: Daily supporting-source counts for this topic, oldest first
        last_activity_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Activity At
          description: >-
            When this topic most recently appeared in breaking coverage (ISO
            8601, UTC)
      type: object
      required:
        - topic_id
        - name
      title: EntityTopicRef
      description: A topic the entity is currently breaking in.
    EntityTimelineBucket:
      properties:
        day:
          type: string
          title: Day
          description: Date in YYYY-MM-DD format
        topic_count:
          type: integer
          title: Topic Count
          description: Number of the entity's topics active that day
      type: object
      required:
        - day
        - topic_count
      title: EntityTimelineBucket
      description: One day's activity count for an entity.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    EntityTopicCitation:
      properties:
        source_category:
          type: string
          title: Source Category
          description: 'Source category: news, web, reddit, tiktok, trends'
        source_url:
          type: string
          title: Source Url
          description: URL of the source
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
          description: Headline of the source, when it has one (null for posts)
        display:
          type: string
          title: Display
          description: >-
            Display-ready label for the source — its headline, or the post text
            when the source has no headline. Prefer this over title.
          default: ''
      type: object
      required:
        - source_category
        - source_url
      title: EntityTopicCitation
      description: >-
        A supporting source for a topic — the lean entity-card citation shape.


        Inherits the shared citation fields (source_category, source_url, title,

        display) and intentionally adds nothing else; the entity cards only
        render a

        compact source link, not the full citation detail.
    CitationRateBucket:
      properties:
        day:
          type: string
          title: Day
          description: Date in YYYY-MM-DD format
        count:
          type: integer
          title: Count
          description: Number of citations published that day
      type: object
      required:
        - day
        - count
      title: CitationRateBucket
      description: A single day's citation count for charting.
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````