> ## 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 Moving Away From

> For each label the brand is moving away from, the share of answers naming it that still
describe it that way, the change against the baseline where the paired test calls it real,
the newest answer's words, and the cited pages that repeat it.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/brands/{brand_id}/moving-away-from
openapi: 3.1.0
info:
  description: >-
    Access to one organization's brands, as the member who created the API key.
    A read-only key reads; a full-access key also starts, edits and runs that
    member's Snapshots on the organization's Snapshot credits. Each key may make
    120 requests a minute. Separate organization service tokens can start
    Snapshots and Full audits and read service audits. Every error is an RFC
    9457 problem (`application/problem+json`) whose `code` names it.
  summary: Read your brands' AI visibility and run Snapshots in Heralded.
  title: Heralded API
  version: '1'
servers:
  - url: https://api.heralded.ai
security: []
paths:
  /v1/brands/{brand_id}/moving-away-from:
    get:
      tags:
        - v1
      summary: Get Moving Away From
      description: >-
        For each label the brand is moving away from, the share of answers
        naming it that still

        describe it that way, the change against the baseline where the paired
        test calls it real,

        the newest answer's words, and the cited pages that repeat it.
      operationId: getMovingAwayFrom
      parameters:
        - description: The brand's UUID from listBrands.
          in: path
          name: brand_id
          required: true
          schema:
            description: The brand's UUID from listBrands.
            format: uuid
            title: Brand Id
            type: string
        - description: >-
            Country ISO code, europe for pooled Europe, or global for no
            country. Omit for all.
          in: query
          name: market
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Country ISO code, europe for pooled Europe, or global for no
              country. Omit for all.
            title: Market
        - description: >-
            Audience UUID, or all_buyers for topics for all buyers. Omit for
            all.
          in: query
          name: audience
          required: false
          schema:
            anyOf:
              - format: uuid
                type: string
              - const: all_buyers
                type: string
              - type: 'null'
            description: >-
              Audience UUID, or all_buyers for topics for all buyers. Omit for
              all.
            title: Audience
        - description: Answering AI engine.
          in: query
          name: engine
          required: false
          schema:
            anyOf:
              - enum:
                  - perplexity
                  - gemini
                  - openai
                  - google_aio
                  - ai_mode
                  - copilot
                  - claude
                type: string
              - type: 'null'
            description: Answering AI engine.
            title: Engine
        - description: Question type.
          in: query
          name: type
          required: false
          schema:
            anyOf:
              - enum:
                  - organic
                  - brand_specific
                  - competitor_comparison
                type: string
              - type: 'null'
            description: Question type.
            title: Type
        - description: Question intent.
          in: query
          name: intent
          required: false
          schema:
            anyOf:
              - enum:
                  - educational
                  - problem
                  - comparison
                  - transactional
                type: string
              - type: 'null'
            description: Question intent.
            title: Intent
        - description: Tracked topic UUID.
          in: query
          name: topic
          required: false
          schema:
            anyOf:
              - format: uuid
                type: string
              - type: 'null'
            description: Tracked topic UUID.
            title: Topic
        - description: Question id from list_prompts.
          in: query
          name: prompt
          required: false
          schema:
            anyOf:
              - format: uuid
                type: string
              - type: 'null'
            description: Question id from list_prompts.
            title: Prompt
        - description: Completed scan id cutoff.
          in: query
          name: as_of
          required: false
          schema:
            anyOf:
              - format: uuid
                type: string
              - type: 'null'
            description: Completed scan id cutoff.
            title: As Of
        - description: Weekly-report period.
          in: query
          name: period
          required: false
          schema:
            default: 1w
            description: Weekly-report period.
            enum:
              - 1w
              - 4w
              - 12w
              - all
            title: Period
            type: string
        - description: One label's key from the labels list, for that label alone.
          in: query
          name: label
          required: false
          schema:
            anyOf:
              - maxLength: 40
                minLength: 1
                type: string
              - type: 'null'
            description: One label's key from the labels list, for that label alone.
            title: Label
        - description: Maximum pages listed under each label.
          in: query
          name: list_limit
          required: false
          schema:
            default: 10
            description: Maximum pages listed under each label.
            maximum: 100
            minimum: 1
            title: List Limit
            type: integer
        - description: Pages to skip under each label.
          in: query
          name: pages_offset
          required: false
          schema:
            default: 0
            description: Pages to skip under each label.
            minimum: 0
            title: Pages Offset
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1MovingAwayFrom'
          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: https://docs.heralded.ai/errors-and-limits#invalid_cursor
              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: https://docs.heralded.ai/errors-and-limits#invalid_token
              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: https://docs.heralded.ai/errors-and-limits#not_found
              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: https://docs.heralded.ai/errors-and-limits#workspace_archived
              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: https://docs.heralded.ai/errors-and-limits#invalid_request
              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: https://docs.heralded.ai/errors-and-limits#rate_limited
              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:
    V1MovingAwayFrom:
      properties:
        filters:
          $ref: '#/components/schemas/FigureFilters'
          description: The filters the answers and pages were read under.
        labels:
          description: >-
            The labels the brand is moving away from, in the order its profile
            lists them. Empty when it names none.
          items:
            $ref: '#/components/schemas/MovingAwayLabel'
          title: Labels
          type: array
        meta:
          $ref: '#/components/schemas/Meta'
          description: Normalized query and newest included scan.
        period:
          $ref: '#/components/schemas/V1Period'
          description: The period and reports the shares were read over.
      required:
        - meta
        - period
        - filters
        - labels
      title: V1MovingAwayFrom
      type: object
    Problem:
      description: An RFC 9457 problem linking its code to human-readable documentation.
      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:
          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:
          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:
          title: Type
          type: string
      required:
        - type
        - title
        - status
        - detail
        - code
        - instance
        - rate_limit
      title: RateLimitProblem
      type: object
    FigureFilters:
      properties:
        audience:
          anyOf:
            - format: uuid
              type: string
            - const: all_buyers
              type: string
            - type: 'null'
          description: >-
            Audience UUID, or all_buyers for topics for all buyers. Omit for
            all.
          title: Audience
        engine:
          anyOf:
            - enum:
                - perplexity
                - gemini
                - openai
                - google_aio
                - ai_mode
                - copilot
                - claude
              type: string
            - type: 'null'
          description: Answering AI engine.
          title: Engine
        intent:
          anyOf:
            - enum:
                - educational
                - problem
                - comparison
                - transactional
              type: string
            - type: 'null'
          description: Question intent.
          title: Intent
        market:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Country ISO code, europe for pooled Europe, or global for no
            country. Omit for all.
          title: Market
        prompt:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          description: Question id from list_prompts.
          title: Prompt
        topic:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          description: Tracked topic UUID.
          title: Topic
        type:
          anyOf:
            - enum:
                - organic
                - brand_specific
                - competitor_comparison
              type: string
            - type: 'null'
          description: Question type.
          title: Type
      required:
        - market
        - audience
        - engine
        - type
        - intent
        - topic
        - prompt
      title: FigureFilters
      type: object
    MovingAwayLabel:
      properties:
        answers:
          description: The answers naming the brand that were read against the label.
          title: Answers
          type: integer
        high:
          anyOf:
            - type: integer
            - type: 'null'
          description: The share's 95% range, high end.
          title: High
        key:
          description: The label's stable key, the same however it is cased.
          title: Key
          type: string
        label:
          description: The label as the profile words it.
          title: Label
          type: string
        low:
          anyOf:
            - type: integer
            - type: 'null'
          description: The share's 95% range, low end.
          title: Low
        pages:
          description: >-
            The pages the period's answers cited that describe the brand with
            the label, your own first, then the most cited.
          items:
            $ref: '#/components/schemas/RepeatingPage'
          title: Pages
          type: array
        pages_total:
          description: All such pages before paging.
          title: Pages Total
          type: integer
        quote:
          anyOf:
            - $ref: '#/components/schemas/LabelQuote'
            - type: 'null'
          description: The newest answer in the period that uses the label, with its words.
        share:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            Whole percent of answers that describe the brand with the label;
            null unless measured.
          title: Share
        state:
          description: >-
            `not_measured` until a report has read an answer against the label,
            `too_few_answers` under three answers, which serves no share.
          enum:
            - measured
            - too_few_answers
            - not_measured
          title: State
          type: string
        trend:
          $ref: '#/components/schemas/MovingAwayTrend'
          description: >-
            The change in the share against the baseline. `up` or `down` only
            where the paired test over the cells both periods measured calls the
            move real; a fall is the improvement.
        uses:
          description: Of those, the answers that describe the brand with it.
          title: Uses
          type: integer
      required:
        - key
        - label
        - state
        - answers
        - uses
        - share
        - low
        - high
        - trend
        - quote
        - pages
        - pages_total
      title: MovingAwayLabel
      type: object
    Meta:
      properties:
        data_as_of:
          anyOf:
            - $ref: '#/components/schemas/DataAsOf'
            - type: 'null'
        last_attempt_failed:
          default: false
          description: The newest attempt failed; the last good result is displayed.
          title: Last Attempt Failed
          type: boolean
        partial:
          default: false
          description: The displayed response includes a partial report.
          title: Partial
          type: boolean
        query:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          title: Query
          type: object
        surfaces:
          additionalProperties:
            $ref: '#/components/schemas/SurfaceFreshness'
          description: >-
            Freshness by Command Center surface key. Each entry describes its
            own displayed result, including results without a scan.
          title: Surfaces
          type: object
        updating:
          default: false
          description: A newer result is being produced or is not yet displayed.
          title: Updating
          type: boolean
      required:
        - query
        - data_as_of
        - partial
        - updating
        - last_attempt_failed
        - surfaces
      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
    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
    RepeatingPage:
      description: A page AI cited that describes the brand with the label.
      properties:
        citations:
          description: The period's answers that cited the page.
          title: Citations
          type: integer
        domain:
          description: The page's registrable domain.
          title: Domain
          type: string
        owned:
          description: Whether the page is on one of your own domains.
          title: Owned
          type: boolean
        state:
          anyOf:
            - enum:
                - yours
                - new
              type: string
            - type: 'null'
          description: >-
            `yours` for a page on your own domains, `new` for a page the newest
            report is the first to cite, otherwise null.
          title: State
        title:
          anyOf:
            - type: string
            - type: 'null'
          description: The page's title where it has one.
          title: Title
        type:
          anyOf:
            - type: string
            - type: 'null'
          description: The kind of page, such as a blog post or a review.
          title: Type
        url:
          description: The page's address, without tracking parameters.
          title: Url
          type: string
      required:
        - url
        - domain
        - title
        - type
        - citations
        - owned
        - state
      title: RepeatingPage
      type: object
    LabelQuote:
      description: The newest answer's words that describe the brand with the label.
      properties:
        answer_read_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          description: >-
            The answer to open for the whole text; null on a report that kept
            none.
          title: Answer Read Id
        asked_language:
          anyOf:
            - type: string
            - type: 'null'
          description: The language the prompt was asked in, where it froze one.
          title: Asked Language
        engine_id:
          description: The engine that gave the answer.
          title: Engine Id
          type: string
        language:
          default: unknown
          description: The language of the quote, `unknown` where not read.
          title: Language
          type: string
        prompt_uid:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          description: The tracked prompt the answer was asked under.
          title: Prompt Uid
        quote:
          description: The sentence of the answer that describes the brand so.
          title: Quote
          type: string
      required:
        - quote
        - engine_id
        - prompt_uid
        - answer_read_id
        - asked_language
        - language
      title: LabelQuote
      type: object
    MovingAwayTrend:
      description: 'The change in the share of answers that use the label: a rise is bad.'
      properties:
        delta:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            The change in whole points, signed; null where no comparison bounded
            one.
          title: Delta
        label:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The words beside the arrow: the size of a real move, `Steady`,
            `Calibrating` or `First report`; null where no answer was read.
          title: Label
        state:
          description: >-
            `up` or `down` only where the paired test calls the move real,
            `none` where no answer was read against the label.
          enum:
            - up
            - down
            - steady
            - calibrating
            - first_report
            - not_comparable
            - none
          title: State
          type: string
      required:
        - state
        - delta
        - label
      title: MovingAwayTrend
      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: {}
    SurfaceFreshness:
      properties:
        as_of:
          anyOf:
            - $ref: '#/components/schemas/SurfaceAsOf'
            - type: 'null'
          description: The result displayed here.
        last_attempt_failed:
          default: false
          description: The newest attempt failed; any displayed result is retained.
          title: Last Attempt Failed
          type: boolean
        partial:
          default: false
          description: The displayed report is partial.
          title: Partial
          type: boolean
        updating:
          default: false
          description: A newer attempt exists whose result is not yet displayed.
          title: Updating
          type: boolean
      required:
        - as_of
        - partial
        - updating
        - last_attempt_failed
      title: SurfaceFreshness
      type: object
    SurfaceAsOf:
      properties:
        at:
          description: When the displayed result was measured.
          format: date-time
          title: At
          type: string
        scan_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          description: The result's scan, null for a timestamp-only result.
          title: Scan Id
      required:
        - scan_id
        - at
      title: SurfaceAsOf
      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.