Skip to content

Get conversation status counts

GET
/api/workspaces/{workspaceId}/conversations/status-counts

Get aggregate conversation counts by status for a workspace. Useful for building dashboards.

workspaceId
required
string format: uuid

The workspace to get status counts for.

Aggregate conversation counts by status.

Aggregate conversation counts by status for a workspace.

object
open
required

Number of conversations in open status.

integer
Example
12
in_progress
required

Number of conversations currently in progress.

integer
Example
8
awaiting_contact
required

Number of conversations awaiting a response from the contact.

integer
Example
23
resolved
required

Number of resolved conversations.

integer
Example
156
closed
required

Number of closed conversations.

integer
Example
4
abandoned
required

Number of abandoned conversations.

integer
Example
2

An API key restricted to a brand or workspace named a workspace outside its restriction, or one that is not a workspace of your account (Workspace not found).

Standard error response returned by all endpoints on failure.

object
error
required

A human-readable error message describing what went wrong.

string
Example
Conversation not found
code

A machine-readable reason on some refusals, for example ‘key_lock’ when an API key’s brand or workspace restriction does not cover the action.

string
Example
key_lock
missing_scopes

On a 403 for an API key without a scope the endpoint requires: the scopes the key lacks.

Array<string>
Example
[
"mcp:write"
]
entryId

On a 409 with code duplicate_question or duplicate_rule_text: the knowledge base entry or policy that already holds the question or rule text.

string format: uuid
Example
11223344-5566-4788-99aa-bbccddeeff00
connectionId

On a 422 about one MCP connection a request names, from an assignment or an agent create or update (a connection that does not exist, one listed twice, or one that does not declare a tool named): the connection, as the request named it.

string
undeclaredTools

On the same 422: the tool names the connection does not declare.

Array<string>
Example
[
"get_orders"
]
declaredTools

On the same 422: the tools the connection declares.

Array<string>
Example
[
"get_order",
"search_orders"
]