> ## 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 Scorecards Summary

> Retrieves detailed usage statistics for specified users or teams within a given time period.



## OpenAPI

````yaml /api-reference/openapi.json post /scorecards/summary
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:
  /scorecards/summary:
    post:
      tags:
        - Scorecard
      summary: Get Scorecards Summary
      description: >-
        Retrieves detailed usage statistics for specified users or teams within
        a given time period.
      operationId: getScorecardsSummary
      requestBody:
        description: Request containing the content to be analyzed and analysis parameters
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScorecardsSummaryRequest'
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ScorecardsSummaryRequest'
        required: true
      responses:
        '200':
          description: Scorecards summary successfully generated with detailed statistics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScorecardsSummaryResponse'
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ScorecardsSummaryResponse'
        '400':
          description: Bad request - invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Error'
        '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:
    ScorecardsSummaryRequest:
      required:
        - fromDateTime
        - scorecardUUID
        - scorecardsItemsUUIDs
        - teamUUIDs
        - toDateTime
        - userUUIDs
      type: object
      properties:
        fromDateTime:
          type: string
          description: Start date and time for filtering scorecards (ISO 8601 format)
          format: date-time
        toDateTime:
          type: string
          description: End date and time for filtering scorecards (ISO 8601 format)
          format: date-time
        scorecardsItemsUUIDs:
          type: array
          items:
            type: string
        scorecardUUID:
          type: string
        teamUUIDs:
          type: array
          items:
            type: string
        userUUIDs:
          type: array
          items:
            type: string
      example:
        scorecardUUID: sc-uuid-123
        fromDateTime: '2024-01-01T00:00:00Z'
        toDateTime: '2024-03-31T23:59:59Z'
        teamUUIDs:
          - team-uuid-1
          - team-uuid-2
        userUUIDs:
          - user-uuid-1
          - user-uuid-2
        scorecardsItemsUUIDs:
          - si-uuid-1
          - si-uuid-2
    ScorecardsSummaryResponse:
      required:
        - data
      type: object
      properties:
        data:
          type: array
          description: Array of resources matching the query
          items:
            $ref: '#/components/schemas/ScorecardsSummaryItem'
      example:
        data:
          - userName: Jane Smith
            teamName: Sales Team
            overallScoreTotals: 85.5
            metricsCount: 12
            min: 65
            max: 98
            itemAverageTotals:
              - scorecardItemUUID: si-uuid-1
                title: Discovery Quality
                average: 88
            metrics: []
    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
    ScorecardsSummaryItem:
      required:
        - itemAverageTotals
        - max
        - metrics
        - metricsCount
        - min
        - overallScoreTotals
        - teamName
        - userName
      type: object
      properties:
        overallScoreTotals:
          type: number
        min:
          type: number
        userName:
          type: string
        teamName:
          type: string
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/ScorecardsSummaryMetricItem'
        max:
          type: number
        itemAverageTotals:
          type: array
          items:
            $ref: '#/components/schemas/ScorecardsSummaryItemAverage'
        metricsCount:
          type: number
      example:
        userName: Jane Smith
        teamName: Sales Team
        overallScoreTotals: 85.5
        metricsCount: 12
        min: 65
        max: 98
        itemAverageTotals:
          - scorecardItemUUID: si-uuid-1
            title: Discovery Quality
            average: 88
        metrics:
          - date: '2024-03-15T10:30:00Z'
            overallScore: 88
            entityInfo:
              uuid: entity-uuid-1
              title: Pipeline Review
            itemAverages:
              - scorecardItemUUID: si-uuid-1
                title: Discovery Quality
                average: 90
    ScorecardsSummaryMetricItem:
      required:
        - date
        - entityInfo
        - itemAverages
        - overallScore
      type: object
      properties:
        overallScore:
          type: number
        itemAverages:
          type: array
          items:
            $ref: '#/components/schemas/ScorecardsSummaryItemAverage'
        date:
          type: string
          format: date-time
        entityInfo:
          required:
            - title
            - uuid
          type: object
          properties:
            uuid:
              type: string
            title:
              type: string
        conversationInfo:
          required:
            - startedAt
            - teamUUID
            - title
            - userUUID
            - uuid
          type: object
          properties:
            teamUUID:
              type: string
            userUUID:
              type: string
            startedAt:
              type: string
              format: date-time
            uuid:
              type: string
            title:
              type: string
      example:
        date: '2024-03-15T10:30:00Z'
        overallScore: 88
        entityInfo:
          uuid: entity-uuid-123
          title: Enterprise Deal Review
        conversationInfo:
          uuid: conv-uuid-123
          title: Q1 Pipeline Review
          teamUUID: team-uuid-456
          userUUID: user-uuid-789
          startedAt: '2024-03-15T10:00:00Z'
        itemAverages:
          - scorecardItemUUID: si-uuid-1
            title: Discovery Quality
            average: 90
    ScorecardsSummaryItemAverage:
      required:
        - average
        - scorecardItemUUID
        - title
      type: object
      properties:
        title:
          type: string
        scorecardItemUUID:
          type: string
        average:
          type: number
        description:
          type: string
        evidence:
          type: array
          items:
            type: object
            properties:
              quote:
                type: string
              start_sec:
                type: number
              end_sec:
                type: number
              link:
                type: string
                description: Deep link to the conversation at the evidence timestamp
          x-omitempty: true
      example:
        scorecardItemUUID: si-uuid-123
        title: Discovery Quality
        average: 87.5
        description: Great opening with warm greeting
        evidence:
          - quote: Thank you for calling, how can I help you today?
            start_sec: 33
            end_sec: 45.5
            link: >-
              https://app.attention.tech/conversations/all-calls/conv-uuid-123?videoStartTime=33&videoEndTime=45
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      name: Authorization
      in: header

````