Understanding API Parameters

Overview of 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 results requested starting from skip. Defaults to 20 if not specified.
skip	integer	This value tells the API where in your data to begin. Defaults to 0 if not specified skip = (pageNumber - 1) * results
metadatasearch	string	Keyword filter. Use "" (empty string) if not filtering. Also defaults to this value if not specified.
conversationid	string	The ID of the specific conversation you want data for.

Note: For your own app integrating with our API, it is typical in pagination to first get the total number of query-able items in the not-paginated data source so you are aware of the maximum value.

Path Parameters vs Query Parameters

Path Parameter: A required value as a part of the URL path. Appears right after the last / in the URL path.

Query Parameter: Included in the URL path if default values are not preferred. In these GetConversation(s) APIs they are optional. Appears after path parameters, if included. Set of query parameters always begins with ? and are conjoined by & for any additional ones.

Example: GET /api/Chat/GetConversations/abc123?results=25&skip=75&metadatasearch=sales

• Required path parameters:

  • abc123 = required path parameter. In this case, represents agentid

• Optional query parameters to override default values:

  • results = 25 (int)

  • skip = 75 (int)

  • metadatasearch = "sales" (string)

GetConversation(s) API Endpoints

/api/Chat/GetConversations/

Description: Returns a list of conversations when the agentid is not known.

Required Path Parameters: None

Optional Query Parameters: agentid , results , skip , metadatasearch

/api/Chat/GetConversations/{agentid}/

Description: Returns a list of conversations for the user based on the agentid .

Required Path Parameters: agentid

Optional Query Parameters: results , skip , metadatasearch

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

Description: Returns a list of conversations for the user based on the agentid with the specified pagination settings.

Required Path Parameters: agentid , results , skip , metadatasearch

/api/Chat/GetConversation/{conversationid}

Description: Gets a single conversation with all responses and information.

Required Path Parameters: conversationid