Metrics API Overview
Metrics Data Overview
All metrics data is refreshed every 24 hours (UTC time).
outputType
Each metrics request requires a designated "outputType" (i.e. daily, monthly, or all-time), returning metrics associated with the specified timeframe.
Business Metrics
Metrics associated with the entire Business may be called, returning aggregated answer rate, decline rate, and call count data. See detailed response information in the Get Business Metrics API reference.
See sample Business metrics response object below:
{
"body": {
"businessMetricsSummaries": [
{
"businessId": "fb67b5c6-53e6-4e03-b775-d171289ebfbd",
"metrics": [
{
"answerRate": 0.34526357,
"declineRate": 0.12345,
"totalTreatedCalls": 123453
}
]
},
{
"businessId": "lb3bj1bf-53e6-4e03-b775-d171289ebfbd",
"metrics": [
{
"answerRate": 0.34526357,
"declineRate": 0.12345,
"totalTreatedCalls": 123453
}
]
}
]
},
"error": null
}
Business Unit Metrics
Metrics associated with the entire Business Unit can be called, returning aggregated answer rate, decline rate, and call count data. See detailed response information in the Get Business Unit Metrics API reference.
outputType
Each metrics request requires a designated "outputType" (i.e. daily, monthly, or all-time), returning metrics associated with the specified timeframe.
Sample Business Unit metrics response body below
{
"body": {
"businessUnitMetricsSummaries": [
{
"businessUnitId": "fb67b5c6-53e6-4e03-b775-d171289ebfbd",
"metrics": [
{
"answerRate": 0.34526357,
"declineRate": 0.12345,
"totalTreatedCalls": 123453
}
]
},
{
"businessUnitId": "lb3bj1bf-53e6-4e03-b775-d171289ebfbd",
"metrics": [
{
"answerRate": 0.34526357,
"declineRate": 0.12345,
"totalTreatedCalls": 123453
}
]
}
]
},
"error": null
}
Program Metrics
Metrics associated with a specified Program can be called, aggregated answer rate, decline rate, and call count data. See detailed response information in the Get Program Metrics API reference.
outputType
Each metrics request requires a designated "outputType" (i.e. daily, monthly, or all-time), returning metrics associated with the specified timeframe.
Sample Program metrics response body below
{
"body": {
"programMetricsSummaries": [
{
"programId": "fb67b5c6-53e6-4e03-b775-d171289ebfbd",
"metrics": [
{
"answerRate": 0.34526357,
"declineRate": 0.12345,
"totalTreatedCalls": 123453
}
]
},
{
"programId": "lb3bj1bf-53e6-4e03-b775-d171289ebfbd",
"metrics": [
{
"answerRate": 0.34526357,
"declineRate": 0.12345,
"totalTreatedCalls": 123453
}
]
}
]
},
"error": null
}
Phone Number Metrics
Metrics associated with a specified aNumber can be called to return and update information associated with it including aggregated answer rate, decline rate, and call count data. See detailed response information in the Get Phone Number Metrics API reference.
outputType
Each metrics request requires a designated "outputType" (i.e. daily, monthly, or all-time), returning metrics associated with the specified timeframe.
Sample Business Unit Phone Number metrics response body below
{
"body": {
"phoneNumberMetricsSummaries": [
{
"phoneNumber": "5015551234",
"metrics": [
{
"answerRate": 0.34526357,
"declineRate": 0.12345,
"totalTreatedCalls": 123453
}
]
},
{
"phoneNumber": "4798573238",
"metrics": [
{
"answerRate": 0.34526357,
"declineRate": 0.12345,
"totalTreatedCalls": 123453
}
]
}
]
},
"error": null
}
Updated over 1 year ago
