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

# List AI agents that visited a brand report

> Per-agent breakdown of AI crawler traffic, busiest agent first. `category` says what the agent is doing — fetching a page for a user, building a search index, or collecting training data — which is usually more actionable than the engine alone.



## OpenAPI

````yaml https://data.otterly.ai/v1/openapi.json get /v1/reports/brand/{reportId}/agent-analytics/agents
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/agents:
    get:
      tags:
        - Brand Reports
      summary: List AI agents that visited a brand report
      description: >-
        Per-agent breakdown of AI crawler traffic, busiest agent first.
        `category` says what the agent is doing — fetching a page for a user,
        building a search index, or collecting training data — which is usually
        more actionable than the engine alone.
      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
        - schema:
            type: string
            maxLength: 200
            description: >-
              Optional. Case-insensitive substring match on the agent name, up
              to 200 characters. Matched literally — `%` and `_` are not
              wildcards.
          required: false
          description: >-
            Optional. Case-insensitive substring match on the agent name, up to
            200 characters. Matched literally — `%` and `_` are not wildcards.
          name: search
          in: query
        - schema:
            type: integer
            description: >-
              Optional. Zero-based offset for pagination; must be a multiple of
              `limit`. Defaults to 0.
          required: false
          description: >-
            Optional. Zero-based offset for pagination; must be a multiple of
            `limit`. Defaults to 0.
          name: offset
          in: query
        - schema:
            type: integer
            description: >-
              Optional. Maximum number of items to return, up to 100. Defaults
              to 25.
          required: false
          description: >-
            Optional. Maximum number of items to return, up to 100. Defaults to
            25.
          name: limit
          in: query
      responses:
        '200':
          description: A page of agents that visited the brand report.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiAgentAnalyticsAgentsList'
        '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:
    PublicApiAgentAnalyticsAgentsList:
      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).
        items:
          type: array
          items:
            $ref: '#/components/schemas/PublicApiAgentAnalyticsAgent'
        paging:
          $ref: '#/components/schemas/PublicApiOffsetPagingWithTotal'
      required:
        - availability
        - startDate
        - endDate
        - domains
        - items
        - paging
      example:
        availability: connected_with_data
        startDate: '2026-08-07'
        endDate: '2026-08-20'
        domains:
          - adidas.com
          - blog.adidas.com
        items:
          - agent: GPTBot
            engine: chatgpt
            category: AI Training / Data Scraper
            visits: 6104
          - agent: OAI-SearchBot
            engine: chatgpt
            category: Search Index
            visits: 2201
          - agent: Claude-User
            engine: claude
            category: On-Demand AI Fetcher
            visits: 1877
        paging:
          limit: 25
          offset: 0
          totalCount: 17
    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
    PublicApiAgentAnalyticsAgent:
      type: object
      properties:
        agent:
          type: string
          description: Crawler name as it identified itself, e.g. `GPTBot`.
        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
        category:
          type: string
          description: >-
            What the agent is doing: `On-Demand AI Fetcher` (fetches a page
            because a user asked), `Search Index` (builds a retrieval index),
            `AI Training / Data Scraper` (collects training data), or `Other`.
          example: On-Demand AI Fetcher
        visits:
          type: integer
          minimum: 0
      required:
        - agent
        - engine
        - category
        - visits
      example:
        agent: GPTBot
        engine: chatgpt
        category: AI Training / Data Scraper
        visits: 6104
    PublicApiOffsetPagingWithTotal:
      type: object
      properties:
        limit:
          type: integer
          minimum: 1
        offset:
          type: integer
          minimum: 0
        totalCount:
          type: integer
          minimum: 0
      required:
        - limit
        - offset
        - totalCount
      example:
        limit: 25
        offset: 0
        totalCount: 137
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Provide your API key as a Bearer token: `Authorization: Bearer
        YOUR_API_KEY`.

````