> ## 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 scorecard metrics values

> Get scorecard metrics values for an organization and conversation typewithin a specified time range and filter criteria. The user must have access to the requested organization.



## OpenAPI

````yaml specs/openapi-internalApi.json get /v1/core/scorecards/scorecard-metrics/values
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/values:
    get:
      summary: Get scorecard metrics values
      description: >-
        Get scorecard metrics values for an organization and conversation
        typewithin a specified time range and filter criteria. The user must
        have access to the requested organization.
      parameters:
        - schema:
            type: string
            description: ID of the organization to get metrics for
            example: org_123
          required: true
          description: ID of the organization to get metrics for
          name: requestedOrganizationId
          in: query
        - schema:
            type: string
            description: ID of the conversation type to filter by
            example: conv_type_456
          required: true
          description: ID of the conversation type to filter by
          name: conversationTypeId
          in: query
        - schema:
            type: string
            description: Start date for the metrics range (ISO 8601 format)
            example: '2024-01-01T00:00:00Z'
          required: true
          description: Start date for the metrics range (ISO 8601 format)
          name: startAt
          in: query
        - schema:
            type: string
            description: End date for the metrics range (ISO 8601 format)
            example: '2024-01-31T23:59:59Z'
          required: true
          description: End date for the metrics range (ISO 8601 format)
          name: endAt
          in: query
        - schema:
            anyOf:
              - type: array
                items:
                  type: string
                minItems: 1
              - type: string
                minLength: 1
            description: IDs to filter by (can be array or single string)
            example:
              - user_001
              - user_002
          required: true
          description: IDs to filter by (can be array or single string)
          name: filterByIds
          in: query
        - schema:
            anyOf:
              - type: array
                items:
                  type: string
                  enum:
                    - RECORDING
                    - USER
                    - TEAM
                    - ORGANIZATION
                  description: The entity type to filter scorecard metrics by
                  example: USER
                minItems: 1
              - type: string
                enum:
                  - RECORDING
                  - USER
                  - TEAM
                  - ORGANIZATION
                description: The entity type to filter scorecard metrics by
                example: USER
            description: Entity type to filter by (RECORDING, USER, TEAM, ORGANIZATION)
            example: USER
          required: true
          description: Entity type to filter by (RECORDING, USER, TEAM, ORGANIZATION)
          name: filterBy
          in: query
        - schema:
            anyOf:
              - type: array
                items:
                  type: string
                  enum:
                    - RECORDING
                    - USER
                    - TEAM
                    - ORGANIZATION
                  description: The entity type to filter scorecard metrics by
                  example: USER
                minItems: 1
              - type: string
                enum:
                  - RECORDING
                  - USER
                  - TEAM
                  - ORGANIZATION
                description: The entity type to filter scorecard metrics by
                example: USER
            description: Optional grouping for the metrics
            example: TEAM
          required: false
          description: Optional grouping for the metrics
          name: groupBy
          in: query
      responses:
        '200':
          description: Get scorecard metrics values
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      recordingsEvaluatedCount:
                        type: number
                        description: Number of recordings that were evaluated for metrics
                        example: 150
                      metricValues:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Unique identifier for the metric value
                              example: metric_value_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
                            value:
                              type: number
                              description: The calculated value for this metric
                              example: 1800
                            passRate:
                              type: number
                              description: >-
                                For speaker analytics metrics aggregated across
                                recordings: fraction of recordings that passed
                                (0–100). Used for pointsEarned; value remains
                                the raw average.
                            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
                              example: CONVERSATION_TIME
                          required:
                            - id
                            - name
                            - unit
                            - unitAbbreviated
                            - metricType
                          description: A calculated value for a specific metric
                        description: Array of calculated metric values
                      startAt:
                        type: string
                        description: Start date of the metrics range (ISO 8601 format)
                        example: '2024-01-01T00:00:00Z'
                      endAt:
                        type: string
                        description: End date of the metrics range (ISO 8601 format)
                        example: '2024-01-31T23:59:59Z'
                      filterByIds:
                        anyOf:
                          - type: array
                            items:
                              type: string
                            minItems: 1
                          - type: string
                            minLength: 1
                        description: IDs that were used for filtering
                        example:
                          - user_001
                          - user_002
                      filterBy:
                        anyOf:
                          - type: array
                            items:
                              type: string
                              enum:
                                - RECORDING
                                - USER
                                - TEAM
                                - ORGANIZATION
                              description: The entity type to filter scorecard metrics by
                              example: USER
                            minItems: 1
                          - type: string
                            enum:
                              - RECORDING
                              - USER
                              - TEAM
                              - ORGANIZATION
                            description: The entity type to filter scorecard metrics by
                            example: USER
                        description: Entity type that was used for filtering
                        example: USER
                    required:
                      - recordingsEvaluatedCount
                      - metricValues
                      - startAt
                      - endAt
                      - filterByIds
                      - filterBy
                    description: >-
                      Response containing scorecard metrics for the specified
                      time range and filters
                  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>

````