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

# Speech analysis overview for the workspace

**Required scope:** `speech.view`


## OpenAPI

````yaml /api-reference/openapi.json get /speech/overview
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers, WhatsApp and
    results in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /speech/overview:
    get:
      summary: Speech analysis overview for the workspace
      parameters:
        - schema:
            type: string
          required: false
          name: from
          in: query
        - schema:
            type: string
          required: false
          name: to
          in: query
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  totals:
                    type: object
                    properties:
                      analysed:
                        type: number
                      inFlight:
                        type: number
                      failed:
                        type: number
                      averageScore:
                        type: number
                        nullable: true
                      successRate:
                        type: number
                        nullable: true
                      averageDuration:
                        type: number
                        nullable: true
                      totalDuration:
                        type: number
                    required:
                      - analysed
                      - inFlight
                      - failed
                      - averageScore
                      - successRate
                      - averageDuration
                      - totalDuration
                  scoreDistribution:
                    type: array
                    items:
                      type: object
                      properties:
                        label:
                          type: string
                        from:
                          type: number
                        to:
                          type: number
                        count:
                          type: number
                      required:
                        - label
                        - from
                        - to
                        - count
                  outcomes:
                    type: array
                    items:
                      type: object
                      properties:
                        label:
                          type: string
                        count:
                          type: number
                        verdict:
                          type: string
                          enum:
                            - won
                            - lost
                            - not_applicable
                            - mixed
                      required:
                        - label
                        - count
                        - verdict
                  reps:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        analysed:
                          type: number
                        averageScore:
                          type: number
                          nullable: true
                        successRate:
                          type: number
                          nullable: true
                      required:
                        - id
                        - name
                        - analysed
                        - averageScore
                        - successRate
                  weakestSections:
                    type: array
                    items:
                      type: object
                      properties:
                        sectionId:
                          type: string
                        sectionName:
                          type: string
                        averagePercent:
                          type: number
                        sampleSize:
                          type: number
                      required:
                        - sectionId
                        - sectionName
                        - averagePercent
                        - sampleSize
                  funnel:
                    type: array
                    items:
                      type: object
                      properties:
                        label:
                          type: string
                        count:
                          type: number
                        pct:
                          type: number
                      required:
                        - label
                        - count
                        - pct
                  talkTime:
                    type: object
                    properties:
                      avgTalkRatio:
                        type: number
                        nullable: true
                      avgSilenceRatio:
                        type: number
                        nullable: true
                      avgWordsPerMinute:
                        type: number
                        nullable: true
                      measured:
                        type: number
                    required:
                      - avgTalkRatio
                      - avgSilenceRatio
                      - avgWordsPerMinute
                      - measured
                required:
                  - totals
                  - scoreDistribution
                  - outcomes
                  - reps
                  - weakestSections
                  - funnel
                  - talkTime
        '400':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.

            - `invalid_body`: The request body (or query) failed validation.
            Details are in `issues` (or `detail`). `422` on `POST
            /v1/campaigns/{campaignId}/leads`.
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '403':
          description: >-
            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '413':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '429':
          description: '- `rate_limited`: Too many requests.'
        '500':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '502':
          description: >-
            - `provider_error`: The calling service rejected the request
            (`upstreamStatus` 4xx) or was unavailable (5xx).
        '503':
          description: '- `database_unavailable`: The service is temporarily unavailable.'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

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