Skip to main content
POST
/
api
/
voice-analysis
JavaScript
import BrainbaseLabs from 'brainbase-labs';

const client = new BrainbaseLabs({
  apiKey: process.env['BRAINBASE_LABS_API_KEY'], // This is the default and can be omitted
});

const response = await client.voiceAnalysis.analyze();

console.log(response.breakdown);
{
  "summary": {
    "totalCalls": 123,
    "totalMinutes": 123,
    "totalTransfers": 123,
    "totalTransferMinutes": 123,
    "totalTransferEvents": 123,
    "totalTransferEventMinutes": 123,
    "averageCallDuration": 123
  },
  "breakdown": [
    {
      "period": "<string>",
      "periodStart": "2023-11-07T05:31:56Z",
      "periodEnd": "2023-11-07T05:31:56Z",
      "totalCalls": 123,
      "totalMinutes": 123,
      "totalTransfers": 123,
      "totalTransferMinutes": 123,
      "totalTransferEvents": 123,
      "totalTransferEventMinutes": 123,
      "deployments": [
        {
          "deploymentId": "<string>",
          "deploymentName": "<string>",
          "workerId": "<string>",
          "workerName": "<string>",
          "calls": 123,
          "minutes": 123,
          "transfers": 123,
          "transferMinutes": 123,
          "transferEvents": 123,
          "transferEventMinutes": 123,
          "averageCallDuration": 123
        }
      ]
    }
  ],
  "callDetails": [
    {
      "logId": "<string>",
      "deploymentId": "<string>",
      "deploymentName": "<string>",
      "workerId": "<string>",
      "workerName": "<string>",
      "startTime": "2023-11-07T05:31:56Z",
      "endTime": "2023-11-07T05:31:56Z",
      "duration": 123,
      "fromNumber": "<string>",
      "toNumber": "<string>",
      "direction": "<string>",
      "transfers": 123,
      "transferMinutes": 123,
      "transferEvents": 123,
      "transferEventMinutes": 123
    }
  ]
}

Authorizations

x-api-key
string
header
required

API key authentication

Body

application/json
startDate
string<date-time>

Start date for analysis (ISO 8601)

endDate
string<date-time>

End date for analysis (ISO 8601)

granularity
enum<string>
default:monthly

Time granularity for breakdown

Available options:
daily,
weekly,
monthly,
yearly
deploymentIds
string[]

Optional filter by deployment IDs

workerId
string

Optional filter by worker ID

includeTransfers
boolean
default:true

Include transfer analysis

includeCallDetails
boolean
default:false

Include detailed call logs in response

timezone
string
default:UTC

Timezone for date calculations

Response

Voice deployment analysis results

summary
object
breakdown
object[]
callDetails
object[]