--- title: "Get Analytics" method: POST path: "/v1/Outbound/{outboundId}/Analytics" tags: ["Outbound"] --- # Get Analytics `POST /v1/Outbound/{outboundId}/Analytics` Retrieves analytics data for a specific outbound campaign within a given date range. ## Path parameters - `outboundId` string, required ## Request body - DateSearch — 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 `200` Returns an object containing the analytics data for the specified outbound campaign. - AnalyticsOutboundApi — Represents the analytics data for an outbound campaign. - `callsStatusOverview` CallsStatusAnalyticsOverview — Overview of call statuses (e.g. success, failed, no answer). - `totalCalls` integer — The total number of calls placed during the selected period. - `totalLeads` integer — The total number of distinct leads contacted during the selected period. - `needRetry` integer — The number of calls that ended needing a retry attempt. - `wrongCountryCode` integer — The number of calls that failed because of an incorrect country code. - `needFollowUp` integer — The number of calls that ended needing a follow-up contact. - `voiceMailLeft` integer — The number of calls where a voicemail was left. - `successful` integer — The number of calls with a successful outcome. - `unsuccessful` integer — The number of calls with an unsuccessful outcome. - `wrongNumber` integer — The number of calls dialed to an incorrect or invalid phone number. - `completed` integer — The number of calls marked as completed. - `unreachable` integer — The number of calls to an unreachable phone number. - `answeredCalls` integer - `error` integer — The number of calls that encountered a system or processing error. - `callsSentimentOverview` CallsSentimentOverview — Overview of sentiment analysis results for the client during calls. - `negative` integer — The number of calls with a negative sentiment. - `slightlyNegative` integer — The number of calls with a slightly negative sentiment. - `neutral` integer — The number of calls with a neutral sentiment. - `slightlyPositive` integer — The number of calls with a slightly positive sentiment. - `positive` integer — The number of calls with a positive sentiment. - `callsStatusTimeLine` CallsStatusTimeLine[], nullable — Timeline showing the distribution of call statuses over time. - `totalCalls` integer — The total number of calls placed during the selected period. - `totalLeads` integer — The total number of distinct leads contacted during the selected period. - `needRetry` integer — The number of calls that ended needing a retry attempt. - `wrongCountryCode` integer — The number of calls that failed because of an incorrect country code. - `needFollowUp` integer — The number of calls that ended needing a follow-up contact. - `voiceMailLeft` integer — The number of calls where a voicemail was left. - `successful` integer — The number of calls with a successful outcome. - `unsuccessful` integer — The number of calls with an unsuccessful outcome. - `wrongNumber` integer — The number of calls dialed to an incorrect or invalid phone number. - `completed` integer — The number of calls marked as completed. - `unreachable` integer — The number of calls to an unreachable phone number. - `answeredCalls` integer - `error` integer — The number of calls that encountered a system or processing error. - `date` string, date-time — The date this timeline entry corresponds to. - `callsAverageTimeLine` CallsAverageTimeLine[], nullable — Timeline showing average call durations over time. - `date` string, date-time — The date this timeline entry corresponds to. - `averageCallDuration` number, double — The average call duration on this date, in seconds. - `callsCostTimeLine` CallsCostTimeLine[], nullable — Timeline showing call costs over time. - `date` string, date-time — The date this timeline entry corresponds to. - `totalPrice` number, double — The total cost of all calls on this date. - `averageCostPerCall` number, double — The average cost per call on this date. - `callsPickupRateTimeLine` CallsPickupRateTimeLine[], nullable — Timeline showing pickup rate trends over time. - `date` string, date-time — The date this timeline entry corresponds to. - `pickupRatePercentage` number, double — The percentage of calls that were answered on this date (outbound only). - `callsSuccessRateTimeLine` CallsSuccessRateTimeLine[], nullable — Timeline showing success rate trends over time. - `date` string, date-time — The date this timeline entry corresponds to. - `successRatePercentage` number, double — The percentage of calls that were successful on this date. - `callLabelCount` CallLabelCount[], nullable — Count of labels applied to calls. - `id` string, nullable — The unique identifier of the label. - `name` string, nullable — The display name of the label. - `color` string, nullable — The color associated with the label. - `count` integer — The number of calls tagged with this label during the selected period. - `callEventsCounts` CallEventsCount — Summary of events that occurred during calls. - `takeMessageCount` integer — The number of calls where a message was taken. - `smsSentCount` integer — The number of calls where an SMS was sent. - `callTransferredCount` integer — The number of calls that were transferred. - `calendarBookedCount` integer — The number of calls where a calendar appointment was booked. - `emailSentCount` integer — The number of calls where an email was sent. - `callsByHourDayOfWeeks` CallsByHourDayOfWeek[], nullable — Breakdown of calls by hour and day of the week. - `hourOfDay` integer — The hour of the day (0-23) the calls were placed. - `dayOfWeek` integer — `0 - Sunday` `1 - Monday` `2 - Tuesday` `3 - Wednesday` `4 - Thursday` `5 - Friday` `6 - Saturday` - `count` integer — The number of calls placed during this hour-and-day slot. ## Other responses - `400` — The request was invalid. Possible causes include a missing or malformed outbound ID, or errors in the search parameters. --- [API](https://skmtc.net/nlpearl/apis/nlpearl-client-api.md) · [All operations](https://skmtc.net/nlpearl/apis/nlpearl-client-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nlpearl/nlpearl-client-api/versions/52d64fc5d6e9/schema)