> ## 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 Brand Snapshots

> Unlocked full Snapshots, including the baseline, newest first. Figures
match each Snapshot's issued report. Service tokens need managed:read.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/brands/{brand_id}/snapshots
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}/snapshots:
    get:
      tags:
        - v1
      summary: Get Brand Snapshots
      description: |-
        Unlocked full Snapshots, including the baseline, newest first. Figures
        match each Snapshot's issued report. Service tokens need managed:read.
      operationId: getBrandSnapshots
      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: Only Snapshots measured strictly before this date-time.
          in: query
          name: before
          required: false
          schema:
            anyOf:
              - format: date-time
                type: string
              - type: 'null'
            description: Only Snapshots measured strictly before this date-time.
            title: Before
        - description: Maximum Snapshots to return, from 1 to 52.
          in: query
          name: limit
          required: false
          schema:
            default: 8
            description: Maximum Snapshots to return, from 1 to 52.
            maximum: 52
            minimum: 1
            title: Limit
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1BrandSnapshots'
          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
        '403':
          content:
            application/problem+json:
              example:
                code: insufficient_scope
                detail: >-
                  The credential does not have the scope this operation
                  requires.
                instance: example-request-id
                status: 403
                title: Forbidden
                type: https://docs.heralded.ai/errors-and-limits#insufficient_scope
              schema:
                $ref: '#/components/schemas/Problem'
          description: The service token lacks the required scope.
          headers:
            WWW-Authenticate:
              schema:
                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:
        - serviceToken: []
        - apiKey: []
components:
  schemas:
    V1BrandSnapshots:
      properties:
        meta:
          $ref: '#/components/schemas/Meta'
          description: Normalized query and newest included scan.
        snapshots:
          description: Unlocked full Snapshots, newest first.
          items:
            $ref: '#/components/schemas/V1BrandSnapshot'
          title: Snapshots
          type: array
      required:
        - meta
        - snapshots
      title: V1BrandSnapshots
      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
    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
    V1BrandSnapshot:
      properties:
        answer_count:
          description: Measured answers in the Snapshot's issued figures.
          title: Answer Count
          type: integer
        engines:
          description: Engines with measured answers in this Snapshot.
          items:
            type: string
          title: Engines
          type: array
        issued:
          anyOf:
            - $ref: '#/components/schemas/V1SnapshotFigures'
            - type: 'null'
          description: >-
            The Snapshot's issued figures; null while partial or without an
            issued record.
        measured_at:
          description: When the Snapshot completed, in UTC.
          format: date-time
          title: Measured At
          type: string
        share_id:
          description: The Snapshot's report link id.
          format: uuid
          title: Share Id
          type: string
        share_visibility:
          description: >-
            Public is unlisted, restricted needs member access, revoked cannot
            be shared.
          enum:
            - public
            - restricted
            - revoked
          title: Share Visibility
          type: string
        total_engines:
          description: Number of engines asked by this Snapshot.
          title: Total Engines
          type: integer
      required:
        - share_id
        - measured_at
        - share_visibility
        - engines
        - total_engines
        - answer_count
        - issued
      title: V1BrandSnapshot
      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
    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
    V1SnapshotFigures:
      properties:
        heralded_score:
          anyOf:
            - $ref: '#/components/schemas/V1IssuedScore'
            - type: 'null'
          description: The Heralded Score this Snapshot issued.
        mentioned:
          anyOf:
            - $ref: '#/components/schemas/V1IssuedRate'
            - type: 'null'
          description: Mentioned, ranked among this Snapshot's rivals.
        recommended:
          anyOf:
            - $ref: '#/components/schemas/V1IssuedRate'
            - type: 'null'
          description: Recommended, ranked among this Snapshot's rivals.
      required:
        - heralded_score
        - mentioned
        - recommended
      title: V1SnapshotFigures
      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
    V1IssuedScore:
      properties:
        answers:
          title: Answers
          type: integer
        band:
          title: Band
          type: string
        high:
          title: High
          type: integer
        low:
          title: Low
          type: integer
        value:
          title: Value
          type: integer
      required:
        - value
        - low
        - high
        - band
        - answers
      title: V1IssuedScore
      type: object
    V1IssuedRate:
      properties:
        high:
          title: High
          type: integer
        k:
          description: The answers that counted.
          title: K
          type: integer
        low:
          title: Low
          type: integer
        'n':
          description: The answers read.
          title: 'N'
          type: integer
        rank:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            The brand's place among the rivals this scan scored; null where no
            answer counted the brand.
          title: Rank
        rank_of:
          description: The brand and every rival measured.
          title: Rank Of
          type: integer
        value:
          title: Value
          type: integer
      required:
        - value
        - low
        - high
        - k
        - 'n'
        - rank
        - rank_of
      title: V1IssuedRate
      type: object
  securitySchemes:
    serviceToken:
      description: >-
        An organisation service token, sent as Authorization: Bearer
        hrld_svc_... Scopes: scans:start starts service scans; scans:read reads
        them; managed:read reads brands, profile, overview, scores, competitors,
        actions and Snapshots in actively managed organisations; managed:share
        makes their restricted Snapshots unlisted.
      scheme: bearer
      type: http
    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.