v3
efficiency

Efficiency dashboard — every AI call and email thread in the window, newest first

get/v3/efficiency/conversations

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

channelEfficiencyChannelKey[] nullable

Only these channels. Omit for all four.

closed_by'ai' | 'assisted' | 'human'

Who handled a conversation, or who booked a load.

Only conversations handled (or booked) by the AI, with its help, or by a person.

searchstring nullable

Case-insensitive match on carrier, contact, MC/DOT, load, lane, customer, rep and equipment.

cursorstring nullable

next_cursor from the previous page.

sizeinteger
period_daysinteger nullable

Trailing window in days. Mutually exclusive with the explicit bounds and with all_time. Omit everything for 30 days.

start_datetimestring date-time nullable

Inclusive window start (timezone-aware ISO-8601). Requires end_datetime_exclusive.

end_datetime_exclusivestring date-time nullable

Exclusive window end (timezone-aware ISO-8601). Requires start_datetime.

all_timeboolean

From the workspace's first AI conversation to now. Excludes the other window params.

time_zonestring

IANA time zone the days, weeks (Monday start) and months are cut in.

agent_idstring[] nullable

Only the calls and email threads these AI agents handled. Omit for every agent.

Headers

mentium-workspace-idstring nullable

Response

Successful Response

next_cursorstring nullable required

Changes

No recorded changes to this operation across all 2 revisions of this API.