Understanding API Parameters
Parameter
Type
Required?
Description
agentid
string
No*
The ID of the agent you want data for. Omit if you want system-wide data.
results
integer
Yes
Number of records per page. Defaults to 20 if not specified.
skip
integer
Yes
Offset in the dataset (calculated based on current page).
metadatasearch
string
No
Optional keyword filter. Use ""
(empty string) if not filtering.
Below are plug-and-play functions that dynamically support both API routes:
/api/Chat/GetConversations/
(when agent ID is not known)/api/Chat/GetConversations/{agentid}
(when it is)
These helpers calculate the correct skip
, and let your app specify the page without worrying about the URL details.
✅ If agentid
is omitted, just use /api/Chat/GetConversations
— the API will still respond with paginated data.
Last updated