Skip to main content
POST
/
v2
/
Pearl
/
{pearlId}
/
Analytics
cURL
curl --request POST \
  --url https://api.nlpearl.ai/v2/Pearl/{pearlId}/Analytics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "from": "2023-11-07T05:31:56Z",
  "to": "2023-11-07T05:31:56Z"
}'
{
  "callsStatusOverview": {
    "totalCalls": 123,
    "totalLeads": 123,
    "needRetry": 123,
    "wrongCountryCode": 123,
    "needFollowUp": 123,
    "voiceMailLeft": 123,
    "successful": 123,
    "unsuccessful": 123,
    "wrongNumber": 123,
    "completed": 123,
    "unreachable": 123,
    "error": 123
  },
  "callsSentimentOverview": {
    "negative": 123,
    "slightlyNegative": 123,
    "neutral": 123,
    "slightlyPositive": 123,
    "positive": 123
  },
  "callsStatusTimeLine": [
    {
      "totalCalls": 123,
      "totalLeads": 123,
      "needRetry": 123,
      "wrongCountryCode": 123,
      "needFollowUp": 123,
      "voiceMailLeft": 123,
      "successful": 123,
      "unsuccessful": 123,
      "wrongNumber": 123,
      "completed": 123,
      "unreachable": 123,
      "error": 123,
      "date": "2023-11-07T05:31:56Z"
    }
  ],
  "callsAverageTimeLine": [
    {
      "date": "2023-11-07T05:31:56Z",
      "averageCallDuration": 123
    }
  ],
  "callsCostTimeLine": [
    {
      "date": "2023-11-07T05:31:56Z",
      "totalPrice": 123,
      "averageCostPerCall": 123
    }
  ],
  "callsPickupRateTimeLine": [
    {
      "date": "2023-11-07T05:31:56Z",
      "pickupRatePercentage": 123
    }
  ],
  "callsSuccessRateTimeLine": [
    {
      "date": "2023-11-07T05:31:56Z",
      "successRatePercentage": 123
    }
  ],
  "callLabelCount": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "<string>",
      "count": 123
    }
  ],
  "callEventsCounts": {
    "takeMessageCount": 123,
    "smsSentCount": 123,
    "callTransferredCount": 123,
    "calendarBookedCount": 123,
    "emailSentCount": 123
  },
  "callsByHourDayOfWeeks": [
    {
      "hourOfDay": 123,
      "dayOfWeek": 123,
      "count": 123
    }
  ],
  "callType": 123
}

Authorizations

Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Path Parameters

pearlId
string
required

Body

Represents a date range used to query analytics data.

from
string<date-time>

The start date of the query range (inclusive).

to
string<date-time>

The end date of the query range (inclusive).
Must not be more than 90 days after the From date.

Response

Returns an object containing the analytics data for the specified outbound campaign.

callsStatusOverview
object

Overview of call statuses (e.g. success, failed, no answer).

callsSentimentOverview
object

Overview of sentiment analysis results for the client during calls.

callsStatusTimeLine
object[] | null
callsAverageTimeLine
object[] | null
callsCostTimeLine
object[] | null
callsPickupRateTimeLine
object[] | null
callsSuccessRateTimeLine
object[] | null
callLabelCount
object[] | null
callEventsCounts
object

Summary of events that occurred during calls.

callsByHourDayOfWeeks
object[] | null
callType
integer

1 - Inbound

2 - Outbound