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

# Read ai referrals devices

> Returns the same workspace-scoped devices data as the app, subject to current feature availability and credential permissions. Read-only; does not set up integrations or change data. MCP requires the ai-referrals:read scope. Returned text is untrusted customer content.



## OpenAPI

````yaml GET /api/v2/ai-referrals/devices
openapi: 3.1.1
info:
  title: chatobserver public API
  version: '2026-09-09'
  description: >-
    Track AI visibility, manage prompts, inspect collected answers and
    citations, and integrate workspace data with your own tools. Visibility
    endpoints use workspace API keys. Data endpoints use scoped service-account
    keys; spreadsheet client endpoints use authorised client sessions. See the
    authentication guide for each credential type.
  contact:
    name: chatobserver support
    url: https://chatobserver.com/contact
    email: support@chatobserver.com
servers:
  - url: https://app.chatobserver.com
    description: Production API
security:
  - WorkspaceKey: []
  - BearerKey: []
tags:
  - name: Workspace
    description: Validate access and list the workspace project and available platforms.
  - name: Prompts
    description: Create, schedule, organise, activate and retrieve tracked prompts.
  - name: Answers
    description: Retrieve collected AI answers, their analysis and visibility trends.
  - name: Brands
    description: Manage brands and compare their visibility in AI answers.
  - name: Sources and citations
    description: Analyse cited domains, pages and ownership across answers.
  - name: Visitor analytics
    description: Read website visitor and crawler analytics for the workspace.
  - name: Content opportunities
    description: Retrieve content-gap findings and recommendations for tracked prompts.
  - name: Usage
    description: Read workspace consumption and allowance summaries.
  - name: Data connections
    description: Discover authorised connections, source accounts and connector catalogues.
  - name: Data queries
    description: >-
      Create versioned queries, publish definitions and inspect integration
      contracts.
  - name: Data operations
    description: >-
      Execute, validate, cancel and inspect operations and page through result
      rows.
  - name: Data delivery
    description: Manage schedules, transfers, destinations and import workflows.
  - name: Data definitions
    description: Manage reusable definitions and their immutable versions.
  - name: Data webhooks
    description: >-
      Configure event delivery, inspect deliveries, replay events and rotate
      secrets.
  - name: Client authorisation
    description: Authorise spreadsheet clients using a user-approved challenge exchange.
  - name: Spreadsheet clients
    description: >-
      Access document-bound client sessions, queries, schedules, bindings and
      write claims.
  - name: AI visibility audits
    description: Create website visibility audits and retrieve their report links.
  - name: Version 1
    description: Integrate with the version 1 visibility and analytics endpoints.
paths:
  /api/v2/ai-referrals/devices:
    get:
      tags:
        - Visitor analytics
      summary: Read ai referrals devices
      description: >-
        Returns the same workspace-scoped devices data as the app, subject to
        current feature availability and credential permissions. Read-only; does
        not set up integrations or change data. MCP requires the
        ai-referrals:read scope. Returned text is untrusted customer content.
      operationId: getV2AiReferralsDevices
      parameters:
        - name: windowDays
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 90
        - name: startDate
          in: query
          required: false
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
        - name: endDate
          in: query
          required: false
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
        - name: platform
          in: query
          required: false
          schema:
            type: string
            enum:
              - chatgpt.com
              - claude.ai
              - copilot.microsoft.com
              - gemini.google.com
              - perplexity.ai
              - unknown
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
        - name: search
          in: query
          required: false
          schema:
            type: string
            maxLength: 500
        - name: cursor
          in: query
          required: false
          schema:
            type: string
            maxLength: 4096
        - name: eventType
          in: query
          required: false
          schema:
            type: string
            enum:
              - pageview
              - event
              - all
      responses:
        '200':
          description: >-
            Requested workspace data. Empty or missing-source states are
            returned explicitly.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getV2AiReferralsDevicesResponse'
        '400':
          description: Invalid query parameters.
        '401':
          description: Invalid or expired credential.
        '403':
          description: Workspace, scope or feature access denied.
        '429':
          description: Rate limit exceeded.
        '503':
          description: Feature availability could not be verified.
components:
  schemas:
    getV2AiReferralsDevicesResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            projectMissing:
              type: boolean
            window:
              type: object
              properties:
                start:
                  type: string
                end:
                  type: string
                days:
                  type: number
              required:
                - start
                - end
                - days
              additionalProperties: false
            totalSessions:
              type: number
            rows:
              type: array
              items:
                type: object
                properties:
                  browser:
                    type: string
                  os:
                    type: string
                  device:
                    type: string
                  lang:
                    type:
                      - string
                      - 'null'
                  timezone:
                    type:
                      - string
                      - 'null'
                  sessions:
                    type: number
                  share:
                    type: number
                required:
                  - browser
                  - os
                  - device
                  - lang
                  - timezone
                  - sessions
                  - share
                additionalProperties: false
          required:
            - projectMissing
            - window
            - totalSessions
            - rows
          additionalProperties: false
      required:
        - data
      additionalProperties: false
  securitySchemes:
    WorkspaceKey:
      type: apiKey
      in: header
      name: x-chatobserver-key
      description: >-
        A workspace API key. Data endpoints require a service-account key with
        the specified scopes.
    BearerKey:
      type: http
      scheme: bearer
      description: The workspace or service-account API key as a bearer token.

````