Free Sign Up

Management API (Beta)

:::note In Beta Phase
This feature is in the Beta phase. If you have any questions, ideas or suggestions please reach out to us at devrelations@symbl.ai.
:::

The Management API allows you to access and manage various resources against your Symbl account. The resources created and managed by this API is maintained at the account level.

While the Conversation API is used for managing the data associated with the conversations (generated via the real-time or Async APIs), the Management API is used for managing the data consumed via the Symbl’s APIs.

Supported Entities #

The following entities are currently supported with Management API:

  • Trackers: Trackers allow you to get “contextually similar” occurrences in a conversation so you can identify emerging trends and gauge the nature of the interactions. Read about Trackers and its capabilities, in the Trackers section.

  • Conversation Groups: You can create and manage conversations by logically grouping them by defining a criteria that suits your business need such as grouping based on speaker agent, company name, labels such as internal, external, sales, etc. Read more in the Conversation Groups.

Tracker Management APIs #

Following are the API endpoints supported for managing Trackers entity:

Operation Endpoint
Create Tracker POST v1/manage/tracker
Create Trackers in Bulk POST v1/manage/trackers
Get Tracker with ID GETv1/manage/tracker/{trackerId}
Get Tracker with name GET v1/manage/trackers?name={trackerName}
Update Tracker PUTv1/manage/tracker/{trackerId}
Delete Tracker DELETEv1/manage/tracker/{trackerId}

:::info Trackers Management UI
You can create, view, edit and delete Trackers via the Trackers Management UI as well. To access this feature, log in to theSymbl Platform
:::

Conversation Groups Management APIs #

Following are the API endpoints supported for managing Conversation Groups entity:

Operation Endpoint
Create Conversation Group POST /v1/manage/group
Create Multiple Conversation Groups POST /v1/manage/groups
Get Conversation Group with ID GET /v1/manage/group/{groupId}
Get Multiple Conversation Groups GET /v1/manage/groups
Update Conversation Group PUT /v1/manage/group/{groupId}
Delete Group DELETE /v1/manage/group/{groupId}