conversations

Get Conversation Counts

Changed on

Return counts grouped by ConversationType for the same filters as the list.

Like the list endpoint, when no status filter is passed, status="FAILED" rows are excluded from the counts. by_direction splits the same threads by who wrote first, so one call fills the All / Inbound / Outbound tabs.

get/v2/conversations/counts

Request

  • Base URL
    https://api.mentium.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

workspace_idstring required
statusstring nullable
load_idstring nullable
labelstring nullable
has_draftsboolean nullable
has_sentboolean nullable
is_starredboolean nullable
channelstring nullable

Count only these channels (comma-separated)

qstring nullable
search_bodyboolean

Also search the plain-text message bodies with q (slower)

thread_directionstring nullable

Who wrote first: all | inbound (the carrier) | outbound (us). When set, it replaces the legacy folder rule that the default view keeps only threads with a carrier message.

start_datetimestring date-time nullable
end_datetime_exclusivestring date-time nullable
ai_agent_idstring[] nullable
outcomestring nullable

The row's outcome pill: failed | ai_handling | booked | accepted | declined | negotiating | completed. The call-only outcomes (transferred, no_answer, stale, live, in_progress) match no thread.

filters_jsonstring nullable

JSON array of record filters: [{"field": "carrier_id", "operator": "IN", "values": ["C-1"]}, {"field": "resource", "operator": "EQUALS", "resource_type": "Load", "identifier_field": "external_reference_id", "value": "484612"}, {"field": "load.origin_state", "operator": "IN", "values": ["TX"]}]. carrier_id and the load id match the thread's own reference or any of its offers'; a load id may be the TMS display reference. load.* fields are those Calls filters on, answered by the TMS for the 5,000 most recently active loads of the matching threads.

Headers

mentium-workspace-idstring nullable

Response

Successful Response

unknown required

Changes