> ## 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 Cited Page > One cited page under the period and shared filters, daily answers included. Use its cited URL, canonical document key or document id as key. Prompts are paged; reports chart up to twelve weekly reports with the same filters. names_you is null for your own pages or pages that have not been read. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/brands/{brand_id}/cited-page 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}/cited-page: get: tags: - v1 summary: Get Cited Page description: >- One cited page under the period and shared filters, daily answers included. Use its cited URL, canonical document key or document id as key. Prompts are paged; reports chart up to twelve weekly reports with the same filters. names_you is null for your own pages or pages that have not been read. operationId: getCitedPage parameters: - in: path name: brand_id required: true schema: format: uuid title: Brand 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 - description: The cited URL, canonical document key, or document id. in: query name: key required: true schema: description: The cited URL, canonical document key, or document id. maxLength: 4096 minLength: 1 title: Key type: string - in: query name: prompts_limit required: false schema: default: 10 maximum: 100 minimum: 1 title: Prompts Limit type: integer - in: query name: prompts_offset required: false schema: default: 0 minimum: 0 title: Prompts Offset type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/V1CitedPage' 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: V1CitedPage: properties: answers: title: Answers type: integer answers_link: $ref: '#/components/schemas/V1PageAnswers' citation_evidence: default: complete enum: - complete - partial - unavailable title: Citation Evidence type: string citations: title: Citations type: integer content_type: anyOf: - type: string - type: 'null' title: Content Type content_type_label: anyOf: - type: string - type: 'null' title: Content Type Label description: anyOf: - type: string - type: 'null' title: Description document_id: anyOf: - format: uuid type: string - type: 'null' title: Document Id document_key: title: Document Key type: string domain: title: Domain type: string engines: items: $ref: '#/components/schemas/V1PageCitingEngine' title: Engines type: array introduced_at_run: anyOf: - type: integer - type: 'null' title: Introduced At Run meta: $ref: '#/components/schemas/Meta' description: Normalized query and newest included scan. names: anyOf: - items: $ref: '#/components/schemas/SourcePageName' type: array - type: 'null' title: Names names_you: anyOf: - type: boolean - type: 'null' title: Names You owner: enum: - third_party - competitor - yours title: Owner type: string ownership: enum: - own - rival - independent title: Ownership type: string period: $ref: '#/components/schemas/V1Period' prompt_count: title: Prompt Count type: integer prompts: items: $ref: '#/components/schemas/V1PageCitingPrompt' title: Prompts type: array prompts_limit: title: Prompts Limit type: integer prompts_offset: title: Prompts Offset type: integer prompts_total: title: Prompts Total type: integer reports: items: $ref: '#/components/schemas/V1PageCitationReport' title: Reports type: array title: anyOf: - type: string - type: 'null' title: Title topic: anyOf: - $ref: '#/components/schemas/V1SourceTopic' - type: 'null' unavailable_scans: default: 0 title: Unavailable Scans type: integer url: title: Url type: string required: - meta - description - names - citation_evidence - unavailable_scans - period - document_id - document_key - url - title - domain - ownership - content_type - owner - content_type_label - topic - prompt_count - introduced_at_run - citations - answers - names_you - reports - prompts - prompts_total - prompts_limit - prompts_offset - engines - answers_link title: V1CitedPage 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 V1PageAnswers: properties: url: title: Url type: string required: - url title: V1PageAnswers type: object V1PageCitingEngine: properties: answers: title: Answers type: integer answers_share_pct: anyOf: - type: integer - type: 'null' title: Answers Share Pct citations: title: Citations type: integer engine: enum: - perplexity - gemini - openai - google_aio - ai_mode - copilot - claude title: Engine type: string required: - engine - citations - answers - answers_share_pct title: V1PageCitingEngine 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 SourcePageName: properties: brand_key: title: Brand Key type: string domain: anyOf: - type: string - type: 'null' title: Domain is_you: title: Is You type: boolean name: title: Name type: string recommends: anyOf: - type: boolean - type: 'null' title: Recommends required: - brand_key - name - domain - is_you - recommends title: SourcePageName 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 V1PageCitingPrompt: properties: answers: title: Answers type: integer citations: title: Citations type: integer prompt_id: anyOf: - format: uuid type: string - type: 'null' title: Prompt Id text: title: Text type: string required: - prompt_id - text - citations - answers title: V1PageCitingPrompt type: object V1PageCitationReport: properties: break_label: anyOf: - type: string - type: 'null' title: Break Label breaks: items: $ref: '#/components/schemas/KeyChange' title: Breaks type: array citations: anyOf: - type: integer - type: 'null' title: Citations completed_at: format: date-time title: Completed At type: string degraded: title: Degraded type: boolean key: anyOf: - $ref: '#/components/schemas/ComparabilityKey' - type: 'null' measured_domain: anyOf: - type: string - type: 'null' title: Measured Domain prompts_changed: default: false title: Prompts Changed type: boolean run_number: title: Run Number type: integer required: - measured_domain - key - breaks - prompts_changed - run_number - completed_at - citations - degraded - break_label title: V1PageCitationReport type: object V1SourceTopic: properties: key: title: Key type: string status: enum: - missing - cited - falls_short - ranks_in_search - not_cited title: Status type: string status_label: title: Status Label type: string topic: title: Topic type: string required: - key - topic - status - status_label title: V1SourceTopic 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: {} 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 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.