> ## 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 Reputation Opinion > One opinion with its holders: the AI answers, threads, posts and pages that state it, with the passage of each. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/brands/{brand_id}/reputation/opinions/{opinion_id} 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. Separate organisation service tokens can start Snapshots. 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}/reputation/opinions/{opinion_id}: get: tags: - v1 summary: Get Reputation Opinion description: >- One opinion with its holders: the AI answers, threads, posts and pages that state it, with the passage of each. operationId: getReputationOpinion parameters: - in: path name: brand_id required: true schema: format: uuid title: Brand Id type: string - in: path name: opinion_id required: true schema: format: uuid title: Opinion Id 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 - in: query name: list_limit required: false schema: anyOf: - maximum: 100 minimum: 1 type: integer - type: 'null' title: List Limit - in: query name: prompts_offset required: false schema: default: 0 minimum: 0 title: Prompts Offset type: integer - in: query name: sources_offset required: false schema: default: 0 minimum: 0 title: Sources Offset type: integer - in: query name: pages_offset required: false schema: default: 0 minimum: 0 title: Pages Offset type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/V1ReputationOpinionPane' 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: V1ReputationOpinionPane: properties: holders: description: Newest first, at most `list_limit`. items: $ref: '#/components/schemas/V1ReputationOpinionHolder' title: Holders type: array holders_total: title: Holders Total type: integer meta: $ref: '#/components/schemas/Meta' description: Normalized query and newest included scan. opinion: $ref: '#/components/schemas/V1ReputationOpinion' period: $ref: '#/components/schemas/V1Period' required: - meta - period - opinion - holders - holders_total title: V1ReputationOpinionPane 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 V1ReputationOpinionHolder: properties: domain: anyOf: - type: string - type: 'null' title: Domain engine: anyOf: - type: string - type: 'null' description: The engine of an AI answer. title: Engine held_at: anyOf: - format: date-time type: string - type: 'null' description: When the report that froze it completed. title: Held At kind: description: '`ai_answer`, or the document''s kind.' title: Kind type: string passage: description: The words that state it. title: Passage type: string platform: anyOf: - type: string - type: 'null' title: Platform prompt: anyOf: - type: string - type: 'null' description: The prompt an AI answer was asked under. title: Prompt published_at: anyOf: - format: date-time type: string - type: 'null' title: Published At title: anyOf: - type: string - type: 'null' title: Title url: anyOf: - type: string - type: 'null' title: Url required: - kind - engine - prompt - platform - url - domain - title - published_at - held_at - passage title: V1ReputationOpinionHolder 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 V1ReputationOpinion: properties: action_id: anyOf: - format: uuid type: string - type: 'null' description: The task filed to answer it, if any. title: Action Id change: description: >- Holders in the 28 days to the period's newest report, less those of the 28 days before. title: Change type: integer engines: description: The engines with an answer that holds it. items: type: string title: Engines type: array held_by: description: >- Distinct holders in the period: each AI answer and each document once. title: Held By type: integer id: format: uuid title: Id type: string kinds: additionalProperties: type: integer description: >- Holders by kind: `ai_answer`, then the kind of each document (`thread`, `post`, `article`, `video`, `podcast`, `review`, `page`). title: Kinds type: object label: title: Label type: string tone: enum: - positive - negative title: Tone type: string required: - id - label - tone - held_by - kinds - engines - change - action_id title: V1ReputationOpinion 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 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: {} 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.