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

# Get Usage Report

> Retrieves detailed usage statistics for specified users or teams within a given time period. This endpoint helps track API consumption, feature usage, and user activity patterns.



## OpenAPI

````yaml /api-reference/openapi.json get /usageReport
openapi: 3.0.1
info:
  title: Attention Service V2
  description: Attention Service API V2
  termsOfService: https://www.attention.com/terms-of-use
  contact:
    name: Attention Team
    url: https://docs.attention.com/welcome
    email: support@attention.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.8.0
servers:
  - url: https://api.attention.tech/v2
security:
  - APIKeyHeader: []
paths:
  /usageReport:
    get:
      tags:
        - Tool
        - UsageReport
      summary: Get Usage Report
      description: >-
        Retrieves detailed usage statistics for specified users or teams within
        a given time period. This endpoint helps track API consumption, feature
        usage, and user activity patterns.
      operationId: getUsageReport
      parameters:
        - name: user-uuids
          in: query
          description: List of user UUIDs to include in the report
          style: form
          explode: false
          schema:
            type: array
            items:
              type: string
        - name: team-uuids
          in: query
          description: List of team UUIDs to include in the report
          style: form
          explode: false
          schema:
            type: array
            items:
              type: string
        - name: startDate
          in: query
          description: Start date for the usage report period (inclusive)
          required: true
          schema:
            type: string
            format: date
        - name: endDate
          in: query
          description: End date for the usage report period (inclusive)
          required: true
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Usage report successfully generated with detailed statistics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageReportResponse'
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/UsageReportResponse'
        '401':
          description: Authentication failed - valid API key required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error occurred while generating the usage report
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    UsageReportResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/UsageReport'
      example:
        data:
          - user:
              uuid: user1-uuid
              email: user1@email.com
              firstName: FirstName1
              lastName: LastName1
              team:
                uuid: team-uuid
                name: TeamName
            metrics:
              coachingSessions: 0
              callsViewed: 0
              commentsLeft: 0
              snippetsCreated: 0
              gInsightsRan: 0
              conversationInsightsRan: 0
          - user:
              uuid: user2-uuid
              email: user2@email.com
              firstName: FirstName2
              lastName: LastName2
              team:
                uuid: team-uuid
                name: TeamName
            metrics:
              coachingSessions: 0
              callsViewed: 0
              commentsLeft: 0
              snippetsCreated: 0
              gInsightsRan: 0
              conversationInsightsRan: 0
    Error:
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for the error.
        status:
          type: string
          description: >-
            The HTTP status code applicable to this problem, expressed as a
            string value.
        code:
          type: string
          description: An application-specific error code, expressed as a string value.
        title:
          type: string
          description: A short, human-readable summary of the problem.
        detail:
          type: string
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
        source:
          type: object
          properties:
            pointer:
              type: string
            parameter:
              type: string
        meta:
          type: object
          properties: {}
      example:
        id: not_found_error
        status: '404'
        code: '404'
        title: Not Found Error
        detail: The requested resource was not found
        source:
          pointer: /data/attributes/id
    UsageReport:
      required:
        - metrics
        - user
      type: object
      properties:
        user:
          $ref: '#/components/schemas/UsageReportUser'
        metrics:
          $ref: '#/components/schemas/UsageReportMetrics'
      example:
        user:
          uuid: user-uuid-123
          email: jane@example.com
          firstName: Jane
          lastName: Smith
          team:
            uuid: team-uuid-456
            name: Sales Team
        metrics:
          callsViewed: 45
          coachingSessions: 12
          commentsLeft: 28
          conversationInsightsRan: 15
          gInsightsRan: 8
          snippetsCreated: 20
    UsageReportUser:
      type: object
      properties:
        uuid:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        team:
          $ref: '#/components/schemas/UsageReportTeam'
      example:
        uuid: user-uuid-123
        email: jane@example.com
        firstName: Jane
        lastName: Smith
        team:
          uuid: team-uuid-456
          name: Sales Team
    UsageReportMetrics:
      required:
        - callsViewed
        - coachingSessions
        - commentsLeft
        - conversationInsightsRan
        - gInsightsRan
        - snippetsCreated
      type: object
      properties:
        coachingSessions:
          type: integer
        callsViewed:
          type: integer
        commentsLeft:
          type: integer
        snippetsCreated:
          type: integer
        gInsightsRan:
          type: integer
        conversationInsightsRan:
          type: integer
        superAgentQueries:
          type: integer
        superAgentWebQueries:
          type: integer
        superAgentSlackQueries:
          type: integer
        superAgentSessions:
          type: integer
        superAgentWebSessions:
          type: integer
        superAgentSlackSessions:
          type: integer
      example:
        callsViewed: 45
        coachingSessions: 12
        commentsLeft: 28
        conversationInsightsRan: 15
        gInsightsRan: 8
        snippetsCreated: 20
    UsageReportTeam:
      type: object
      properties:
        uuid:
          type: string
        name:
          type: string
      example:
        uuid: team-uuid-456
        name: Sales Team
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      name: Authorization
      in: header

````