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

# Get available scorecard metrics

> Get available scorecard metrics for an organization, conversation type, organization group, or all metrics (Siro admin only).The user must have appropriate access to the requested scope.



## OpenAPI

````yaml specs/openapi-internalApi.json get /v1/core/scorecards/scorecard-metrics/available
openapi: 3.0.0
info:
  version: 1.0.0
  title: Swagger API
servers:
  - url: https://api.siro.ai/
    description: Siro API Gateway
security: []
externalDocs:
  description: View the raw OpenAPI Specification in JSON format
  url: /swagger.json
paths:
  /v1/core/scorecards/scorecard-metrics/available:
    get:
      summary: Get available scorecard metrics
      description: >-
        Get available scorecard metrics for an organization, conversation type,
        organization group, or all metrics (Siro admin only).The user must have
        appropriate access to the requested scope.
      parameters:
        - schema:
            type: string
          required: false
          name: requestedOrganizationId
          in: query
        - schema:
            type: string
          required: false
          name: conversationTypeId
          in: query
        - schema:
            type: string
          required: false
          name: requestedOrganizationGroupId
          in: query
        - schema:
            type: boolean
            nullable: true
          required: false
          name: getAllMetrics
          in: query
      responses:
        '200':
          description: Get available scorecard metrics
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      scorecardMetrics:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Unique identifier for the metric configuration
                              example: metric_001
                            name:
                              type: string
                              description: Display name for the metric
                              example: Conversation Time
                            description:
                              type: string
                              description: Optional description of what the metric measures
                              example: Total duration of the conversation in seconds
                            unit:
                              type: string
                              description: Full unit name (e.g., "seconds", "percentage")
                              example: seconds
                            unitAbbreviated:
                              type: string
                              description: Abbreviated unit name (e.g., "sec", "%")
                              example: sec
                            metricType:
                              type: string
                              enum:
                                - RECORDING_COUNT
                                - BOOKMARK
                                - CONVERSATION_TIME
                                - REP_SPEAKING_TIME
                                - CUSTOMER_SPEAKING_TIME
                                - CUSTOMER_QUESTIONS_COUNT
                                - REP_QUESTIONS_COUNT
                                - EXCHANGES_COUNT
                                - REP_EXCHANGES_COUNT
                                - TOTAL_REP_EXCHANGES_WITH_A_QUESTION
                                - REP_WORD_COUNT
                                - REP_UNIQUE_WORDS_USED_COUNT
                                - REP_FILLER_WORDS_COUNT
                                - TOTAL_REP_VOCABULARY_SCORE
                                - TOTAL_REP_WORD_OBSCURITY_SCORE
                                - LONGEST_MONOLOGUE_SECONDS
                                - LONGEST_CUSTOMER_STORY_SECONDS
                                - REP_WORDS_PER_MINUTE
                                - REP_FILLER_WORDS_PER_MIN
                                - REP_SPEAKER_SHARE
                                - INTERACTIVITY_SCORE
                                - REP_CONTROL
                                - REP_VOCABULARY_LEVEL
                                - REP_WORD_OBSCURITY_SCORE
                                - AI_METRIC
                              description: The type of metric being configured
                              example: CONVERSATION_TIME
                            llmPrompt:
                              type: string
                              description: >-
                                Optional LLM prompt for AI-generated metrics.
                                When the prompt has been edited via PATCH
                                /scorecards/scorecard-metrics/{id}, each edit is
                                stored as a new prompt version; the value
                                returned here is the most recently created
                                version (the active prompt).
                              example: >-
                                Analyze the conversation duration and provide
                                insights
                          required:
                            - id
                            - name
                            - unit
                            - unitAbbreviated
                            - metricType
                          description: Configuration for a scorecard metric
                    required:
                      - scorecardMetrics
                  cursor:
                    anyOf:
                      - type: string
                      - type: number
                      - nullable: true
                  pageSize:
                    type: number
                  limit:
                    type: number
                  total:
                    type: number
                    nullable: true
                  hasNextPage:
                    type: boolean
                required:
                  - data
        '400':
          description: Bad Request - Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error message
                required:
                  - error
        '401':
          description: Unauthorized - User not authenticated
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Authentication error message
                required:
                  - error
        '403':
          description: Forbidden - User does not have access
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Authorization error message
                required:
                  - error
        '404':
          description: Not Found - Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Resource not found error message
                required:
                  - error
        '422':
          description: Unprocessable Content - The request failed validation checks
          content:
            application/json:
              schema:
                type: object
                properties:
                  issues:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                        expected:
                          type: string
                        received:
                          type: string
                        path:
                          type: array
                          items:
                            anyOf:
                              - type: string
                              - type: number
                        message:
                          type: string
                      required:
                        - code
                        - path
                        - message
                  name:
                    type: string
                    enum:
                      - ZodError
                required:
                  - issues
                  - name
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Internal server error message
                required:
                  - error
      security:
        - SiroAuthToken: []
components:
  securitySchemes:
    SiroAuthToken:
      type: apiKey
      in: header
      name: x-siro-auth-token
      description: >-
        OAuth access token for user-scoped requests (Authorization Code or
        machine-to-machine). Send header `x-siro-auth-token:
        <oauth-access-token>`. Not an organization API key.
      x-default: <oauth-access-token>

````