Acquire
API integration

list_all_acquire_cases

List Acquire cases with optional condition-based filtering and relation expansion. Returns: id, channel, contact, threadId, dateCreated, dateUpdated, contactId, closedBy, visitId, messageSeen, title, description, status, closingState, dateQueue, datePending, dateActive, dateClosed, queueId, queueOrder, meta, parentId, userId, waitTime, cases, users, lastMessage, fields, isCaseJoined, timelineId,…

get_single_acquire_case_by_id

Get a single Acquire case by id. Returns: id, channel, contact, threadId, dateCreated, dateUpdated, status, meta, parentId. Required: id.

create_a_acquire_case

Create a new Acquire chat case for a contact. Returns the created case including id, channel, status, contact, threadId, title, dateCreated, and visitId. Required: contactId.

acquire_cases_close

Close a case in Acquire by providing its case ID. Returns: 0, foreverClosed, leftUser, caseId, contactId, userId, userType. Required: caseId.

acquire_cases_invite_agent

Invite agents or departments to a case chat in Acquire. Returns: userId, online, sent. Required: caseId. At least one of agentIds or department must be provided.

list_all_acquire_messages

List conversation messages in Acquire filtered by thread and contact. Returns: dateCreated, dateUpdated, id, channel, parentId, caseId, senderId, senderType, message, seen, meta, sender, type. Required: threadId, contactId.

get_single_acquire_message_by_id

Get a single message in Acquire by id. Returns: id, caseId, channel, senderId, senderType, type, message, dateCreated, dateUpdated, seen, meta, sender. Required: id.

create_a_acquire_message

Send a chat message to an active conversation in Acquire. Returns the created message with id, caseId, channel, type, message, sender, dateCreated, and the associated case. Required: contactId, caseId, and a message object with type and message. Only active cases may receive messages via the API.

acquire_messages_create_mail

Send an email message in Acquire. Returns the created mail message with id, caseId, subject, htmlBody, dateCreated, and sender details. Required: data. The To address must be an inbox connected to Acquire.

acquire_messages_create_sms

Send an SMS message in Acquire. Returns the sent SMS with id, threadId, timelineId, contactId, Body, From, To, message, and msgType. A phone number must be connected to your Acquire account. Find threadId and timelineId via the messages list endpoint.

update_a_acquire_message_by_id

Update a message in an Acquire conversation. Returns the updated message object including id, channel, message, type, dateCreated, dateUpdated, seen, sender, case, caseId, and threadId. Required: id, message (object with type and message).

delete_a_acquire_message_by_id

Delete a message in Acquire by id. Returns: deleted. Required: id. This action cannot be undone.

create_a_acquire_snooze

Create a snooze in Acquire. Returns: success, message, data, fields, dateCreated, dateUpdated, id. Required: scheduleDate and objectType; at least one of caseId or contactId must be provided.

delete_a_acquire_snooze_by_id

Delete a specific snooze in Acquire by id. Returns: success, message. Required: id. Snoozes may only be deleted by the agent who created them; this action cannot be undone.

list_all_acquire_notes

List notes attached to a contact in Acquire. Returns: id, contactId, userId, type, title, description, dateCreated, users, lastMessage. Required: contact_id.

get_single_acquire_note_by_id

Get a single note by id in Acquire. Returns: id, contactId, userId, type, title, description, dateCreated, users, lastMessage. Required: id.

create_a_acquire_note

Create a note for a contact in Acquire. Returns the created note including id, contactId, userId, type, title, description, dateCreated, users, and lastMessage. Required: contactId, type.

acquire_notes_add_message

Add a message to an existing note in Acquire. Returns the created message object including its id, message text, type, dateCreated, and nested note and user objects. Required: type, contact_id, note_id.

delete_a_acquire_note_by_id

Delete a note in Acquire by id. Returns: success, message. Required: id. This action cannot be undone.

acquire_notes_list_messages

List messages for a specific note in Acquire. Returns each message with its id, noteId, type, message text, dateCreated, and the associated user object. Required: noteId.

list_all_acquire_contacts

List all contacts in Acquire from the platform's Contact List. Returns: id, dateCreated, dateUpdated, archive, clientType, clientName, clientVersion, clientOsName, clientOsVersion, clientDeviceType, clientDeviceVendor, clientDeviceModel, clientDetails, fields, company, tags, latestTimelineId, caseId, latestObjectType, title, description, channel, status, agentList, departmentList, lastViewObject,…

acquire_contacts_search

Search Acquire contacts by keyword. Returns: id, meta, object, type. Required: search. This endpoint is in beta and some features may not work as documented.

get_single_acquire_contact_by_id

Get a single Acquire contact by id. Returns: id, dateCreated, dateUpdated, archive, clientType, clientName, clientVersion, clientOsName, clientOsVersion, clientDeviceType, clientDeviceVendor, clientDeviceModel, clientDetails, companyId, fields, company, cases, tags, latestTimelineId, caseId, latestObjectType, title, description, channel, status, agentList, departmentList, lastViewObject,…

create_a_acquire_contact

Create a new contact in Acquire with attributes such as name, email, phone, and city. Custom attribute keys may be included in the fields object. Returns: id, dateCreated, dateUpdated, clientType, clientName, clientVersion, clientOsName, clientOsVersion, clientDeviceType, clientDeviceVendor, clientDeviceModel, clientDetails, archive, companyId, fields.

acquire_contacts_block

Block one or more contacts in Acquire by their contact IDs until a specified expiration date. Returns true on success. Required: data, type, blockTill.

acquire_contacts_merge

Merge two or more contacts in Acquire by combining secondary contacts (sourceIds) onto a primary contact identified by merge_id. Returns: id, message. Required: merge_id, sourceIds. Merges cannot be reverted.

update_a_acquire_contact_by_id

Update data for a single contact in Acquire. Returns the updated contact object including id, dateCreated, dateUpdated, clientType, fields, and archive. Required: id.

delete_a_acquire_contact_by_id

Delete a contact in Acquire by id. Returns: deleted. Required: id. This action cannot be undone.

list_all_acquire_companies

List companies in Acquire with optional filtering, field selection, and relation expansion. Returns: id, dateCreated, dateUpdated, fields, contacts, parent, companies.

get_single_acquire_company_by_id

Get a single Acquire company by id with optional field selection and relation expansion. Returns: id, dateCreated, dateUpdated, fields, contacts. Required: id.

create_a_acquire_company

Create a new company in Acquire. Returns: id, dateCreated, dateUpdated, fields. Required: fields (including description). The system auto-matches the company name to the website provided.

update_a_acquire_company_by_id

Update an existing Acquire company by id. Returns: id, dateCreated, dateUpdated, fields, contacts. Required: id, fields. The system auto-matches the company name to the website provided.

delete_a_acquire_company_by_id

Delete an Acquire company by id. Returns: deleted. Required: id. Deleting a company does not remove related contacts or cases; this action cannot be undone.

acquire_calls_create_call_in_queue

Create a call in the queue in Acquire. Returns: success, message. Required: CallId, To, From.

acquire_calls_create_ringing

Create a ringing call in Acquire. Returns: success, message. Required: email, Direction, CallId, To, From. Email is not required for incoming calls.

acquire_calls_create_answered

Create an answered call in Acquire. Returns: success, message. Required: Direction, From, To, CallId, email.

acquire_calls_create_call_end

Create an ended call in Acquire. Returns: success, message. Required: email, From, To, CallId, CallStatus, RecordingUrl, Duration, Direction. Email is optional for incoming calls.

acquire_bot_groups_get_default

Get the default Conversational Bot group in Acquire. Returns: id, title, description, isDefault, askFeedback, cascadeApplicable, createdBy, updatedBy, dateCreated, dateUpdated.

list_all_acquire_bot_groups

List Conversational Bot groups in Acquire. Returns: id, title, description, isDefault, askFeedback, cascadeApplicable, createdBy, updatedBy, dateCreated, dateUpdated.

create_a_acquire_bot_group

Create a new Conversational Bot group in Acquire. Returns: success, message, addedGroup.

delete_a_acquire_bot_group_by_id

Delete a Conversational Bot group in Acquire by id. Returns: success, message. Required: id. This action cannot be undone.

acquire_bot_groups_copy

Copy a Conversational Bot group in Acquire, duplicating its current questions and answers into a new group. Returns: success, message. Required: id.

list_all_acquire_bot_qna

List questions and answers for a group in Acquire. Returns: id, type, subtype, status, language, answerType, actionEnabled, wantFeedback, askedCount, allowRelatedQue, relatedQueIds, createdBy, updatedBy, dateCreated, dateUpdated, qnaMainQuestions, qnaMainAnswers. Required: type, groupId. Use type to filter by all, live, or suggested QnA.

get_single_acquire_bot_qna_by_id

Get a single Acquire QnA entry by id. Returns: id, type, success, message. Required: id.

create_a_acquire_bot_qna

Create a new QnA entry in Acquire. Returns: success, message, addedObject, fields, dateCreated, dateUpdated, id. Required: qnaGroupId, qnaMainQuestions, qnaMainAnswers, qnaMainActions.

update_a_acquire_bot_qna_by_id

Update a QnA in Acquire by id. Returns: success, message, updatedObject, delId. Required: id.

delete_a_acquire_bot_qna_by_id

Delete a QnA in Acquire by id. This action cannot be undone. Returns: success, message, delId. Required: id.

acquire_bot_qna_publish

Toggle the publish status of a QnA in Acquire — drafts become published and published questions become drafts. Returns: success, message, movedId. Required: move_id.

acquire_bot_qna_bulk_action

Perform a bulk action on multiple QnAs in Acquire, such as deleting a set of questions by their record IDs. Returns: success, message, lessEventsNotice.

acquire_bot_qna_push_to_suggestions

Push a question to Acquire Conversational Bot suggestions, creating it in draft status; if a similar question already exists within the specified group, the new question is merged into that QnA group. Returns: message.

acquire_bot_qna_import

Import QnA pairs into Acquire by specifying a group, source language, and an array of question/answer pairs. Returns: success, message.

list_all_acquire_sequence_bots

List sequence bots in Acquire. Returns each sequence with id, title, description, status, greeting, askFeedback, identifier, identifierCount, isImported, isCloned, clonedCount, createdBy, updatedBy, dateCreated, dateUpdated, and a nested bots configuration object.

get_single_acquire_sequence_bot_by_id

Get a single sequence bot by id in Acquire. Returns: lead, id, title, status, greeting, askFeedback, identifier, identifierCount, isImported, isCloned, clonedCount, createdBy, updatedBy, dateCreated, dateUpdated. Required: id.

create_a_acquire_sequence_bot

Create a new sequence bot in Acquire. Returns the created sequence under the lead key including id, title, description, status, greeting, askFeedback, identifier, identifierCount, isImported, isCloned, clonedCount, createdBy, updatedBy, dateCreated, and dateUpdated. Required: greeting, status, title.

update_a_acquire_sequence_bot_by_id

Update a sequence bot by id in Acquire. Returns the updated sequence including id, title, description, status, greeting, askFeedback, identifier, identifierCount, isImported, isCloned, clonedCount, createdBy, updatedBy, dateCreated, and dateUpdated. Required: id.

delete_a_acquire_sequence_bot_by_id

Delete a sequence bot by id in Acquire. This action cannot be undone. Returns: success, message. Required: id.

acquire_sequence_bots_bulk_action

Perform a bulk action on Acquire sequence bots. Supply sequence IDs in recordIds and the desired action in actionType. Returns: success, message, lessEventsNotice. Required: recordIds, actionType. The only documented actionType is "delete".

acquire_sequence_bots_copy

Create a copy of an existing Acquire sequence bot by id. Returns the copied sequence object including its id, title, description, status, identifier, and dateCreated. Required: clone_id.

get_single_acquire_sequence_branch_by_id

Get a single Acquire sequence branch by id. Returns the branch object including its id, title, visibleOrder, position, isParent, and leadEdges. Required: id.

create_a_acquire_sequence_branch

Create a new Acquire sequence branch. Returns: message. Required: id (sequence ID), title, and position.

update_a_acquire_sequence_branch_by_id

Update an Acquire sequence branch by id. Returns: success, message. Required: id, title, and data.

delete_a_acquire_sequence_branch_by_id

Delete an Acquire sequence branch by id. This action cannot be undone. Returns: success, message. Required: id.

acquire_sequence_branches_set_parent

Set a child Acquire sequence branch as a parent branch. Returns: success, message. Required: parent_branch_id and leadId.

list_all_acquire_interaction_cards

List all custom interaction cards in Acquire, optionally filtered by contact. Returns: id, title, contactId, userId, view, meta, dateCreated.

get_single_acquire_interaction_card_by_id

Get a single interaction card in Acquire by id. Returns: id, title, contactId, userId, view, meta, dateCreated, success, data, message. Required: id.

create_a_acquire_interaction_card

Create a new interaction card in Acquire. Returns: success, data, message. Required: contact_id, view.

update_a_acquire_interaction_card_by_id

Update an interaction card in Acquire by id. Returns: success, data, message. Required: id, view.

delete_a_acquire_interaction_card_by_id

Delete a custom interaction card in Acquire by id. Warning: this action cannot be undone. Returns: success, message. Required: id.

create_a_acquire_general_card

Create a general custom card in Acquire. Returns: success, data, message. Required: type, config, displayScope, area. These endpoints are in beta testing.

delete_a_acquire_general_card_by_id

Delete a general custom card in Acquire by id. Returns: success, message. Required: id. This action cannot be undone. These endpoints are in beta testing.

acquire_analytics_custom_reporting_delete_custom_chart

Delete a custom chart in Acquire by its report key. Returns the deleted chart's success status and full chart data including title, chartKey, chartType, id, and totalCount. Required: report_key. This action cannot be undone.

acquire_analytics_custom_reporting_generate_chart

Create a custom chart in Acquire with a title, chart type, and configuration. Returns: success, data, url. Required: config, chartType, title.

acquire_analytics_custom_reporting_edit_custom_report

Edit a custom report in Acquire by updating its name or description. Returns: success, url. Required: reportKey.

acquire_analytics_custom_reporting_generate_report

Create a custom report in Acquire with a name, description, and selected object type. Returns: success, url. Required: objectKey, reportName.

acquire_analytics_custom_reporting_delete_custom_report

Delete a custom report in Acquire by its report key. Returns: success, url. Required: report_key. This action cannot be undone.

acquire_analytics_custom_reporting_get_custom_report

Get custom report details and associated chart data from Acquire by report key. Returns: success, url. Required: report_key.

acquire_analytics_custom_reporting_get_all_custom_reports

List all custom reports in Acquire with name, description, and report key. Returns: success, customReport, url.

acquire_analytics_custom_reporting_get_data_points

Retrieve all available data points for Acquire analytics objects. Returns: objects, success, url.

acquire_analytics_custom_reporting_get_custom_chart

Retrieve a custom chart's data with pagination in Acquire. Returns: success, data, url. Required: chart_id.

acquire_analytics_custom_reporting_schedule_chart

Schedule a custom chart for periodic email delivery in Acquire. Returns: success, data, message, url. Required: chartId, emails, schedulePeriod.

acquire_analytics_custom_reporting_delete_scheduled_chart

Remove an already scheduled chart email from Acquire custom reporting. Returns an empty 204 response on success. Required: scheduleMailId.

acquire_analytics_general_cases_overview

Get Acquire cases overview analytics for a date range, including pending-to-active, active-to-closed, and reopened counts plus average transition times. Returns the casesOverview object with graphRow (labels, total, pendingToActive, activeToClose, reopened, avgPendingToActiveTime, avgActiveToCloseTime) and summary with current and previous period values.

acquire_analytics_general_cases_by_channel

Get Acquire cases by channel analytics showing total, chats, mail, voip, private form, and social media case counts over a date range. Returns the casesByChannel object with graphRow (labels, totalCases, totalChats, totalMails, totalVoip, totalPrivateForms, socialAppsCases) and summary with current and previous period values.

acquire_analytics_general_busiest_periods_cases

Get Acquire busiest periods case analytics showing case counts by time of day across a specified date range. Returns the busiestPeriodsCases object with graphRow containing a data array of time-slot labels and per-two-hour case counts.

acquire_analytics_chat_chat_overview

Get chat overview analytics from Acquire with hourly time-series and period-over-period summary metrics. Returns: chatOverview.

acquire_analytics_chat_chat_handle_time

Get chat handle time analytics from Acquire showing distribution of chats across handling-time buckets. Returns: chatHandleTime.

acquire_analytics_chat_busiest_periods_chats

Get busiest inbound chat period analytics from Acquire showing chat volume by hour across each day. Returns: busiestPeriodsChats.

acquire_analytics_chat_conversations_tagged

Retrieve the number of conversations your team tagged vs. the total number of conversations in Acquire. Returns: conversationsTagged.

acquire_analytics_chat_tag_reporting

Retrieve a list of the most frequently used chat tags in Acquire. Returns the tagReporting object containing a graphRow with each tag's title, chats count, percentage, and color.

acquire_analytics_chat_most_common_tags

Retrieve a list of the most common tags used in Acquire chat conversations within a date range. Returns: data, success, output.

acquire_analytics_chat_visitors_by_location

Retrieve counts of visitor interactions by country in Acquire. Returns: data, success, output.

acquire_analytics_chat_most_active_visit_times

Retrieve data for the most active visit times in Acquire chat analytics. Returns: data, success, output.

acquire_analytics_chat_pages_with_most_chats

Retrieve data for the pages with the most chats in Acquire. Returns: data, success, output.

acquire_analytics_chat_visitor_reference

Retrieve data for the pages visitors were on before visiting your Acquire site (reference pages). Returns: data, success, output.

acquire_analytics_chat_video_analytics

Get video session analytics data in Acquire. Returns the videoAnalytics object with graphRow (labels, totalSession, averageSessionTime, responseTime arrays) and summary metrics comparing current and previous periods.

acquire_analytics_chat_browser_overview

Get visitor browser distribution analytics in Acquire. Returns the browserOverview object with graphRow containing labels and visitorCount arrays, plus success and output fields.

acquire_analytics_chat_os_overview

Get visitor operating system distribution analytics in Acquire. Returns the osOverview object with graphRow containing labels and data arrays, plus success and output fields.

acquire_analytics_chat_device_overview

Get visitor device type distribution analytics in Acquire. Returns the deviceOverview object with graphRow containing labels and data arrays, plus success and output fields.

list_all_acquire_kb_groups

List all knowledge base article groups in Acquire. Returns: id, name, slugKey, status, isDefault, customDomain, baseGroupsLang, isSetup, createdBy, updatedBy, dateCreated, dateUpdated.

create_a_acquire_kb_group

Create a new article group in the Acquire knowledge base. Returns: success, message, data. Required: name.

update_a_acquire_kb_group_by_id

Update a knowledge base group in Acquire by id. Returns: success, message, data. Required: id.

get_single_acquire_kb_group_by_id

Get a single knowledge base group in Acquire by id. Returns: id, name, slugKey, status, isDefault, customDomain, isSetup, baseGroupsLang, createdBy, updatedBy, dateCreated, dateUpdated, title, askFeedback, cascadeApplicable. Required: id.

delete_a_acquire_kb_group_by_id

Delete a knowledge base group in Acquire by id. Returns: success, message, data. Required: id. This action cannot be undone.

list_all_acquire_kb_articles

List all Knowledge Base articles in Acquire. Returns each article with id, title, articleSlug, description, content, jsonContent, access, status, dateCreated, dateUpdated, seo, and tags. Filter by groupId, categoryId, author, access, or status.

create_a_acquire_kb_article

Create a new Knowledge Base article in Acquire. Returns: success, message. Required: title, slug, groupId.

update_a_acquire_kb_article_by_id

Update an existing Knowledge Base article in Acquire. Returns: success, message. Required: id, groupId.

delete_a_acquire_kb_article_by_id

Delete a Knowledge Base article in Acquire. Returns: success, message, data. Required: id, groupId. This action cannot be undone.

get_single_acquire_kb_article_by_id

Get a single Knowledge Base article in Acquire by id. Returns: success, articles, message, data. Required: id.

create_a_acquire_kb_category

Create a new Knowledge Base category in Acquire. Returns: success, message. Required: name, groupId.

update_a_acquire_kb_category_by_id

Update an existing Knowledge Base category in Acquire by id. Returns: success, message. Required: id.

delete_a_acquire_kb_category_by_id

Delete a Knowledge Base category in Acquire by id. Returns: success, message, data. Required: id. This action cannot be undone.

list_all_acquire_kb_categories

List all Knowledge Base categories in Acquire. Returns each category's id, name, slug, description, status, dateCreated, dateUpdated, articleCount, parentCategory, visibleOrder, categoryIcon, createdBy, updatedBy, internal, publish, and archive.

list_all_acquire_users

List all available Acquire users. Returns: id, firstName, lastName, name, email, type, status, phone, photo, lastLoginId, parentId, ownerId, inviteToken, language, clientId, clientAppId, clientAuthorizer, clientPermissions, stateId, countryId, dateCreated, meta, logo, organization, sso, departments, roles.

get_single_acquire_user_by_id

Get a single Acquire user by id. Returns: id, firstName, lastName, name, email, type, status, phone, photo, lastLoginId, parentId, ownerId, inviteToken, language, clientId, clientAppId, clientAuthorizer, clientPermissions, stateId, countryId, dateCreated, meta, logo, organization, sso. Required: id.

create_a_acquire_user

Create a new Acquire user. Returns: user, success, message, deleted.

update_a_acquire_user_by_id

Update an Acquire user's information by id. Returns an array containing the updated user object with id, name, email, type, status, phone, dateCreated, roles, and departments. Required: id.

acquire_users_bulk_delete

Delete an Acquire user by userId. Returns: deleted. Required: userId. This action cannot be undone.

list_all_acquire_roles

List Acquire account roles. Returns: id, roleName, permissions, permissionType, meta, users. Optional filters via select, relations, where, and order query parameters.

get_single_acquire_role_by_id

Get a single Acquire account role by id. Returns: id, roleName, permissions, permissionType, meta, users. Required: id.

create_a_acquire_role

Create a new Acquire account role. Returns: id, roleName, permissions, permissionType, meta. Required: roleName, permissions.

update_a_acquire_role_by_id

Update an existing Acquire account role by id. Returns: id, roleName, permissions, permissionType, meta, users. Required: id.

acquire_roles_bulk_delete

Delete an Acquire account role. Returns: deleted. Required: id. Warning: This action cannot be undone.

list_all_acquire_departments

List all departments and users who belong to those departments in Acquire. Returns: id, name, status, users. Supports filtering via where, ordering via order, field selection via select, and relation loading via relations.

get_single_acquire_department_by_id

Get a single department by id in Acquire. Returns: id, name, status, users. Required: id. Use the relations query parameter to include related entities such as users.

create_a_acquire_department

Create one or more new departments in Acquire by providing a department_list array. Returns an array of created department objects including id, name, and status. Required: department_list. Each department name must be unique; set status to "active" to publish or "disabled" for draft.

update_a_acquire_department_by_id

Update a department's name or status in Acquire. Returns the updated department object including id, name, status, and users. Required: id. Set status to "active" to publish or "disabled" for draft.

delete_a_acquire_department_by_id

Delete a department by id in Acquire. Returns an empty 204 response on success. Required: id.

acquire_analytics_cobrowse_overview

Retrieve cobrowse analytics metrics in Acquire including sessions, durations, and visited pages. Returns the cobrowse object with graphRow time-series data (totalCobrowseSession, totalPageVisited, averageSessionTime) and summary metrics comparing current and previous periods.

acquire_analytics_cobrowse_channel_wise

Retrieve channel-wise cobrowse session analytics in Acquire, including average session time per channel. Returns the coBrowseChannelWise object with graphRow time-series data (totalSessions, averageSessionTime, totalCoBrowseTime) and summary metrics comparing current and previous periods.

acquire_analytics_cobrowse_page_source

Retrieve a list and count of URLs visited during cobrowse sessions in Acquire. Returns the coBrowsePageSource object with graphRow data containing pageUrl and pageVisited counts for each visited page.

acquire_analytics_email_overview

Get an email analytics overview in Acquire with totals for emails sent, received, and average response time. Returns the allEmailOverview object including graph data for totalEmails, totalEmailsSent, totalEmailsReceived, and averageResponseTime, plus summary metrics with current and previous period comparisons.

acquire_analytics_email_activity

Get email activity analytics in Acquire showing the most active times for emails read, unread, delivered, replied to, and bounced. Returns the emailActivity object including hourly graph data for totalMailRead, totalMailUnread, totalMailDelivered, totalMailReplied, and totalMailBounced, plus summary metrics with current and previous period comparisons.

acquire_analytics_voip_calls_overview

Get Acquire VoIP call metrics including number of calls and average duration per time period. Returns the callsOverview object containing graphRow with labels, outgoingCalls, incomingCalls, missedCalls, and averageCallTime arrays, plus a summary with current and previous period totals, success, and output format.

acquire_analytics_voip_sms_metrics

Get Acquire SMS metrics showing how many messages your team receives and responds to along with average response time. Returns the smsMetrics object containing graphRow with labels, incomingSms, outgoingSms, failedSms, and averageResponseTime arrays, plus a summary with current and previous period totals, success, and output format.

acquire_analytics_voip_call_analysis

Get Acquire IVR and hold time analytics data. Returns the callAnalysis object containing graphRow with labels, peopleAddedInCall, peopleLeftIVR, peopleLeftFromHold, averageIVRTime, and averageHoldTime arrays, plus a summary with current and previous period totals, success, and output format.

list_all_acquire_analytics_agent

List Acquire agent performance data including name, ID, department, role, rating, online status, and channel access. Returns: id, name, email, image, department, role, rating, isOnline, stateChat, stateMail, stateVoip.

acquire_analytics_agent_graph_data

Get Acquire agent performance graph data including ratings, response times, and total conversations across all channels. Returns the agentStatistics object with data (graphRow and summary), success, and output. Required: agent_id.

acquire_analytics_agent_leaderboard

List Acquire agent leaderboard rankings by rating and cases solved. Returns: id, email, departments, role, solvedCases, totalTimeSpent, avgTimeSpentPerCase, averageResponseTime, averageRatingFeedback, agent.

acquire_analytics_bot_sequence_bot_overview

Get an overview of Sequence Bot conversation analytics in Acquire, including counts for initiated, completed, live hand offs, and abandoned conversations. Returns the sequenceBotOverview object including graphRow with initiated, completed, liveHandOffs, and abandoned time-series arrays, and summary with current and previous period comparisons.

acquire_analytics_bot_leads_generated

Get a list of Sequence Bot leads generated in Acquire with per-lead conversation counts. Returns the leadsGenerated object including graphRow data with lead_name, initiated, completed, transferred, and incompleted counts per lead, plus success and output status.

acquire_analytics_bot_path_analysis

Get branch path analysis for a specific Sequence Bot lead in Acquire, showing how visitors navigate between bot branches. Returns the botPathAnalysis object including graphRow with from_branch, to_branch, count, from_visible_order, and to_visible_order per transition. Required: leadId.

acquire_analytics_bot_lead_details

Get a list of Sequence Bot leads and their branch details including branch IDs in Acquire. Returns the botLeadDetails object including leads with id, title, and nested details (branch list with next_branch, id, and title), plus success status.

acquire_analytics_bot_conversational_bot_overview

Get an overview of Conversational Bot analytics in Acquire, showing contacts and conversations handled by your bot. Returns the conversationalBotOverview object including graphRow with customersEngaged, interactionsWithBot, resolvedIssues, and unansweredQuestions time-series arrays, and summary with current and previous period counts.

acquire_analytics_bot_questions_report

Get a Conversational Bot questions report from Acquire showing how many questions were added, used, and suggested over a date range. Returns the questionsReport object including graphRow time-series data (labels, totalQuestionsAdded, totalQuestionsInUse, totalSuggestedQuestions, totalQuestionGroups) and summary with current/previous period counts, plus success and output status.

acquire_analytics_kb_overview

Get a Knowledge Base analytics overview in Acquire covering content creation, search volume, and article feedback. Returns: overview, success, url.

acquire_analytics_kb_searches

Get Knowledge Base search analytics in Acquire showing total, successful, and unsuccessful search trends. Returns: searches.

acquire_analytics_kb_most_popular_searches

Get the most frequently searched terms in your Acquire Knowledge Base. Returns: mostPopularSearches, firstName, lastName, id, status, name, email, dateCreated, meta, organization, sso.

acquire_analytics_kb_all_questions_reporting

Get article-level view counts and reaction data for your Acquire Knowledge Base. Returns: allQuestionsReporting, firstName, lastName, id, status, name, email, dateCreated, meta, organization, sso.