Understanding API Parameters

Understanding Parameters:

Parameter
Type
Description

agentid

string

The ID of the agent you want data for. Omit if you want system-wide data.

results

integer

Number of records per page. Defaults to 20 if not specified.

skip

integer

Offset in the dataset (calculated based on current page).

metadatasearch

string

keyword filter. Use "" (empty string) if not filtering.

/api/Chat/GetConversations/

Parameter
Type
Required?

results

integer

No

skip

integer

No

metadatasearch

string

No

/api/Chat/GetConversations/{agentid}/

Parameter
Parameter Form
Required?

agentid

Path

Yes*

results

Query

False, default = 20

skip

Query

False, default = 0

metadatasearch

Query

False, default = ""


/api/Chat/GetConversations/{agentid}/{results}/{skip}/{metadatasearch}/

Parameter
Parameter Form
Required?

agentid

Path

Yes*

results

Path

Yes*

skip

Path

Yes*

metadatasearch

Path

Yes*

Last updated