> ## 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.

# Get AI-crawler traffic

> AI-agent traffic dashboard: totals, per-vendor rows and a visit trend.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/public/agent-analytics
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/agent-analytics:
    get:
      tags:
        - Agent analytics
      summary: Get AI-crawler traffic
      description: 'AI-agent traffic dashboard: totals, per-vendor rows and a visit trend.'
      operationId: get_agent_analytics_api_v1_public_agent_analytics_get
      parameters:
        - name: time_range
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/TimeRange'
            default: 1m
        - name: vendors
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated vendor codes.
            title: Vendors
          description: Comma-separated vendor codes.
        - name: categories
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Comma-separated intents: ai_referral, ai_search, ai_training,
              ai_agent, ai_crawler.
            title: Categories
          description: >-
            Comma-separated intents: ai_referral, ai_search, ai_training,
            ai_agent, ai_crawler.
        - 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/AgentAnalyticsResponse'
        '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:
    TimeRange:
      type: string
      enum:
        - all_time
        - 1y
        - 1m
        - 1w
        - 1d
      title: TimeRange
    AgentAnalyticsResponse:
      properties:
        time_range:
          $ref: '#/components/schemas/TimeRange'
        summary:
          $ref: '#/components/schemas/AgentSummaryCard'
        trend:
          items:
            $ref: '#/components/schemas/AgentTrendPoint'
          type: array
          title: Trend
        vendors:
          items:
            $ref: '#/components/schemas/AgentVendorRow'
          type: array
          title: Vendors
        vendors_in_scope:
          items:
            $ref: '#/components/schemas/AgentVendorRow'
          type: array
          title: Vendors In Scope
          default: []
        categories:
          items:
            $ref: '#/components/schemas/AgentCategoryRow'
          type: array
          title: Categories
          default: []
        agents:
          items:
            $ref: '#/components/schemas/AgentBreakdownItem'
          type: array
          title: Agents
          default: []
      type: object
      required:
        - time_range
        - summary
        - trend
        - vendors
      title: AgentAnalyticsResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AgentSummaryCard:
      properties:
        total_visits:
          type: integer
          title: Total Visits
        unique_agents:
          type: integer
          title: Unique Agents
        unique_pages:
          type: integer
          title: Unique Pages
        top_agents:
          items:
            $ref: '#/components/schemas/AgentBreakdownItem'
          type: array
          title: Top Agents
          default: []
        total_visits_delta:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total Visits Delta
      type: object
      required:
        - total_visits
        - unique_agents
        - unique_pages
      title: AgentSummaryCard
    AgentTrendPoint:
      properties:
        date:
          type: string
          title: Date
        visits:
          type: integer
          title: Visits
        agents:
          additionalProperties:
            type: integer
          type: object
          title: Agents
          default: {}
        vendors:
          additionalProperties:
            type: integer
          type: object
          title: Vendors
          default: {}
        categories:
          additionalProperties:
            type: integer
          type: object
          title: Categories
          default: {}
      type: object
      required:
        - date
        - visits
      title: AgentTrendPoint
    AgentVendorRow:
      properties:
        vendor:
          $ref: '#/components/schemas/AgentVendor'
        visits:
          type: integer
          title: Visits
        pages:
          type: integer
          title: Pages
          default: 0
        visits_delta:
          type: integer
          title: Visits Delta
          default: 0
      type: object
      required:
        - vendor
        - visits
      title: AgentVendorRow
    AgentCategoryRow:
      properties:
        category:
          $ref: '#/components/schemas/AgentCategory'
        visits:
          type: integer
          title: Visits
        visits_delta:
          type: integer
          title: Visits Delta
          default: 0
      type: object
      required:
        - category
        - visits
      title: AgentCategoryRow
    AgentBreakdownItem:
      properties:
        agent_key:
          type: string
          title: Agent Key
        agent_name:
          type: string
          title: Agent Name
        vendor:
          $ref: '#/components/schemas/AgentVendor'
        category:
          $ref: '#/components/schemas/AgentCategory'
          default: ai_crawler
        visits:
          type: integer
          title: Visits
      type: object
      required:
        - agent_key
        - agent_name
        - vendor
        - visits
      title: AgentBreakdownItem
    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
    AgentVendor:
      type: string
      enum:
        - openai
        - anthropic
        - perplexity
        - google
        - microsoft
        - xai
        - mistral
        - meta
        - amazon
        - apple
        - bytedance
        - alibaba
        - baidu
        - tencent
        - deepseek
        - moonshot
        - zhipu
        - huawei
        - yandex
        - cohere
        - duckduckgo
        - other
      title: AgentVendor
    AgentCategory:
      type: string
      enum:
        - ai_referral
        - ai_search
        - ai_training
        - ai_agent
        - ai_crawler
      title: AgentCategory
  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.