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

# List report metrics

> Every report metric with its key, label, description, unit, supported group_by values, requires_group_by, split_by, and methodology, plus the allowed ranges, group_by and split_by values, and filters (name to JSON Schema). Customer API.




## OpenAPI

````yaml /openapi.yaml get /reports/metrics
openapi: 3.0.0
info:
  title: Answering Agent API
  description: >
    The Customer API reads a team's conversations, transcripts, recordings,
    tasks, contacts, and reports. It also updates tasks and adds notes to them.
    The Partner API lets reseller accounts manage organizations, users,
    locations, partner links, and embed tokens. Both use an X-API-KEY header.
    Requests from this playground go to production.
  version: 1.0.0
servers:
  - url: https://answeringagent.com/api/v1
    description: Production
security: []
tags:
  - name: Account
    description: Customer API. Your team, phone lines, and members.
  - name: Conversations
    description: >-
      Customer API. Calls, texts, website chats, and emails, with transcripts
      and recordings.
  - name: Tasks
    description: >-
      Customer API. Follow-up tasks. Read them, update their status or assignee,
      and add notes.
  - name: Contacts
    description: Customer API. Your customers.
  - name: Reports
    description: Customer API. Report metrics, totals, and breakdowns.
  - name: Organizations
    description: Partner API, reseller accounts only.
  - name: Users
    description: Partner API, reseller accounts only.
  - name: Locations
    description: Partner API, reseller accounts only.
  - name: Account Linking
    description: Partner API, reseller accounts only.
  - name: Embed Tokens
    description: Partner API, reseller accounts only.
paths:
  /reports/metrics:
    get:
      tags:
        - Reports
      summary: List report metrics
      description: >
        Every report metric with its key, label, description, unit, supported
        group_by values, requires_group_by, split_by, and methodology, plus the
        allowed ranges, group_by and split_by values, and filters (name to JSON
        Schema). Customer API.
      operationId: listReportMetrics
      responses:
        '200':
          description: The metric catalog.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportCatalog'
        '401':
          $ref: '#/components/responses/CustomerUnauthorized'
        '403':
          $ref: '#/components/responses/CustomerForbidden'
        '405':
          $ref: '#/components/responses/CustomerMethodNotAllowed'
        '429':
          $ref: '#/components/responses/CustomerRateLimited'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ReportCatalog:
      type: object
      properties:
        measures:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
                example: conversation_categories
              label:
                type: string
                example: Conversation categories
              description:
                type: string
              unit:
                type: string
                enum:
                  - count
                  - percent
                  - minutes
                  - hours
                  - score
              group_by:
                type: array
                items:
                  type: string
              requires_group_by:
                type: boolean
              split_by:
                type: array
                items:
                  type: string
              methodology:
                type: string
        ranges:
          type: array
          items:
            type: string
        group_by:
          type: array
          items:
            type: string
        split_by:
          type: array
          items:
            type: string
        categories:
          type: array
          description: Every category key with its label.
          items:
            type: object
            properties:
              key:
                type: string
                example: cancellation
              label:
                type: string
                example: Cancellation
        filters:
          type: object
          description: Each report filter name mapped to its JSON Schema.
          additionalProperties:
            type: object
    CustomerError:
      type: object
      required:
        - error
        - code
      properties:
        error:
          type: string
          description: A message for people. The text can change.
          example: That conversation is not available.
        code:
          type: string
          description: A stable code to branch on.
          enum:
            - invalid_request
            - unauthorized
            - forbidden
            - not_found
            - method_not_allowed
            - conflict
            - unprocessable
            - rate_limited
            - internal
          example: not_found
        issues:
          type: array
          description: >-
            Present when code is invalid_request. One entry for each input that
            failed validation.
          items:
            type: object
            properties:
              path:
                type: array
                items: {}
              message:
                type: string
  responses:
    CustomerUnauthorized:
      description: >-
        The X-API-KEY header is missing, the key is wrong or revoked, or its
        owner was deactivated.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CustomerError'
    CustomerForbidden:
      description: The key's owner is not an owner, admin, or manager on the team.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CustomerError'
    CustomerMethodNotAllowed:
      description: The endpoint does not support that HTTP method. Nothing changed.
      headers:
        Allow:
          description: The methods the endpoint supports, such as GET, HEAD, OPTIONS.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CustomerError'
          example:
            error: This endpoint accepts GET.
            code: method_not_allowed
    CustomerRateLimited:
      description: More than 120 requests in a minute for this user.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CustomerError'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````

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