> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tryhikoo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List source pages

> Cited pages, ordered by opportunity: what each page is, whether your brand is on it, and whether Hikoo has checked it. Read `brand_present` together with `page_examined`: both false means the page was not checked yet, not that you are absent. The list covers your plan's window, and `total_in_store` gives the full count. Each page also carries `momentum`.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/public/source-intelligence/pages
openapi: 3.1.0
info:
  title: Hikoo REST API
  description: >-
    Programmatic access to your Hikoo data: AI citations, prompts, topics,
    competitors, sources, audits, site health, indexation, AI-crawler traffic,
    and outreach. Authenticate with a personal API key sent as `Authorization:
    Bearer <key>`. Create one in the dashboard under **Settings > API keys**.
  version: 1.0.0
servers:
  - url: https://api.tryhikoo.com
    description: Production
security:
  - apiKey: []
tags:
  - name: Account
    description: The user behind the API key.
  - name: Workspaces
    description: >-
      Workspaces the user belongs to. Use them to find the websites you can
      query.
  - name: Websites
    description: Every website the user can access, with its subscription status.
  - name: Website
    description: Metadata and plan of one website.
  - name: Citations
    description: >-
      Every time an AI assistant answers one of your prompts, Hikoo stores the
      answer as a citation. These endpoints list them and aggregate them by
      platform, source, sentiment and match type.
  - name: Prompts
    description: >-
      Prompts are the questions Hikoo sends to AI assistants for a website.
      Create, edit, archive and restore them, and read their visibility, answers
      and citations.
  - name: Topics
    description: Topics group prompts. Every prompt belongs to one topic.
  - name: Search queries
    description: >-
      The web searches AI assistants run internally (query fan-out) before
      answering your prompts.
  - name: URL lookup
    description: >-
      Where one URL shows up, across AI-cited sources and AI-crawler traffic, in
      one call.
  - name: Competitors
    description: >-
      Tracked competitors, their share of voice, and the competitor suggestions
      Hikoo detects in AI answers.
  - name: Source intelligence
    description: >-
      The domains and pages AI assistants cite for your prompts, and who appears
      on them.
  - name: Audits
    description: GEO audits of a full site, a list of pages or a single URL.
  - name: Health
    description: >-
      Site-level checks for AI readiness (robots.txt, llms.txt, sitemap) and
      improvement suggestions.
  - name: Indexation
    description: >-
      The pages Hikoo crawled on your website, their category, health and
      errors.
  - name: Content gaps
    description: >-
      Topics where AI assistants answer without citing you, with a content brief
      for each.
  - name: Agent analytics
    description: Traffic from AI crawlers and AI agents on your website.
  - name: Outreach
    description: >-
      The outreach agent: sources worth getting cited on, their contacts, the
      pitches waiting for approval, follow-ups, and what the agent is allowed to
      do on its own.
paths:
  /api/v1/public/source-intelligence/pages:
    get:
      tags:
        - Source intelligence
      summary: List source pages
      description: >-
        Cited pages, ordered by opportunity: what each page is, whether your
        brand is on it, and whether Hikoo has checked it. Read `brand_present`
        together with `page_examined`: both false means the page was not checked
        yet, not that you are absent. The list covers your plan's window, and
        `total_in_store` gives the full count. Each page also carries
        `momentum`.
      operationId: list_source_pages_api_v1_public_source_intelligence_pages_get
      parameters:
        - name: relation
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/SourceRelation'
              - type: 'null'
            description: owned | contested | lost_ground | open
            title: Relation
          description: owned | contested | lost_ground | open
        - name: present
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            description: >-
              true: only pages the brand appears on. false: only pages it does
              not. Takes precedence over relation.
            title: Present
          description: >-
            true: only pages the brand appears on. false: only pages it does
            not. Takes precedence over relation.
        - name: topic_id
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            title: Topic Id
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 200
              - type: 'null'
            title: Search
        - name: momentum
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/SourceMomentum'
              - type: 'null'
            description: new | surging | steady | fading | dormant
            title: Momentum
          description: new | surging | steady | fading | dormant
        - name: actionable_only
          in: query
          required: false
          schema:
            type: boolean
            default: false
            title: Actionable Only
        - name: active_only
          in: query
          required: false
          schema:
            type: boolean
            default: false
            title: Active Only
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            default: 50
            title: Limit
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
            title: Offset
        - name: website_id
          in: query
          required: true
          schema:
            type: integer
            description: Target website id
            title: Website Id
          description: Target website id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicSourcePagesResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    SourceRelation:
      type: string
      enum:
        - lost_ground
        - contested
        - owned
        - open
      title: SourceRelation
    SourceMomentum:
      type: string
      enum:
        - new
        - surging
        - steady
        - fading
        - dormant
      title: SourceMomentum
    PublicSourcePagesResponse:
      properties:
        pages:
          items:
            $ref: '#/components/schemas/PublicSourcePage'
          type: array
          title: Pages
        total:
          type: integer
          title: Total
        relation_counts:
          additionalProperties:
            type: integer
          type: object
          title: Relation Counts
          default: {}
        plan_max:
          type: integer
          title: Plan Max
          default: 0
        total_in_store:
          type: integer
          title: Total In Store
          default: 0
      type: object
      required:
        - pages
        - total
      title: PublicSourcePagesResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PublicSourcePage:
      properties:
        url:
          type: string
          title: Url
        domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Domain
        title:
          type: string
          title: Title
        source_type:
          type: string
          title: Source Type
        citation_count:
          type: integer
          title: Citation Count
          default: 0
        platforms:
          items:
            type: string
          type: array
          title: Platforms
          default: []
        first_cited_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: First Cited At
        last_cited_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Cited At
        relation:
          $ref: '#/components/schemas/SourceRelation'
        brand_present:
          type: boolean
          title: Brand Present
          default: false
        present_on_page:
          items:
            $ref: '#/components/schemas/LostGroundBrandRank'
          type: array
          title: Present On Page
          default: []
        presence_status:
          anyOf:
            - $ref: '#/components/schemas/SourcePresenceStatus'
            - type: 'null'
        page_examined:
          type: boolean
          title: Page Examined
          default: false
        presence_known:
          type: boolean
          title: Presence Known
          default: false
        opportunity_score:
          type: number
          title: Opportunity Score
          default: 0
        momentum:
          $ref: '#/components/schemas/SourceMomentum'
          default: steady
        citations_30d:
          type: integer
          title: Citations 30D
          default: 0
        citations_prev_30d:
          type: integer
          title: Citations Prev 30D
          default: 0
        is_active:
          type: boolean
          title: Is Active
          default: true
        actionable:
          type: boolean
          title: Actionable
          default: true
        is_sponsored:
          type: boolean
          title: Is Sponsored
          default: false
        is_press_release:
          type: boolean
          title: Is Press Release
          default: false
        author:
          anyOf:
            - type: string
            - type: 'null'
          title: Author
      type: object
      required:
        - url
        - title
        - source_type
        - relation
      title: PublicSourcePage
    Error:
      type: object
      title: Error
      required:
        - detail
      properties:
        detail:
          type: string
          description: Human-readable explanation of the error.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    LostGroundBrandRank:
      properties:
        competitor_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Competitor Id
        name:
          type: string
          title: Name
        rank:
          anyOf:
            - type: integer
            - type: 'null'
          title: Rank
        is_site:
          type: boolean
          title: Is Site
          default: false
      type: object
      required:
        - name
      title: LostGroundBrandRank
    SourcePresenceStatus:
      type: string
      enum:
        - pending
        - present
        - absent
        - blocked
      title: SourcePresenceStatus
  responses:
    Unauthorized:
      description: >-
        The `Authorization` header is missing, malformed, or the key is invalid,
        expired or revoked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail: Invalid or expired API key
    Forbidden:
      description: >-
        The key is valid but not allowed to do this: the website has no active
        subscription, your role in the workspace is read-only for a write
        request, or your email is not verified.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail: >-
              This website has no active subscription, so its data is
              unavailable.
      headers:
        X-Error-Code:
          description: >-
            Stable machine-readable error code, when one applies (for example
            `rate_limited`).
          schema:
            type: string
    NotFound:
      description: >-
        The website, or the resource in the path, does not exist or is not
        visible to this key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail: Website not found
    RateLimited:
      description: >-
        Too many requests for this API key. Wait for the number of seconds in
        `Retry-After`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail: Too many requests. Please try again shortly.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
        X-Error-Code:
          description: >-
            Stable machine-readable error code, when one applies (for example
            `rate_limited`).
          schema:
            type: string
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: Personal API key created in the dashboard under Settings > API keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.