> ## 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 indexed pages

> Paginated list of indexed pages, with filters on category, health,
errors, warnings, language, derived status, and URL/title search.

Each page carries `search_metrics`: clicks and impressions from Google
Search Console (`google`) and Bing Webmaster Tools (`bing`), totals
over the time filter (`time_range` 1w, 1m, 1y or all_time, counted back
from the latest day with data; or `date_from` / `date_to`, which win;
all time by default), null per provider when the site has not connected
it. `search_sources` gives the exact days each provider's totals cover.
`sort_by` (google_impressions, google_clicks, bing_impressions,
bing_clicks) with `sort_direction` orders the list by one of them.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/public/indexation/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/indexation/pages:
    get:
      tags:
        - Indexation
      summary: List indexed pages
      description: |-
        Paginated list of indexed pages, with filters on category, health,
        errors, warnings, language, derived status, and URL/title search.

        Each page carries `search_metrics`: clicks and impressions from Google
        Search Console (`google`) and Bing Webmaster Tools (`bing`), totals
        over the time filter (`time_range` 1w, 1m, 1y or all_time, counted back
        from the latest day with data; or `date_from` / `date_to`, which win;
        all time by default), null per provider when the site has not connected
        it. `search_sources` gives the exact days each provider's totals cover.
        `sort_by` (google_impressions, google_clicks, bing_impressions,
        bing_clicks) with `sort_direction` orders the list by one of them.
      operationId: list_pages_api_v1_public_indexation_pages_get
      parameters:
        - name: category
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/WebsiteAuditPageCategory'
              - type: 'null'
            title: Category
        - name: health_passed
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            title: Health Passed
        - name: has_errors
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            title: Has Errors
        - name: has_warnings
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            title: Has Warnings
        - name: language
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Language
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Search
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/WebsitePageStatus'
              - type: 'null'
            title: Status
        - 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: sort_by
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/PageSearchSort'
              - type: 'null'
            title: Sort By
        - name: sort_direction
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/SortDirection'
            default: desc
        - name: time_range
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/TimeRange'
              - type: 'null'
            description: >-
              Preset the pages' search clicks and impressions add up over
              (counted back from the latest day with data). Omitted: all time.
            title: Time Range
          description: >-
            Preset the pages' search clicks and impressions add up over (counted
            back from the latest day with data). Omitted: all time.
        - name: date_from
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date
              - type: 'null'
            description: Custom range start, inclusive. Wins over time_range.
            title: Date From
          description: Custom range start, inclusive. Wins over time_range.
        - name: date_to
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date
              - type: 'null'
            description: Custom range end, inclusive. Wins over time_range.
            title: Date To
          description: Custom range end, inclusive. Wins over time_range.
        - 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/PagesListResponse'
        '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:
    WebsiteAuditPageCategory:
      type: string
      enum:
        - global
        - home_page
        - blog_post
        - blog_list_page
        - service_page
        - product_page
        - pricing_page
        - landing_page
        - docs_page
        - knowledge_base_article
        - faq_page
        - about_page
        - contact_page
        - checkout_page
        - other
        - default
        - unreachable
        - case_study
        - guide
        - product_list_page
        - cart_page
        - legal_page
        - auth_page
        - category_page
        - search_page
        - utility_page
        - glossary_page
        - comparison_page
        - use_case_page
        - ecommerce_product_page
      title: WebsiteAuditPageCategory
    WebsitePageStatus:
      type: string
      enum:
        - blocked
        - not_crawled
        - crawled
        - errors
        - warnings
        - analysed
      title: WebsitePageStatus
    PageSearchSort:
      type: string
      enum:
        - google_impressions
        - google_clicks
        - bing_impressions
        - bing_clicks
      title: PageSearchSort
    SortDirection:
      type: string
      enum:
        - asc
        - desc
      title: SortDirection
    TimeRange:
      type: string
      enum:
        - all_time
        - 1y
        - 1m
        - 1w
        - 1d
      title: TimeRange
    PagesListResponse:
      properties:
        pages:
          items:
            $ref: '#/components/schemas/WebsitePageListItemSchema'
          type: array
          title: Pages
        total:
          type: integer
          title: Total
        limit:
          type: integer
          title: Limit
        offset:
          type: integer
          title: Offset
        search_sources:
          items:
            $ref: '#/components/schemas/SearchSourceSchema'
          type: array
          title: Search Sources
          default: []
      type: object
      required:
        - pages
        - total
        - limit
        - offset
      title: PagesListResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WebsitePageListItemSchema:
      properties:
        id:
          type: integer
          title: Id
        url:
          type: string
          title: Url
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
        language:
          anyOf:
            - type: string
            - type: 'null'
          title: Language
        category:
          $ref: '#/components/schemas/WebsiteAuditPageCategory'
        category_source:
          $ref: '#/components/schemas/PageCategorySource'
        health_check_passed:
          type: boolean
          title: Health Check Passed
        error_count:
          type: integer
          title: Error Count
          default: 0
        warning_count:
          type: integer
          title: Warning Count
          default: 0
        last_crawled_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Crawled At
        crawl_block_reason:
          anyOf:
            - $ref: '#/components/schemas/CrawlBlockReason'
            - type: 'null'
        status:
          $ref: '#/components/schemas/WebsitePageStatus'
        search_metrics:
          $ref: '#/components/schemas/PageSearchMetricsSchema'
          default: {}
      type: object
      required:
        - id
        - url
        - category
        - category_source
        - health_check_passed
        - status
      title: WebsitePageListItemSchema
    SearchSourceSchema:
      properties:
        provider:
          $ref: '#/components/schemas/SearchConsoleProvider'
        status:
          $ref: '#/components/schemas/SearchConsoleLinkStatus'
        granularity:
          $ref: '#/components/schemas/SearchMetricsGranularity'
        period_start:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Period Start
        period_end:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Period End
        data_start:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Data Start
        data_end:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Data End
        last_synced_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Synced At
      type: object
      required:
        - provider
        - status
        - granularity
      title: SearchSourceSchema
    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
    PageCategorySource:
      type: string
      enum:
        - auto_heuristic
        - auto_llm
        - manual
        - sitemap
      title: PageCategorySource
    CrawlBlockReason:
      type: string
      enum:
        - waf_challenge
        - http_forbidden
      title: CrawlBlockReason
    PageSearchMetricsSchema:
      properties:
        google:
          anyOf:
            - $ref: '#/components/schemas/SearchMetricSchema'
            - type: 'null'
        bing:
          anyOf:
            - $ref: '#/components/schemas/SearchMetricSchema'
            - type: 'null'
      type: object
      title: PageSearchMetricsSchema
    SearchConsoleProvider:
      type: string
      enum:
        - google
        - bing
      title: SearchConsoleProvider
    SearchConsoleLinkStatus:
      type: string
      enum:
        - syncing
        - ready
        - failed
        - reauth_required
      title: SearchConsoleLinkStatus
    SearchMetricsGranularity:
      type: string
      enum:
        - day
        - week
      title: SearchMetricsGranularity
    SearchMetricSchema:
      properties:
        clicks:
          type: integer
          title: Clicks
        impressions:
          type: integer
          title: Impressions
      type: object
      required:
        - clicks
        - impressions
      title: SearchMetricSchema
  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.