> ## 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 Source > One cited site's facts, pages, prompts, engines and citation history under shared filters. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/brands/{brand_id}/sources/{domain} 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}/sources/{domain}: get: tags: - v1 summary: Get Source description: >- One cited site's facts, pages, prompts, engines and citation history under shared filters. operationId: getSource parameters: - in: path name: brand_id required: true schema: format: uuid title: Brand Id type: string - in: path name: domain required: true schema: title: Domain 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: content_topic required: false schema: anyOf: - maxLength: 300 type: string - type: 'null' title: Content Topic - in: query name: actions_limit required: false schema: default: 0 maximum: 100 minimum: 0 title: Actions Limit type: integer - in: query name: actions_offset required: false schema: default: 0 minimum: 0 title: Actions Offset type: integer - 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/V1SourceDetail' 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: V1SourceDetail: properties: meta: $ref: '#/components/schemas/Meta' description: Normalized query and newest included scan. period: $ref: '#/components/schemas/V1Period' source: $ref: '#/components/schemas/V1SourceFacts' required: - meta - period - source title: V1SourceDetail 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 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 V1SourceFacts: properties: actions: items: $ref: '#/components/schemas/V1PaneAction' title: Actions type: array actions_limit: default: 0 title: Actions Limit type: integer actions_offset: default: 0 title: Actions Offset type: integer actions_total: default: 0 title: Actions Total type: integer answers: title: Answers type: integer answers_link: anyOf: - $ref: '#/components/schemas/AnswersLink' - type: 'null' answers_share_pct: anyOf: - type: integer - type: 'null' title: Answers Share Pct authority: anyOf: - type: integer - type: 'null' title: Authority change: $ref: '#/components/schemas/V1SourceChange' citation_evidence: default: complete enum: - complete - partial - unavailable title: Citation Evidence type: string citation_share_pct: anyOf: - type: integer - type: 'null' title: Citation Share Pct citations: title: Citations type: integer 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 muted: title: Muted type: boolean names_most: items: $ref: '#/components/schemas/SourceSiteName' title: Names Most type: array names_you: anyOf: - type: boolean - type: 'null' title: Names You opportunity_score: title: Opportunity Score type: number owner: enum: - third_party - competitor - yours title: Owner type: string owner_label: title: Owner Label type: string pages: items: $ref: '#/components/schemas/V1SourcePage' title: Pages type: array pages_total: title: Pages Total type: integer partner: title: Partner type: boolean pitched: title: Pitched type: boolean possible_partner: title: Possible Partner type: boolean 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 read_pages: title: Read Pages type: integer read_pages_naming_you: title: Read Pages Naming You type: integer reports: items: $ref: '#/components/schemas/V1PageCitationReport' title: Reports type: array source_type: anyOf: - enum: - industry_authority - review - regulatory - media - educational - community - consulting - social - vendor - directory - unclassified type: string - const: corporate type: string title: Source Type source_type_label: title: Source Type Label type: string unavailable_scans: default: 0 title: Unavailable Scans type: integer required: - read_pages - names_most - citation_evidence - unavailable_scans - domain - owner - owner_label - source_type - source_type_label - names_you - read_pages_naming_you - authority - opportunity_score - citations - citation_share_pct - answers - answers_share_pct - change - reports - pages - pages_total - prompts - prompts_total - prompts_limit - prompts_offset - engines - muted - partner - possible_partner - pitched - actions - actions_total - actions_limit - actions_offset - answers_link - introduced_at_run title: V1SourceFacts 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: {} V1PaneAction: properties: assignee: anyOf: - $ref: '#/components/schemas/AssigneeResponse' - type: 'null' blocked_owner: anyOf: - type: string - type: 'null' title: Blocked Owner check_again_on: anyOf: - format: date type: string - type: 'null' title: Check Again On 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 demand: title: Demand type: string 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 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' title: Holder id: format: uuid title: Id type: string impact_scale: anyOf: - type: string - type: 'null' title: Impact Scale intent_bucket: anyOf: - type: string - type: 'null' title: Intent Bucket job: $ref: '#/components/schemas/JobResponse' kind: readOnly: true title: Kind type: string looks_resolved_evidence: anyOf: - additionalProperties: true type: object - type: 'null' title: Looks Resolved Evidence 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' 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' title: Placed Position platform: default: false 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 progress: anyOf: - $ref: '#/components/schemas/WorkProgressResponse' - type: 'null' prompt_movement: anyOf: - type: string - type: 'null' title: Prompt Movement prompt_slot_cost: title: Prompt Slot Cost type: integer repeat: anyOf: - enum: - daily - weekly - thrice_weekly type: string - type: 'null' title: Repeat return_group: anyOf: - enum: - new - your_input - dispatched - scheduled - waiting - settled - withdrawn type: string - type: 'null' title: Return Group route: enum: - home - actions - prompts - engines - market - sources - content - perception - audit readOnly: true title: Route type: string run_state: anyOf: - enum: - scheduled - running - done - skipped - failed - stopped type: string - type: 'null' title: Run State scheduled_at: anyOf: - format: date-time type: string - type: 'null' title: Scheduled At scheduled_for: anyOf: - format: date type: string - type: 'null' title: Scheduled For secondary_verbs: items: enum: - dispatch - take - done - defer - dismiss - confirm - reject - restore - block - unblock - reopen type: string title: Secondary Verbs type: array segment: title: Segment type: string settled_at: anyOf: - format: date-time type: string - type: 'null' title: Settled At setup_link: anyOf: - $ref: '#/components/schemas/SetupLink' - type: 'null' stage: enum: - observe - decide - do - verify title: Stage type: string started_at: anyOf: - format: date-time type: string - type: 'null' description: The first time Heralded started this task. 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 target_type: anyOf: - type: string - type: 'null' title: Target Type title: anyOf: - type: string - type: 'null' title: Title tracked_domain_id: format: uuid title: Tracked Domain Id type: string updated_at: format: date-time title: Updated At type: string verified_impact_pts: anyOf: - type: number - type: 'null' title: Verified Impact Pts required: - id - tracked_domain_id - target_entity - target_type - segment - title - detail - state - group - holder - stage - demand - member - started_at - delivered_at - paid_off_at - preview - outcome - gate - settled_at - impact_scale - expected_impact_pts - verified_impact_pts - prompt_movement - blocked_owner - check_again_on - scheduled_for - scheduled_at - repeat - progress - platform - run_state - assignee - intent_bucket - looks_resolved_evidence - not_seen_since_run - placed_position - completed_at - created_at - updated_at - primary_verb - setup_link - secondary_verbs - return_group - job - note - credit_cost - dispatchable - draft_in_flight - prompt_slot_cost - route - kind title: V1PaneAction type: object AnswersLink: properties: href: title: Href type: string required: - href title: AnswersLink type: object V1SourceChange: properties: current: title: Current type: integer delta: anyOf: - type: number - type: 'null' title: Delta direction: enum: - up - down - flat - new title: Direction type: string label: title: Label type: string previous: anyOf: - type: integer - type: 'null' title: Previous required: - direction - delta - previous - current - label title: V1SourceChange 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 SourceSiteName: 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 pages: title: Pages type: integer share_pct: title: Share Pct type: integer required: - brand_key - name - domain - is_you - pages - share_pct title: SourceSiteName type: object V1SourcePage: properties: 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 document_id: anyOf: - type: string - type: 'null' title: Document Id document_key: title: Document Key type: string domain: title: Domain type: string owner: enum: - third_party - competitor - yours title: Owner type: string prompt_count: title: Prompt Count type: integer title: anyOf: - type: string - type: 'null' title: Title topic: anyOf: - $ref: '#/components/schemas/V1SourceTopic' - type: 'null' url: title: Url type: string required: - document_id - document_key - url - title - domain - owner - content_type - content_type_label - topic - citations - prompt_count title: V1SourcePage 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 AssigneeResponse: properties: id: format: uuid title: Id type: string initials: title: Initials type: string name: title: Name type: string required: - id - name - initials title: AssigneeResponse 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 WorkProgressResponse: description: |- How far an executing read has got (#2446): engines answered of the engines asked. The words are the row's; the pips are the client's. properties: done: title: Done type: integer total: title: Total type: integer unit: title: Unit type: string required: - done - total - unit title: WorkProgressResponse type: object SetupLink: properties: href: title: Href type: string label: title: Label type: string required: - label - href title: SetupLink 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 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 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 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.