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

# Get Competitors

> The brand and its tracked rivals, ranked by Heralded Score over the period.

`with_page` adds the Competitors page; `with_menus` adds prompt filter menus.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/brands/{brand_id}/competitors
openapi: 3.1.0
info:
  description: >-
    Read-only access to one organization's brands, as the member who created the
    API key. Each key may make 120 requests a minute. Every error is an RFC 9457
    problem (`application/problem+json`) whose `code` names it.
  summary: Read your brands' AI visibility in Heralded.
  title: Heralded API
  version: '1'
servers:
  - url: https://api.heralded.ai
security: []
paths:
  /v1/brands/{brand_id}/competitors:
    get:
      tags:
        - v1
      summary: Get Competitors
      description: >-
        The brand and its tracked rivals, ranked by Heralded Score over the
        period.


        `with_page` adds the Competitors page; `with_menus` adds prompt filter
        menus.
      operationId: listCompetitors
      parameters:
        - in: path
          name: brand_id
          required: true
          schema:
            format: uuid
            title: Brand Id
            type: string
        - description: Include only scans up to this completed scan id.
          in: query
          name: as_of
          required: false
          schema:
            anyOf:
              - format: uuid
                type: string
              - type: 'null'
            description: Include only scans up to this completed scan id.
            title: As Of
        - in: query
          name: limit
          required: false
          schema:
            default: 20
            maximum: 100
            minimum: 1
            title: Limit
            type: integer
        - in: query
          name: offset
          required: false
          schema:
            default: 0
            minimum: 0
            title: Offset
            type: integer
        - in: query
          name: cursor
          required: false
          schema:
            anyOf:
              - maxLength: 4096
                type: string
              - type: 'null'
            title: Cursor
        - in: query
          name: engine
          required: false
          schema:
            anyOf:
              - enum:
                  - perplexity
                  - gemini
                  - openai
                  - google_aio
                  - ai_mode
                  - copilot
                  - claude
                type: string
              - type: 'null'
            title: Engine
        - in: query
          name: prompt
          required: false
          schema:
            anyOf:
              - format: uuid
                type: string
              - type: 'null'
            title: Prompt
        - in: query
          name: type
          required: false
          schema:
            anyOf:
              - enum:
                  - organic
                  - brand_specific
                  - competitor_comparison
                type: string
              - type: 'null'
            title: Type
        - in: query
          name: intent
          required: false
          schema:
            anyOf:
              - enum:
                  - educational
                  - problem
                  - comparison
                  - transactional
                type: string
              - type: 'null'
            title: Intent
        - in: query
          name: topic
          required: false
          schema:
            anyOf:
              - format: uuid
                type: string
              - type: 'null'
            title: Topic
        - in: query
          name: segment
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Segment
        - in: query
          name: period
          required: false
          schema:
            default: 1w
            enum:
              - 1w
              - 4w
              - 12w
              - all
            title: Period
            type: string
        - in: query
          name: with_page
          required: false
          schema:
            default: false
            title: With Page
            type: boolean
        - in: query
          name: with_menus
          required: false
          schema:
            default: false
            title: With Menus
            type: boolean
        - in: query
          name: sort
          required: false
          schema:
            default: score
            enum:
              - brand
              - score
              - trend
              - mentioned
              - recommended
            title: Sort
            type: string
        - in: query
          name: direction
          required: false
          schema:
            anyOf:
              - enum:
                  - asc
                  - desc
                type: string
              - type: 'null'
            title: Direction
        - in: query
          name: discovered_limit
          required: false
          schema:
            default: 10
            maximum: 100
            minimum: 1
            title: Discovered Limit
            type: integer
        - in: query
          name: discovered_offset
          required: false
          schema:
            default: 0
            minimum: 0
            title: Discovered Offset
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1Competitors'
          description: Successful Response
        '400':
          content:
            application/problem+json:
              example:
                code: invalid_cursor
                detail: The cursor is invalid or belongs to a different query.
                instance: example-request-id
                status: 400
                title: Bad Request
                type: about:blank
              schema:
                $ref: '#/components/schemas/Problem'
          description: The cursor is invalid or belongs to a different query.
        '401':
          content:
            application/problem+json:
              example:
                code: invalid_token
                detail: >-
                  The Authorization header carries no API key Heralded knows: it
                  is missing, mistyped, revoked or expired.
                instance: example-request-id
                status: 401
                title: Unauthorized
                type: about:blank
              schema:
                $ref: '#/components/schemas/Problem'
          description: No API key, or one that is unknown, revoked or expired.
          headers:
            WWW-Authenticate:
              schema:
                example: Bearer
                type: string
        '404':
          content:
            application/problem+json:
              example:
                code: not_found
                detail: Nothing here that this API key can read.
                instance: example-request-id
                status: 404
                title: Not Found
                type: about:blank
              schema:
                $ref: '#/components/schemas/Problem'
          description: No such brand or answer, or the key's owner cannot read it.
        '409':
          content:
            application/problem+json:
              example:
                code: workspace_archived
                detail: The API key's organization is archived.
                instance: example-request-id
                status: 409
                title: Conflict
                type: about:blank
              schema:
                $ref: '#/components/schemas/Problem'
          description: The API key's organization is archived.
        '422':
          content:
            application/problem+json:
              example:
                code: invalid_request
                detail: The request's parameters are invalid; `errors` names each one.
                errors:
                  - loc:
                      - query
                      - limit
                    msg: Input should be less than or equal to 100
                    type: less_than_equal
                instance: example-request-id
                status: 422
                title: Unprocessable Content
                type: about:blank
              schema:
                $ref: '#/components/schemas/ValidationProblem'
          description: A path or query parameter is invalid.
        '429':
          content:
            application/problem+json:
              example:
                code: rate_limited
                detail: >-
                  This caller is past its requests for the minute. Retry after
                  the seconds in Retry-After.
                instance: example-request-id
                rate_limit:
                  limit: 120
                  remaining: 0
                  reset: 60
                  window: 60
                status: 429
                title: Too Many Requests
                type: about:blank
              schema:
                $ref: '#/components/schemas/RateLimitProblem'
          description: The API key made more than 120 requests in the minute.
          headers:
            Retry-After:
              description: Seconds until the key may call again.
              schema:
                example: 60
                type: integer
      security:
        - apiKey: []
components:
  schemas:
    V1Competitors:
      properties:
        channels:
          items:
            $ref: '#/components/schemas/V1Channel'
          title: Channels
          type: array
        competitors:
          items:
            $ref: '#/components/schemas/V1Competitor'
          title: Competitors
          type: array
        discovered:
          items:
            $ref: '#/components/schemas/V1DiscoveredCompetitor'
          title: Discovered
          type: array
        menus:
          anyOf:
            - $ref: '#/components/schemas/PromptFilters'
            - type: 'null'
        meta:
          $ref: '#/components/schemas/Meta'
          description: Normalized query and newest included scan.
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Pass as cursor with the same query to read the next page; null at
            the end.
          title: Next Cursor
        page:
          anyOf:
            - $ref: '#/components/schemas/CompetitorsPage'
            - type: 'null'
        period:
          $ref: '#/components/schemas/V1Period'
        share_of_voice:
          $ref: '#/components/schemas/V1ShareOfVoice'
      required:
        - meta
        - next_cursor
        - period
        - competitors
        - discovered
        - channels
        - share_of_voice
        - page
        - menus
      title: V1Competitors
      type: object
    Problem:
      description: |-
        An RFC 9457 problem. `type` is always `about:blank`, so `title` is the
        status's name, and `code` is what a client branches on.
      properties:
        code:
          title: Code
          type: string
        detail:
          title: Detail
          type: string
        instance:
          default: ''
          title: Instance
          type: string
        status:
          title: Status
          type: integer
        title:
          title: Title
          type: string
        type:
          const: about:blank
          default: about:blank
          title: Type
          type: string
      required:
        - type
        - title
        - status
        - detail
        - code
        - instance
      title: Problem
      type: object
    ValidationProblem:
      properties:
        code:
          title: Code
          type: string
        detail:
          title: Detail
          type: string
        errors:
          items:
            $ref: '#/components/schemas/ValidationIssue'
          title: Errors
          type: array
        instance:
          default: ''
          title: Instance
          type: string
        status:
          title: Status
          type: integer
        title:
          title: Title
          type: string
        type:
          const: about:blank
          default: about:blank
          title: Type
          type: string
      required:
        - type
        - title
        - status
        - detail
        - code
        - instance
        - errors
      title: ValidationProblem
      type: object
    RateLimitProblem:
      properties:
        code:
          title: Code
          type: string
        detail:
          title: Detail
          type: string
        instance:
          default: ''
          title: Instance
          type: string
        rate_limit:
          $ref: '#/components/schemas/RateLimitValues'
        status:
          title: Status
          type: integer
        title:
          title: Title
          type: string
        type:
          const: about:blank
          default: about:blank
          title: Type
          type: string
      required:
        - type
        - title
        - status
        - detail
        - code
        - instance
        - rate_limit
      title: RateLimitProblem
      type: object
    V1Channel:
      properties:
        answers:
          title: Answers
          type: integer
        domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Domain
        mentioned:
          anyOf:
            - type: integer
            - type: 'null'
          title: Mentioned
        name:
          title: Name
          type: string
        prompts:
          title: Prompts
          type: integer
      required:
        - name
        - domain
        - mentioned
        - answers
        - prompts
      title: V1Channel
      type: object
    V1Competitor:
      properties:
        domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Domain
        heralded_score:
          $ref: '#/components/schemas/V1Figure'
        is_you:
          title: Is You
          type: boolean
        mentioned:
          $ref: '#/components/schemas/V1Figure'
        name:
          title: Name
          type: string
        rank:
          title: Rank
          type: integer
        recommended:
          $ref: '#/components/schemas/V1Figure'
        share_of_voice_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Share Of Voice Pct
      required:
        - name
        - domain
        - is_you
        - rank
        - heralded_score
        - mentioned
        - recommended
        - share_of_voice_pct
      title: V1Competitor
      type: object
    V1DiscoveredCompetitor:
      properties:
        answers:
          title: Answers
          type: integer
        domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Domain
        high:
          anyOf:
            - type: integer
            - type: 'null'
          title: High
        low:
          anyOf:
            - type: integer
            - type: 'null'
          title: Low
        name:
          title: Name
          type: string
        state:
          enum:
            - measured
            - too_few_answers
            - calibrating
            - first_report
            - not_comparable
            - not_measured
          title: State
          type: string
        value:
          anyOf:
            - type: integer
            - type: 'null'
          title: Value
      required:
        - name
        - domain
        - value
        - low
        - high
        - answers
        - state
      title: V1DiscoveredCompetitor
      type: object
    PromptFilters:
      description: >-
        What the toolbar's four menus offer, counted over every tracked prompt

        rather than over the page (PR-4). A menu built from one page of ten
        would

        hide the segment the eleventh row is in.
      properties:
        intents:
          items:
            $ref: '#/components/schemas/PromptFilterOption'
          title: Intents
          type: array
        segments:
          items:
            $ref: '#/components/schemas/PromptFilterOption'
          title: Segments
          type: array
        topics:
          items:
            $ref: '#/components/schemas/PromptFilterOption'
          title: Topics
          type: array
        types:
          items:
            $ref: '#/components/schemas/PromptFilterOption'
          title: Types
          type: array
      required:
        - segments
        - types
        - intents
        - topics
      title: PromptFilters
      type: object
    Meta:
      properties:
        data_as_of:
          anyOf:
            - $ref: '#/components/schemas/DataAsOf'
            - type: 'null'
        query:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          title: Query
          type: object
      required:
        - query
        - data_as_of
      title: Meta
      type: object
    CompetitorsPage:
      properties:
        can_track:
          title: Can Track
          type: boolean
        capacity:
          $ref: '#/components/schemas/RosterPool'
        channels:
          $ref: '#/components/schemas/DiscoveredPage'
        discovered:
          $ref: '#/components/schemas/DiscoveredPage'
        leaderboard:
          $ref: '#/components/schemas/CompetitorBoard'
        period:
          $ref: '#/components/schemas/PeriodDescriptor'
        sentence:
          anyOf:
            - type: string
            - type: 'null'
          title: Sentence
        share_of_voice:
          $ref: '#/components/schemas/VoiceBox'
      required:
        - period
        - sentence
        - share_of_voice
        - leaderboard
        - capacity
        - can_track
        - discovered
        - channels
      title: CompetitorsPage
      type: object
    V1Period:
      properties:
        excluded_reports:
          title: Excluded Reports
          type: integer
        first_answer_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: First Answer At
        last_answer_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Last Answer At
        preset:
          enum:
            - 1w
            - 4w
            - 12w
            - all
          title: Preset
          type: string
        reports:
          title: Reports
          type: integer
      required:
        - preset
        - reports
        - first_answer_at
        - last_answer_at
        - excluded_reports
      title: V1Period
      type: object
    V1ShareOfVoice:
      properties:
        answers:
          title: Answers
          type: integer
        excluded_answers:
          title: Excluded Answers
          type: integer
        population:
          enum:
            - all_answers
            - weekly_answers
          title: Population
          type: string
        rows:
          items:
            $ref: '#/components/schemas/V1VoiceShare'
          title: Rows
          type: array
        state:
          enum:
            - measured
            - not_measured
            - not_comparable
          title: State
          type: string
      required:
        - population
        - answers
        - excluded_answers
        - state
        - rows
      title: V1ShareOfVoice
      type: object
    ValidationIssue:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Loc
          type: array
        msg:
          title: Msg
          type: string
        type:
          title: Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationIssue
      type: object
    RateLimitValues:
      properties:
        limit:
          title: Limit
          type: integer
        remaining:
          title: Remaining
          type: integer
        reset:
          title: Reset
          type: integer
        window:
          title: Window
          type: integer
      required:
        - limit
        - window
        - remaining
        - reset
      title: RateLimitValues
      type: object
    V1Figure:
      properties:
        answers:
          title: Answers
          type: integer
        change:
          anyOf:
            - $ref: '#/components/schemas/V1Change'
            - type: 'null'
        denominator:
          anyOf:
            - type: integer
            - type: 'null'
          title: Denominator
        high:
          anyOf:
            - type: integer
            - type: 'null'
          title: High
        low:
          anyOf:
            - type: integer
            - type: 'null'
          title: Low
        numerator:
          anyOf:
            - type: number
            - type: 'null'
          title: Numerator
        state:
          enum:
            - measured
            - too_few_answers
            - calibrating
            - first_report
            - not_comparable
            - not_measured
          title: State
          type: string
        trend:
          items:
            $ref: '#/components/schemas/V1TrendPoint'
          title: Trend
          type: array
        value:
          anyOf:
            - type: integer
            - type: 'null'
          title: Value
      required:
        - value
        - low
        - high
        - numerator
        - denominator
        - answers
        - state
        - change
        - trend
      title: V1Figure
      type: object
    PromptFilterOption:
      properties:
        count:
          title: Count
          type: integer
        label:
          title: Label
          type: string
        value:
          title: Value
          type: string
      required:
        - value
        - label
        - count
      title: PromptFilterOption
      type: object
    DataAsOf:
      properties:
        completed_at:
          format: date-time
          title: Completed At
          type: string
        id:
          format: uuid
          title: Id
          type: string
      required:
        - id
        - completed_at
      title: DataAsOf
      type: object
    JsonValue: {}
    RosterPool:
      description: |-
        Roster size as a pool (MK-4). `cap` is `None` on a workspace with no
        active subscription to read one off.
      properties:
        cap:
          anyOf:
            - type: integer
            - type: 'null'
          title: Cap
        used:
          title: Used
          type: integer
      required:
        - used
        - cap
      title: RosterPool
      type: object
    DiscoveredPage:
      description: One page of Discovered or of Channels, and how many there are.
      properties:
        cells:
          items:
            $ref: '#/components/schemas/DiscoveredBrand'
          title: Cells
          type: array
        limit:
          title: Limit
          type: integer
        offset:
          title: Offset
          type: integer
        total:
          title: Total
          type: integer
      required:
        - cells
        - total
        - offset
        - limit
      title: DiscoveredPage
      type: object
    CompetitorBoard:
      description: One page of the leaderboard, sorted as asked. `total` is every row.
      properties:
        direction:
          enum:
            - asc
            - desc
          title: Direction
          type: string
        limit:
          title: Limit
          type: integer
        offset:
          title: Offset
          type: integer
        rows:
          items:
            $ref: '#/components/schemas/CompetitorRow'
          title: Rows
          type: array
        sort:
          enum:
            - brand
            - score
            - trend
            - mentioned
            - recommended
          title: Sort
          type: string
        total:
          title: Total
          type: integer
      required:
        - rows
        - total
        - offset
        - limit
        - sort
        - direction
      title: CompetitorBoard
      type: object
    PeriodDescriptor:
      properties:
        excluded_reports:
          title: Excluded Reports
          type: integer
        first_answer_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: First Answer At
        last_answer_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Last Answer At
        preset:
          enum:
            - 1w
            - 4w
            - 12w
            - all
          title: Preset
          type: string
        reports:
          title: Reports
          type: integer
      required:
        - preset
        - reports
        - first_answer_at
        - last_answer_at
        - excluded_reports
      title: PeriodDescriptor
      type: object
    VoiceBox:
      properties:
        denominator:
          title: Denominator
          type: integer
        info:
          title: Info
          type: string
        population:
          enum:
            - all_answers
            - weekly_answers
          title: Population
          type: string
        segments:
          items:
            $ref: '#/components/schemas/VoiceSegment'
          title: Segments
          type: array
        state:
          enum:
            - measured
            - not_measured
            - not_comparable
          title: State
          type: string
      required:
        - state
        - population
        - info
        - denominator
        - segments
      title: VoiceBox
      type: object
    V1VoiceShare:
      properties:
        denominator:
          title: Denominator
          type: integer
        is_you:
          title: Is You
          type: boolean
        name:
          title: Name
          type: string
        numerator:
          title: Numerator
          type: integer
        pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Pct
      required:
        - name
        - is_you
        - numerator
        - denominator
        - pct
      title: V1VoiceShare
      type: object
    V1Change:
      properties:
        baseline:
          $ref: '#/components/schemas/V1Baseline'
        cells_unpaired:
          title: Cells Unpaired
          type: integer
        delta:
          anyOf:
            - type: number
            - type: 'null'
          title: Delta
        direction:
          enum:
            - up
            - down
            - steady
          title: Direction
          type: string
        high:
          anyOf:
            - type: number
            - type: 'null'
          title: High
        low:
          anyOf:
            - type: number
            - type: 'null'
          title: Low
        real:
          title: Real
          type: boolean
      required:
        - delta
        - low
        - high
        - real
        - direction
        - baseline
        - cells_unpaired
      title: V1Change
      type: object
    V1TrendPoint:
      properties:
        answers:
          title: Answers
          type: integer
        at:
          format: date-time
          title: At
          type: string
        break_label:
          anyOf:
            - type: string
            - type: 'null'
          title: Break Label
        high:
          anyOf:
            - type: integer
            - type: 'null'
          title: High
        low:
          anyOf:
            - type: integer
            - type: 'null'
          title: Low
        state:
          enum:
            - measured
            - too_few_answers
            - calibrating
            - first_report
            - not_comparable
            - not_measured
          title: State
          type: string
        value:
          anyOf:
            - type: integer
            - type: 'null'
          title: Value
      required:
        - at
        - value
        - low
        - high
        - answers
        - state
        - break_label
      title: V1TrendPoint
      type: object
    DiscoveredBrand:
      description: |-
        A brand the answers name that the brand does not track. A channel's
        `score` is null: it is never scored as a competitor.
      properties:
        answers:
          title: Answers
          type: integer
        brand_key:
          title: Brand Key
          type: string
        brand_name:
          title: Brand Name
          type: string
        domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Domain
        is_new:
          title: Is New
          type: boolean
        line:
          title: Line
          type: string
        mentioned:
          anyOf:
            - type: integer
            - type: 'null'
          title: Mentioned
        prompts:
          title: Prompts
          type: integer
        score:
          anyOf:
            - $ref: '#/components/schemas/ScoreMark'
            - type: 'null'
      required:
        - brand_key
        - brand_name
        - domain
        - is_new
        - line
        - score
        - mentioned
        - answers
        - prompts
      title: DiscoveredBrand
      type: object
    CompetitorRow:
      description: |-
        The brand or one competitor it tracks, on the leaderboard. `rank`
        places the brands with a score, ties sharing a place.
      properties:
        brand_key:
          title: Brand Key
          type: string
        brand_name:
          title: Brand Name
          type: string
        domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Domain
        is_you:
          title: Is You
          type: boolean
        mentioned:
          anyOf:
            - type: integer
            - type: 'null'
          title: Mentioned
        rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Rank
        recommended:
          anyOf:
            - type: integer
            - type: 'null'
          title: Recommended
        score:
          $ref: '#/components/schemas/ScoreMark'
        trend:
          $ref: '#/components/schemas/PromptTrend'
      required:
        - rank
        - brand_key
        - brand_name
        - domain
        - is_you
        - score
        - trend
        - mentioned
        - recommended
      title: CompetitorRow
      type: object
    VoiceSegment:
      description: |-
        One part of the share-of-voice bar. `pct` is a whole percent, and the
        segments add up to 100; null where the read measured no share.
      properties:
        brand_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Brand Key
        count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Count
        kind:
          enum:
            - you
            - competitor
            - rest
            - else
          title: Kind
          type: string
        label:
          title: Label
          type: string
        numerator:
          title: Numerator
          type: integer
        pct:
          anyOf:
            - type: integer
            - type: 'null'
          title: Pct
      required:
        - kind
        - brand_key
        - label
        - pct
        - numerator
        - count
      title: VoiceSegment
      type: object
    V1Baseline:
      properties:
        first_answer_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: First Answer At
        last_answer_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Last Answer At
        reports:
          title: Reports
          type: integer
      required:
        - reports
        - first_answer_at
        - last_answer_at
      title: V1Baseline
      type: object
    ScoreMark:
      description: >-
        A score or figure from the figures read, with the band it is coloured

        by (#4259).


        `key` is the engine or the figure measured. `band` is the Heralded
        Score's

        band for the value, so a mark and a score read on one scale, and

        "Not measured" where no value is served, which includes a group under
        the

        minimum of answers. On a score, `answers` counts every answer the period

        read under the filters, including those a figure's own denominator
        leaves

        out.
      properties:
        answer_read_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Answer Read Id
        answers:
          title: Answers
          type: integer
        band:
          title: Band
          type: string
        key:
          title: Key
          type: string
        label:
          title: Label
          type: string
        state:
          enum:
            - measured
            - too_few_answers
            - calibrating
            - first_report
            - not_comparable
            - not_measured
          title: State
          type: string
        tooltip:
          anyOf:
            - type: string
            - type: 'null'
          title: Tooltip
        value:
          anyOf:
            - type: integer
            - type: 'null'
          title: Value
      required:
        - key
        - label
        - value
        - state
        - band
        - answers
        - tooltip
        - answer_read_id
      title: ScoreMark
      type: object
    PromptTrend:
      description: A score's change, as the Trend column and the pane state it.
      properties:
        delta:
          anyOf:
            - type: integer
            - type: 'null'
          title: Delta
        label:
          anyOf:
            - type: string
            - type: 'null'
          title: Label
        state:
          enum:
            - up
            - down
            - steady
            - not_comparable
            - calibrating
            - new
            - none
          title: State
          type: string
      required:
        - state
        - delta
        - label
      title: PromptTrend
      type: object
  securitySchemes:
    apiKey:
      description: 'An API key, sent as `Authorization: Bearer hrld_...`.'
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.