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

# Get key usage

> Reads only data authorized for the current organization credential and resource permission.



## OpenAPI

````yaml /app-api/openapi.json get /keys/{key_id}/usage
openapi: 3.1.0
info:
  title: Parlay App API
  version: '2026-10-23'
  description: >-
    Read and act on your organization's Parlay data from your own systems:
    calls, transcripts, scores, coaching, reps, teams, analytics, deals,
    playbooks, training, webhooks and exports. Authenticate with an organization
    API key.
servers:
  - url: https://app.goparlay.io/api/v1
security:
  - organizationKey: []
tags:
  - name: Account
    description: Who the key belongs to, what it can do, and the limits that apply.
  - name: Calls
    description: Call history, the change feed, scores, analysis and coaching.
  - name: Transcripts
    description: Transcript text, timed segments and transcript search.
  - name: Comments
    description: Timestamped coaching comments on calls.
  - name: Reps and teams
    description: Your organization, its reps and its teams.
  - name: Analytics
    description: Organization, team and rep performance over a reporting window.
  - name: Deals and CRM
    description: Deal outcomes, deals, accounts, contacts and pipeline stages.
  - name: Playbook
    description: Your playbook, scorecard and trackers.
  - name: Playlists
    description: Organization playlists of calls.
  - name: Training
    description: Courses, enrollments, progress and certificates.
  - name: Usage and audit
    description: Request usage and the organization audit trail.
paths:
  /keys/{key_id}/usage:
    get:
      tags:
        - Usage and audit
      summary: Get key usage
      description: >-
        Reads only data authorized for the current organization credential and
        resource permission.
      operationId: read_key_usage
      parameters:
        - name: since
          in: query
          required: false
          schema:
            description: ISO 8601 timestamp including a time-zone offset.
            type: string
            format: date-time
        - name: until
          in: query
          required: false
          schema:
            description: ISO 8601 timestamp including a time-zone offset.
            type: string
            format: date-time
        - name: key_id
          in: path
          required: true
          schema:
            type: string
            pattern: >-
              ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
      responses:
        '200':
          description: Successful scoped read.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      key_id:
                        anyOf:
                          - type: string
                            pattern: >-
                              ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
                            description: Stable Parlay UUID.
                          - type: 'null'
                      requests:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      succeeded:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      client_errors:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      server_errors:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      rate_limited:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      response_bytes:
                        type: number
                        minimum: 0
                      average_duration_ms:
                        anyOf:
                          - type: number
                          - type: 'null'
                        description: Available numeric measure; null when not measured.
                      p95_duration_ms:
                        anyOf:
                          - type: number
                          - type: 'null'
                        description: Available numeric measure; null when not measured.
                      daily:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                            requests:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            succeeded:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            response_bytes:
                              type: number
                          required:
                            - date
                            - requests
                            - succeeded
                            - response_bytes
                          additionalProperties: false
                      resources:
                        type: array
                        items:
                          type: object
                          properties:
                            resource:
                              type: string
                            requests:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            errors:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                          required:
                            - resource
                            - requests
                            - errors
                          additionalProperties: false
                      coverage:
                        type: string
                        const: authenticated_machine_http_requests
                      telemetry_guarantee:
                        type: string
                        const: best_effort
                      quota_basis:
                        type: string
                        const: authenticated_requests
                    required:
                      - key_id
                      - requests
                      - succeeded
                      - client_errors
                      - server_errors
                      - rate_limited
                      - response_bytes
                      - average_duration_ms
                      - p95_duration_ms
                      - daily
                      - resources
                      - coverage
                      - telemetry_guarantee
                      - quota_basis
                    additionalProperties: false
                  window:
                    type: object
                    properties:
                      since:
                        type: string
                      until:
                        type: string
                      timezone:
                        type: string
                        const: UTC
                    required:
                      - since
                      - until
                      - timezone
                    additionalProperties: false
                required:
                  - data
                  - window
                additionalProperties: false
        '400':
          description: Invalid query or cursor
        '401':
          description: Invalid or expired credential
        '403':
          description: Permission required
        '404':
          description: Resource unavailable or outside access
        '409':
          description: Source changed; restart pagination
        '429':
          description: Request budget exceeded
        '503':
          description: Service temporarily unavailable
components:
  securitySchemes:
    organizationKey:
      type: http
      scheme: bearer
      bearerFormat: pk_org_live_<id>_<secret>

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.