> ## 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 Prompt

> One prompt's period score and trend, latest answers, competitors and top sources.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/brands/{brand_id}/prompts/{prompt_uid}
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}/prompts/{prompt_uid}:
    get:
      tags:
        - v1
      summary: Get Prompt
      description: >-
        One prompt's period score and trend, latest answers, competitors and top
        sources.
      operationId: getPrompt
      parameters:
        - in: path
          name: brand_id
          required: true
          schema:
            format: uuid
            title: Brand Id
            type: string
        - in: path
          name: prompt_uid
          required: true
          schema:
            format: uuid
            title: Prompt Uid
            type: string
        - 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
        - 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: period
          required: false
          schema:
            default: 1w
            enum:
              - 1w
              - 4w
              - 12w
              - all
            title: Period
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1PromptDetail'
          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:
    V1PromptDetail:
      properties:
        actions:
          items:
            $ref: '#/components/schemas/V1PromptAction'
          title: Actions
          type: array
        answers:
          default: 0
          title: Answers
          type: integer
        answers_link:
          anyOf:
            - $ref: '#/components/schemas/AnswersLink'
            - type: 'null'
        competitors:
          items:
            $ref: '#/components/schemas/V1PromptCompetitor'
          title: Competitors
          type: array
        engine_cards:
          items:
            $ref: '#/components/schemas/PromptEngineCard'
          title: Engine Cards
          type: array
        engine_note:
          anyOf:
            - type: string
            - type: 'null'
          title: Engine Note
        engine_vocabulary:
          items:
            $ref: '#/components/schemas/EngineVocabulary'
          title: Engine Vocabulary
          type: array
        engines:
          items:
            $ref: '#/components/schemas/V1PromptLatestEngine'
          title: Engines
          type: array
        id:
          format: uuid
          title: Id
          type: string
        intent:
          anyOf:
            - type: string
            - type: 'null'
          title: Intent
        intent_source:
          default: heralded
          enum:
            - member
            - heralded
          title: Intent Source
          type: string
        measurement:
          anyOf:
            - $ref: '#/components/schemas/KeywordMeasurement'
            - type: 'null'
        meta:
          $ref: '#/components/schemas/Meta'
          description: Normalized query and newest included scan.
        period:
          $ref: '#/components/schemas/V1Period'
        prompt_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Prompt Type
        prompt_type_source:
          default: heralded
          enum:
            - member
            - heralded
          title: Prompt Type Source
          type: string
        retention_days:
          anyOf:
            - type: integer
            - type: 'null'
          title: Retention Days
        score:
          $ref: '#/components/schemas/V1Figure'
        search_volume:
          anyOf:
            - type: integer
            - type: 'null'
          title: Search Volume
        segment:
          title: Segment
          type: string
        segment_detail:
          anyOf:
            - $ref: '#/components/schemas/PromptSegment'
            - type: 'null'
        sentence:
          anyOf:
            - type: string
            - type: 'null'
          title: Sentence
        sources:
          items:
            $ref: '#/components/schemas/V1PromptSource'
          title: Sources
          type: array
        status:
          enum:
            - active
            - paused
            - archived
          title: Status
          type: string
        status_since:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Status Since
        tail_note:
          anyOf:
            - type: string
            - type: 'null'
          title: Tail Note
        text:
          title: Text
          type: string
        third_report_due_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Third Report Due At
        tiles:
          items:
            $ref: '#/components/schemas/PromptTile'
          title: Tiles
          type: array
        topic:
          anyOf:
            - type: string
            - type: 'null'
          title: Topic
        topic_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Topic Id
        tracked_since:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Tracked Since
      required:
        - meta
        - measurement
        - id
        - text
        - status
        - status_since
        - tracked_since
        - topic
        - intent
        - segment
        - period
        - score
        - engines
        - competitors
        - sources
        - prompt_type
        - prompt_type_source
        - intent_source
        - topic_id
        - segment_detail
        - search_volume
        - engine_vocabulary
        - sentence
        - tiles
        - answers
        - engine_cards
        - engine_note
        - third_report_due_at
        - retention_days
        - tail_note
        - actions
        - answers_link
      title: V1PromptDetail
      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
    V1PromptAction:
      properties:
        completed_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Completed At
        created_at:
          format: date-time
          title: Created At
          type: string
        credit_cost:
          title: Credit Cost
          type: integer
        delivered_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: >-
            When the result went live, was sent or was published; null on
            dismissed work.
          title: Delivered At
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
        dispatchable:
          title: Dispatchable
          type: boolean
        draft_in_flight:
          anyOf:
            - enum:
                - drafting
                - redrafting
              type: string
            - type: 'null'
          title: Draft In Flight
        evidence:
          anyOf:
            - $ref: '#/components/schemas/TaskEvidence'
            - type: 'null'
          description: Linked prompts and rendered answer counts from the latest report.
        expected_impact_pts:
          anyOf:
            - type: integer
            - type: 'null'
          title: Expected Impact Pts
        gate:
          anyOf:
            - enum:
                - approval
                - review
              type: string
            - type: 'null'
          title: Gate
        group:
          enum:
            - new
            - your_input
            - dispatched
            - scheduled
            - waiting
            - settled
            - withdrawn
          title: Group
          type: string
        holder:
          anyOf:
            - enum:
                - you
                - heralded
                - waiting
              type: string
            - type: 'null'
          description: >-
            Who holds the work: you, Heralded or a third party; null when nobody
            holds it.
          title: Holder
        id:
          format: uuid
          title: Id
          type: string
        impact_scale:
          anyOf:
            - type: string
            - type: 'null'
          title: Impact Scale
        job:
          $ref: '#/components/schemas/JobResponse'
        kind:
          title: Kind
          type: string
        member:
          anyOf:
            - enum:
                - writer
                - publicist
                - engineer
                - analyst
              type: string
            - type: 'null'
          description: The responsible team member; null for setup and prompt tracking.
          title: Member
        not_seen_since_run:
          anyOf:
            - type: integer
            - type: 'null'
          description: First read that stopped seeing this suggestion; null when seen.
          title: Not Seen Since Run
        note:
          anyOf:
            - $ref: '#/components/schemas/TaskNote'
            - type: 'null'
          description: Task explanation with a live job step.
        outcome:
          anyOf:
            - enum:
                - verified_up
                - no_move
                - not_measured
                - dismissed
              type: string
            - type: 'null'
          title: Outcome
        paid_off_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: >-
            When verification credited a positive measured gain; null on
            dismissed work.
          title: Paid Off At
        placed_position:
          anyOf:
            - type: integer
            - type: 'null'
          description: Position in the brand's proposed order; null when Heralded ranks it.
          title: Placed Position
        platform:
          title: Platform
          type: boolean
        preview:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Up to 400 characters of draft opening, email recipient and subject,
            or planned change while waiting on you.
          title: Preview
        primary_verb:
          anyOf:
            - enum:
                - dispatch
                - take
                - done
                - defer
                - dismiss
                - confirm
                - reject
                - restore
                - block
                - unblock
                - reopen
              type: string
            - const: review
              type: string
            - type: 'null'
          title: Primary Verb
        prompt_slot_cost:
          title: Prompt Slot Cost
          type: integer
        return_group:
          anyOf:
            - enum:
                - new
                - your_input
                - dispatched
                - scheduled
                - waiting
                - settled
                - withdrawn
              type: string
            - type: 'null'
          title: Return Group
        route:
          title: Route
          type: string
        secondary_verbs:
          items:
            enum:
              - dispatch
              - take
              - done
              - defer
              - dismiss
              - confirm
              - reject
              - restore
              - block
              - unblock
              - reopen
            type: string
          title: Secondary Verbs
          type: array
        setup_link:
          anyOf:
            - $ref: '#/components/schemas/SetupLink'
            - type: 'null'
        stage:
          description: 'The work''s stage: observe, decide, do or verify.'
          enum:
            - observe
            - decide
            - do
            - verify
          title: Stage
          type: string
        started_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: The task's first start by Heralded; null on dismissed work.
          title: Started At
        state:
          enum:
            - new
            - accepted
            - in_progress
            - blocked
            - looks_resolved
            - done
            - verified_no_move
            - deferred
            - dismissed
            - withdrawn
          title: State
          type: string
        target_entity:
          title: Target Entity
          type: string
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
        updated_at:
          format: date-time
          title: Updated At
          type: string
        verified_impact_pts:
          anyOf:
            - type: number
            - type: 'null'
          title: Verified Impact Pts
      required:
        - placed_position
        - not_seen_since_run
        - evidence
        - note
        - id
        - title
        - detail
        - kind
        - member
        - started_at
        - delivered_at
        - paid_off_at
        - preview
        - group
        - holder
        - stage
        - outcome
        - created_at
        - completed_at
        - state
        - route
        - target_entity
        - updated_at
        - impact_scale
        - expected_impact_pts
        - verified_impact_pts
        - primary_verb
        - secondary_verbs
        - job
        - credit_cost
        - prompt_slot_cost
        - dispatchable
        - platform
        - gate
        - setup_link
        - return_group
        - draft_in_flight
      title: V1PromptAction
      type: object
    AnswersLink:
      properties:
        href:
          title: Href
          type: string
      required:
        - href
      title: AnswersLink
      type: object
    V1PromptCompetitor:
      properties:
        answers:
          default: 0
          title: Answers
          type: integer
        domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Domain
        heralded_score:
          $ref: '#/components/schemas/V1Figure'
        is_you:
          title: Is You
          type: boolean
        key:
          title: Key
          type: string
        mentioned:
          $ref: '#/components/schemas/V1Figure'
        name:
          title: Name
          type: string
        recommended:
          $ref: '#/components/schemas/V1Figure'
        trend:
          anyOf:
            - $ref: '#/components/schemas/PromptTrend'
            - type: 'null'
      required:
        - key
        - name
        - domain
        - is_you
        - heralded_score
        - mentioned
        - recommended
        - answers
        - trend
      title: V1PromptCompetitor
      type: object
    PromptEngineCard:
      description: |-
        One engine's figures on the prompt. `figures` is Mentioned,
        Recommended, Understood and Praised, each banded by its own value.
      properties:
        display_name:
          title: Display Name
          type: string
        engine_id:
          title: Engine Id
          type: string
        figures:
          items:
            $ref: '#/components/schemas/ScoreMark'
          title: Figures
          type: array
        score:
          $ref: '#/components/schemas/ScoreMark'
        trend:
          items:
            $ref: '#/components/schemas/FigurePoint'
          title: Trend
          type: array
      required:
        - engine_id
        - display_name
        - score
        - figures
        - trend
      title: PromptEngineCard
      type: object
    EngineVocabulary:
      properties:
        display_name:
          title: Display Name
          type: string
        engine_id:
          title: Engine Id
          type: string
        sort_order:
          title: Sort Order
          type: integer
      required:
        - engine_id
        - display_name
        - sort_order
      title: EngineVocabulary
      type: object
    V1PromptLatestEngine:
      properties:
        answer_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Answer Id
        display_name:
          title: Display Name
          type: string
        engine:
          enum:
            - perplexity
            - gemini
            - openai
            - google_aio
            - ai_mode
            - copilot
            - claude
          title: Engine
          type: string
        read_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Read At
        reading:
          default: false
          title: Reading
          type: boolean
        state:
          enum:
            - leading
            - recommended
            - mentioned
            - weak
            - absent
            - unmeasured
          title: State
          type: string
        state_label:
          readOnly: true
          title: State Label
          type: string
        states:
          $ref: '#/components/schemas/AnswerReadStates'
      required:
        - engine
        - state
        - answer_id
        - reading
        - display_name
        - read_at
        - states
        - state_label
      title: V1PromptLatestEngine
      type: object
    KeywordMeasurement:
      properties:
        country:
          anyOf:
            - type: string
            - type: 'null'
          description: Requested country; null means Global.
          title: Country
        coverage:
          $ref: '#/components/schemas/KeywordCoverage'
          description: >-
            Current catalog availability, not a historical snapshot. Unknown
            means no catalog is available.
        language:
          description: Product language code, independent of vendor aliases.
          title: Language
          type: string
        measured_country:
          description: Country actually targeted; Global uses US.
          title: Measured Country
          type: string
      required:
        - country
        - measured_country
        - language
        - coverage
      title: KeywordMeasurement
      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
    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
    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
    PromptSegment:
      properties:
        geo:
          title: Geo
          type: string
        label:
          title: Label
          type: string
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        persona_id:
          title: Persona Id
          type: string
      required:
        - label
        - persona_id
        - geo
        - name
      title: PromptSegment
      type: object
    V1PromptSource:
      properties:
        citations:
          title: Citations
          type: integer
        domain:
          title: Domain
          type: string
        group:
          enum:
            - own
            - rival
            - review
            - editorial
            - community
            - vendor
            - other
          title: Group
          type: string
        group_label:
          anyOf:
            - type: string
            - type: 'null'
          title: Group Label
        relation:
          anyOf:
            - enum:
                - yours
                - names_you
                - doesnt_name_you
              type: string
            - type: 'null'
          title: Relation
        relation_label:
          anyOf:
            - type: string
            - type: 'null'
          title: Relation Label
      required:
        - domain
        - citations
        - group
        - relation
        - group_label
        - relation_label
      title: V1PromptSource
      type: object
    PromptTile:
      properties:
        answer_count:
          title: Answer Count
          type: integer
        denominator:
          title: Denominator
          type: integer
        explorer_filter:
          additionalProperties:
            type: string
          title: Explorer Filter
          type: object
        numerator:
          title: Numerator
          type: number
        pct:
          anyOf:
            - type: integer
            - type: 'null'
          title: Pct
        unit_label:
          title: Unit Label
          type: string
      required:
        - pct
        - numerator
        - denominator
        - unit_label
        - explorer_filter
        - answer_count
      title: PromptTile
      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
    TaskEvidence:
      properties:
        answers_link:
          anyOf:
            - $ref: '#/components/schemas/AnswersLink'
            - type: 'null'
        prompts:
          items:
            $ref: '#/components/schemas/TaskPromptEvidence'
          title: Prompts
          type: array
      required:
        - prompts
        - answers_link
      title: TaskEvidence
      type: object
    JobResponse:
      description: |-
        What this row's task is as a job (#2429): every stage, where it stands,
        what happens next and what the button does. Composed per kind by
        `app.actions.jobs.describe_job`; no surface keeps a second table.
      properties:
        act_label:
          title: Act Label
          type: string
        control:
          enum:
            - dispatch
            - act
            - take
          title: Control
          type: string
        current:
          anyOf:
            - type: string
            - type: 'null'
          title: Current
        kind:
          title: Kind
          type: string
        next_step:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Step
        primary_label:
          anyOf:
            - type: string
            - type: 'null'
          title: Primary Label
        runs_steps:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Runs Steps
        stages:
          items:
            $ref: '#/components/schemas/JobStageResponse'
          title: Stages
          type: array
        step:
          anyOf:
            - $ref: '#/components/schemas/JobStepResponse'
            - type: 'null'
        stopped_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Stopped At
      required:
        - kind
        - stages
        - current
        - stopped_at
        - next_step
        - control
        - primary_label
        - act_label
        - runs_steps
        - step
      title: JobResponse
      type: object
    TaskNote:
      properties:
        how_well_know:
          title: How Well Know
          type: string
        short_form:
          title: Short Form
          type: string
        what_i_need_from_you:
          title: What I Need From You
          type: string
        what_ill_do:
          title: What Ill Do
          type: string
        whats_happening:
          title: Whats Happening
          type: string
        why_it_matters:
          title: Why It Matters
          type: string
      required:
        - whats_happening
        - why_it_matters
        - what_ill_do
        - what_i_need_from_you
        - how_well_know
        - short_form
      title: TaskNote
      type: object
    SetupLink:
      properties:
        href:
          title: Href
          type: string
        label:
          title: Label
          type: string
      required:
        - label
        - href
      title: SetupLink
      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
    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
    FigurePoint:
      properties:
        answers:
          title: Answers
          type: integer
        at:
          format: date-time
          title: At
          type: string
        break_label:
          anyOf:
            - type: string
            - type: 'null'
          title: Break Label
        breaks:
          items:
            $ref: '#/components/schemas/KeyChange'
          title: Breaks
          type: array
        high:
          anyOf:
            - type: integer
            - type: 'null'
          title: High
        key:
          $ref: '#/components/schemas/ComparabilityKey'
        low:
          anyOf:
            - type: integer
            - type: 'null'
          title: Low
        scan_id:
          format: uuid
          title: Scan Id
          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:
        - scan_id
        - at
        - value
        - low
        - high
        - answers
        - state
        - key
        - breaks
        - break_label
      title: FigurePoint
      type: object
    AnswerReadStates:
      description: >-
        The four words for how one answer treated the brand (D32, D37).


        The wire shape of `app.scans.scoring.axes.AnswerAxes`, which is where
        the

        reading itself is decided — the report, the roll-ups and this history
        all

        read one answer the same way. `None` is unmeasured and never a zero.
      properties:
        icon_states:
          $ref: '#/components/schemas/IconStates'
          readOnly: true
        mentioned:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Mentioned
        praised:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Praised
        recommended:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Recommended
        understood:
          anyOf:
            - type: number
            - type: 'null'
          title: Understood
      required:
        - mentioned
        - understood
        - recommended
        - praised
        - icon_states
      title: AnswerReadStates
      type: object
    KeywordCoverage:
      properties:
        keyword_research:
          description: Availability of discovery and difficulty.
          enum:
            - available
            - unavailable
            - unknown
          title: Keyword Research
          type: string
        search_volume:
          description: Availability of monthly keyword search volume.
          enum:
            - available
            - unavailable
            - unknown
          title: Search Volume
          type: string
      required:
        - keyword_research
        - search_volume
      title: KeywordCoverage
      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: {}
    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
    TaskPromptEvidence:
      properties:
        answer_count:
          title: Answer Count
          type: integer
        answers_link:
          $ref: '#/components/schemas/AnswersLink'
        named_count:
          title: Named Count
          type: integer
        prompt_uid:
          format: uuid
          title: Prompt Uid
          type: string
        text:
          anyOf:
            - type: string
            - type: 'null'
          title: Text
      required:
        - prompt_uid
        - text
        - named_count
        - answer_count
        - answers_link
      title: TaskPromptEvidence
      type: object
    JobStageResponse:
      properties:
        doer:
          enum:
            - heralded
            - member
            - watch
          title: Doer
          type: string
        done_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Done At
        key:
          title: Key
          type: string
        label:
          title: Label
          type: string
        line:
          title: Line
          type: string
      required:
        - key
        - label
        - line
        - doer
        - done_at
      title: JobStageResponse
      type: object
    JobStepResponse:
      description: |-
        One stage the member may run alone where the area would run the
        whole job: `hold_at_gate` on the dispatch request stops it at the
        approval gate (#2429).
      properties:
        hold_at_gate:
          title: Hold At Gate
          type: boolean
        label:
          title: Label
          type: string
      required:
        - label
        - hold_at_gate
      title: JobStepResponse
      type: object
    KeyChange:
      description: One part of the instrument that changed between two reads.
      properties:
        added:
          default: []
          items:
            type: string
          title: Added
          type: array
        part:
          enum:
            - engines
            - market
            - score_version
            - answer_pack_version
          title: Part
          type: string
        removed:
          default: []
          items:
            type: string
          title: Removed
          type: array
        value:
          anyOf:
            - type: string
            - type: 'null'
          title: Value
      required:
        - part
        - added
        - removed
        - value
      title: KeyChange
      type: object
    ComparabilityKey:
      description: |-
        The instrument one read was taken with. A part that cannot be told is
        None, and a None part never breaks a series: a run whose answers the
        retention sweep took no longer says which engines it asked.
      properties:
        answer_pack_version:
          anyOf:
            - type: integer
            - type: 'null'
          title: Answer Pack Version
        engines:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Engines
        markets:
          additionalProperties:
            type: string
          default: {}
          title: Markets
          type: object
        passes:
          anyOf:
            - type: integer
            - type: 'null'
          title: Passes
        score_version:
          title: Score Version
          type: string
      required:
        - engines
        - markets
        - score_version
        - answer_pack_version
        - passes
      title: ComparabilityKey
      type: object
    IconStates:
      description: Each axis as the icon a row draws for it.
      properties:
        mentioned:
          enum:
            - 'yes'
            - partial
            - 'no'
            - not_measured
          title: Mentioned
          type: string
        praised:
          enum:
            - 'yes'
            - partial
            - 'no'
            - not_measured
          title: Praised
          type: string
        recommended:
          enum:
            - 'yes'
            - partial
            - 'no'
            - not_measured
          title: Recommended
          type: string
        understood:
          enum:
            - 'yes'
            - partial
            - 'no'
            - not_measured
          title: Understood
          type: string
      required:
        - mentioned
        - understood
        - recommended
        - praised
      title: IconStates
      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
  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.