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

# Get AI agent traffic overview for a brand report

> Overview of AI crawler and agent traffic across the brand report's own domains: total visits, distinct pages visited, the busiest engine, per-engine totals, and a daily trend with each engine's share. Check `availability` before rendering — `not_connected` means no logs connector is set up and the metrics are `null`, not zero.



## OpenAPI

````yaml https://data.otterly.ai/v1/openapi.json get /v1/reports/brand/{reportId}/agent-analytics/stats
openapi: 3.0.0
info:
  title: Otterly Public API
  version: 1.0.0
servers:
  - url: https://data.otterly.ai
security: []
tags:
  - name: Engines
  - name: Workspaces
  - name: Tags
  - name: Prompts
  - name: Brand Reports
  - name: Audits
  - name: Accounts
paths:
  /v1/reports/brand/{reportId}/agent-analytics/stats:
    get:
      tags:
        - Brand Reports
      summary: Get AI agent traffic overview for a brand report
      description: >-
        Overview of AI crawler and agent traffic across the brand report's own
        domains: total visits, distinct pages visited, the busiest engine,
        per-engine totals, and a daily trend with each engine's share. Check
        `availability` before rendering — `not_connected` means no logs
        connector is set up and the metrics are `null`, not zero.
      parameters:
        - schema:
            type: string
            minLength: 1
            example: 01HX7K2YV9D3M8N0G6Q5R4S3T2
            description: Brand report identifier.
          required: true
          description: Brand report identifier.
          name: reportId
          in: path
        - schema:
            type: string
            description: >-
              Optional. Start of the window (inclusive), `YYYY-MM-DD`. Omit it
              to get the 13 days before `endDate`; omit both dates for the last
              14 days (UTC), matching the dashboard.
            example: '2026-08-07'
          required: false
          description: >-
            Optional. Start of the window (inclusive), `YYYY-MM-DD`. Omit it to
            get the 13 days before `endDate`; omit both dates for the last 14
            days (UTC), matching the dashboard.
          name: startDate
          in: query
        - schema:
            type: string
            description: >-
              Optional. End of the window (inclusive), `YYYY-MM-DD`. Defaults to
              today (UTC).
            example: '2026-08-20'
          required: false
          description: >-
            Optional. End of the window (inclusive), `YYYY-MM-DD`. Defaults to
            today (UTC).
          name: endDate
          in: query
        - schema:
            type: string
            enum:
              - chatgpt
              - claude
              - copilot
              - perplexity
              - google
              - other
            description: >-
              Optional. Restrict results to a single engine. Omit for all
              engines. Pass `other` to match every AI crawler outside the named
              engines.
            example: chatgpt
          required: false
          description: >-
            Optional. Restrict results to a single engine. Omit for all engines.
            Pass `other` to match every AI crawler outside the named engines.
          name: engine
          in: query
      responses:
        '200':
          description: Agent traffic overview for the brand report.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiAgentAnalyticsStats'
        '400':
          description: Validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiValidationErrorResponse'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
        '404':
          description: Report not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    PublicApiAgentAnalyticsStats:
      type: object
      properties:
        availability:
          type: string
          enum:
            - not_connected
            - connected_no_data
            - connected_with_data
          description: >-
            Whether these numbers can be trusted. `not_connected` means no logs
            connector is active for this report — metrics are `null`, NOT zero,
            because nothing is being measured. `connected_no_data` means a
            connector is active but matched no visits in this window, so the
            zeros are real. `connected_with_data` means the payload is
            populated.
          example: connected_with_data
        startDate:
          type: string
          description: Start of the resolved window (inclusive), `YYYY-MM-DD`.
        endDate:
          type: string
          description: End of the resolved window (inclusive), `YYYY-MM-DD`.
        domains:
          type: array
          items:
            type: string
          description: >-
            The report's own domains the query spanned — its main domain plus
            its domain variations. Normalized (lowercased, `www.` and port
            stripped).
        totalAgentVisits:
          type: integer
          nullable: true
          minimum: 0
          description: >-
            Total AI agent visits in the window. `null` when `availability` is
            `not_connected`.
        pagesVisited:
          type: integer
          nullable: true
          minimum: 0
          description: >-
            Distinct pages visited in the window. `null` when `availability` is
            `not_connected`.
        topEngine:
          type: string
          nullable: true
          enum:
            - chatgpt
            - claude
            - copilot
            - perplexity
            - google
            - other
            - null
          description: >-
            Engine with the most visits in the window; `null` when there were
            none.
          example: chatgpt
        engines:
          type: array
          items:
            type: object
            properties:
              engine:
                type: string
                enum:
                  - chatgpt
                  - claude
                  - copilot
                  - perplexity
                  - google
                  - other
                description: >-
                  AI engine an agent visit is attributed to. `other` covers
                  every AI crawler that is not one of the named engines (for
                  example Amazon, Meta, xAI, ByteDance, Common Crawl).
                example: chatgpt
              visits:
                type: integer
                minimum: 0
            required:
              - engine
              - visits
          description: >-
            Window totals per engine, highest first. Empty when there is no
            data.
        trend:
          type: array
          items:
            $ref: '#/components/schemas/PublicApiAgentAnalyticsTrendPoint'
          description: >-
            Per-(day, engine, bot) visit series for the window. `engine` is the
            folded public id (same vocabulary as `engines`/`topEngine`); `bot`
            is the raw crawler name, so one engine can span several bots on a
            day.
      required:
        - availability
        - startDate
        - endDate
        - domains
        - totalAgentVisits
        - pagesVisited
        - topEngine
        - engines
        - trend
      example:
        availability: connected_with_data
        startDate: '2026-08-07'
        endDate: '2026-08-20'
        domains:
          - adidas.com
          - blog.adidas.com
        totalAgentVisits: 15234
        pagesVisited: 412
        topEngine: chatgpt
        engines:
          - engine: chatgpt
            visits: 9418
          - engine: google
            visits: 3902
          - engine: perplexity
            visits: 1105
          - engine: other
            visits: 809
        trend:
          - dayId: '20260820'
            engine: chatgpt
            bot: GPTBot
            visitCount: 742
          - dayId: '20260820'
            engine: google
            bot: Google-Extended
            visitCount: 128
          - dayId: '20260820'
            engine: other
            bot: Amazonbot
            visitCount: 64
    PublicApiValidationErrorResponse:
      type: object
      properties:
        message:
          type: string
        target:
          type: string
        errors:
          type: array
          items:
            type: object
            properties:
              path:
                type: string
              message:
                type: string
              code:
                type: string
            required:
              - path
              - message
              - code
      required:
        - message
        - target
        - errors
      example:
        message: Validation failed
        target: query
        errors:
          - path: country
            message: Required
            code: invalid_type
    PublicApiErrorResponse:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      example:
        message: Report not found
    PublicApiAgentAnalyticsTrendPoint:
      type: object
      properties:
        dayId:
          type: string
          description: Day the visits fall on, `YYYYMMDD` (UTC).
          example: '20260822'
        engine:
          type: string
          enum:
            - chatgpt
            - claude
            - copilot
            - perplexity
            - google
            - other
          description: >-
            AI engine an agent visit is attributed to. `other` covers every AI
            crawler that is not one of the named engines (for example Amazon,
            Meta, xAI, ByteDance, Common Crawl).
          example: chatgpt
        bot:
          type: string
          description: Crawler name as it identified itself, e.g. `GPTBot`.
        visitCount:
          type: integer
          minimum: 0
      required:
        - dayId
        - engine
        - bot
        - visitCount
      example:
        dayId: '20260820'
        engine: chatgpt
        bot: GPTBot
        visitCount: 742
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Provide your API key as a Bearer token: `Authorization: Bearer
        YOUR_API_KEY`.

````