Prosper AI

Prosper AI Call Logs API

The Call Logs API from Prosper AI — 2 operation(s) for call logs.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.getprosperapp.com/introduction
📖
APIReference
https://docs.getprosperapp.com/api-reference/call-logs/list-call-logs
📖
Quickstart
https://docs.getprosperapp.com/quickstart/campaign-call
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/prosper-ai/refs/heads/main/authentication/prosper-ai-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/prosper-ai/refs/heads/main/openapi/prosper-ai-call-logs-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/prosper-ai/refs/heads/main/scopes/prosper-ai-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/prosper-ai/refs/heads/main/conventions/prosper-ai-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/prosper-ai/refs/heads/main/errors/prosper-ai-problem-types.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/prosper-ai/refs/heads/main/lifecycle/prosper-ai-lifecycle.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/prosper-ai/refs/heads/main/data-model/prosper-ai-data-model.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/prosper-ai/refs/heads/main/conformance/prosper-ai-conformance.yml

OpenAPI Specification

prosper-ai-call-logs-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Prosper Voice API Keys Call Logs API
  version: 1.0.0
tags:
- name: Call Logs
paths:
  /api/v1/call-logs:
    get:
      tags:
      - Call Logs
      summary: List Call Logs
      description: List all call logs for the organization with pagination and date filtering.
      operationId: list_call_logs_api_v1_call_logs_get
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: The page number to get.
          default: 0
          title: Page
        description: The page number to get.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: The number of call logs per page.
          default: 200
          title: Limit
        description: The number of call logs per page.
      - name: from_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          description: Filter logs from this date.
          title: From Date
        description: Filter logs from this date.
      - name: to_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          description: Filter logs until this date.
          title: To Date
        description: Filter logs until this date.
      - name: campaign_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter logs by campaign ID.
          title: Campaign Id
        description: Filter logs by campaign ID.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallLogExportPaginated'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/call-logs/{call_log_id}:
    get:
      tags:
      - Call Logs
      summary: Get Call Log
      description: Get detailed information for a specific call log.
      operationId: get_call_log_api_v1_call_logs__call_log_id__get
      parameters:
      - name: call_log_id
        in: path
        required: true
        schema:
          type: integer
          ge: 0
          le: 9223372036854775807
          description: The ID of the call log to get the information.
          title: Call Log Id
        description: The ID of the call log to get the information.
      - name: include_recordings
        in: query
        required: false
        schema:
          type: boolean
          description: Whether to include recordings.
          default: false
          title: Include Recordings
        description: Whether to include recordings.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallLogExportInformation'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CallLogExportInformation:
      properties:
        id:
          type: string
          title: Id
        to:
          type: string
          title: To
        from_:
          anyOf:
          - type: string
            const: DeprecatedLocalTest
          - type: string
          title: From
        created_at:
          type: string
          format: date-time
          title: Created At
        call_length:
          type: string
          title: Call Length
        call_ended_reason:
          type: string
          title: Call Ended Reason
        call_categorization:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Call Categorization
        recording_urls:
          items:
            anyOf:
            - type: string
            - type: 'null'
          type: array
          title: Recording Urls
        agent_data:
          additionalProperties: true
          type: object
          title: Agent Data
        campaign_target_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Campaign Target Id
        post_call_data:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Post Call Data
        qa:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Qa
        transcripts:
          items:
            additionalProperties:
              type: string
            type: object
          type: array
          title: Transcripts
      type: object
      required:
      - id
      - to
      - from_
      - created_at
      - call_length
      - call_ended_reason
      - call_categorization
      - recording_urls
      - agent_data
      - campaign_target_id
      - post_call_data
      - qa
      - transcripts
      title: CallLogExportInformation
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    CallLogListExportInformation:
      properties:
        id:
          type: string
          title: Id
        to:
          type: string
          title: To
        from_:
          anyOf:
          - type: string
            const: DeprecatedLocalTest
          - type: string
          title: From
        created_at:
          type: string
          format: date-time
          title: Created At
        call_length:
          type: string
          title: Call Length
        call_ended_reason:
          type: string
          title: Call Ended Reason
        call_categorization:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Call Categorization
        agent_data:
          additionalProperties: true
          type: object
          title: Agent Data
        campaign_target_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Campaign Target Id
        post_call_data:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Post Call Data
        qa:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Qa
        transcripts:
          items:
            additionalProperties:
              type: string
            type: object
          type: array
          title: Transcripts
      type: object
      required:
      - id
      - to
      - from_
      - created_at
      - call_length
      - call_ended_reason
      - call_categorization
      - agent_data
      - campaign_target_id
      - post_call_data
      - qa
      - transcripts
      title: CallLogListExportInformation
      description: Call log export information for list endpoint - includes full data except recordings
    CallLogExportPaginated:
      properties:
        call_logs:
          items:
            $ref: '#/components/schemas/CallLogListExportInformation'
          type: array
          title: Call Logs
        page_count:
          type: integer
          title: Page Count
        next_page:
          anyOf:
          - type: integer
          - type: 'null'
          title: Next Page
      type: object
      required:
      - call_logs
      - page_count
      - next_page
      title: CallLogExportPaginated