This Koopid API tech note covers the Koopid API services – request parameters, request and response examples.
Jump to a section...
Agent Access Stats
- POST /Dashboard/AgentAccessStats
- Security Roles Allowed
- Koopid Admin, Provider Admin
Request body:
media type | data type |
---|---|
*/* | (custom) |
Example: POST /Dashboard/AgentAccessStats Content-Type: */* Accept: application/json ... |
Response body:
media type | data type |
---|---|
application/json | (custom) |
Example: HTTP/1.1 201 Created Content-Type: application/json ... |
Agent Queue Stats
- POST /Dashboard/AgetQueueStats
- Security Roles Allowed
- Koopid Admin, Provider Admin
Request body:
media type | data type |
---|---|
*/* | (custom) |
Example: POST /Dashboard/AgentQueueStats Content-Type: */* Accept: application/json ... |
Response body:
media type | data type |
---|---|
application/json | (custom) |
Example: HTTP/1.1 201 Created Content-Type: application/json ... |
Agent Session Stats
- POST /Dashboard/AgentSessionStats
- Security Roles Allowed
- Koopid Admin, Provider Admin
Request body:
media type | data type |
---|---|
*/* | (custom) |
Example: POST /Dashboard/AgentSessionStats Content-Type: */* Accept: application/json ... |
Response body:
media type | data type |
---|---|
application/json | (custom) |
Example: HTTP/1.1 201 Created Content-Type: application/json ... |
Bot Access Stats
- POST/ Dashboard/BotAccessStats
- Security Roles Allowed
- Koopid Admin, Provider Admin
Request body:
media type | data type |
---|---|
*/* | (custom) |
Example: POST /Dashboard/BotAccessStats Content-Type: */* Accept: application/json ... |
Response body:
media type | data type |
---|---|
application/json | (custom) |
Example: HTTP/1.1 201 Created Content-Type: application/json ... |
Chat Stats
- GET /Dashboard/ChatStats
- Security Roles Allowed
- Koopid Admin, Provider Admin
Request body:
name | type | description |
---|---|---|
providerId | query | |
Example: GET /Dashboard/ChatStats Accept: */* |
Response body:
media type | data type |
---|---|
*/* | (custom) |
Example: HTTP/1.1 200 OK Content-Type: */* ... |
Customer Endpoint
- POST /Dashboard/CustomerEndpoint
- Security Roles Allowed
- Koopid Admin, Provider Admin
Request body:
media type | data type |
---|---|
*/* | (custom) |
Example: POST /Dashboard/CustomerEndpoint Content-Type: */* Accept: application/json ... |
Response body:
media type | data type |
---|---|
application/json | (custom) |
Example: HTTP/1.1 201 Created Content-Type: application/json ... |
DB Stats
- POST /Dashboard/DBStats
- Security Roles Allowed
- Koopid Admin, Provider Admin
Request body:
media type | data type |
---|---|
*/* | (custom) |
Example: POST /Dashboard/DBStats Content-Type: */* Accept: application/json ... |
Response body:
media type | data type |
---|---|
application/json | (custom) |
Example: HTTP/1.1 201 Created Content-Type: application/json ... |
Intents
- POST /Dashboard/Intents
- Security Roles Allowed
- Koopid Admin, Provider Admin
Request body:
media type | data type |
---|---|
*/* | (custom) |
Example: POST /Dashboard/Intents Content-Type: */* Accept: application/json ... |
Response body:
media type | data type |
---|---|
application/json | (custom) |
Example: HTTP/1.1 201 Created Content-Type: application/json ... |
Interaction Type
- POST /Dashboard/InteractionType
- Security Roles Allowed
- Koopid Admin, Provider Admin
Request body:
media type | data type |
---|---|
*/* | (custom) |
Example: POST /Dashboard/InteractionType Content-Type: */* Accept: application/json ... |
Response body:
media type | data type |
---|---|
application/json | (custom) |
Example: HTTP/1.1 201 Created Content-Type: application/json ... |
Interactions
- POST /Dashboard/Interactions
- Security Roles Allowed
- Koopid Admin, Provider Admin
Request body:
media type | data type |
---|---|
*/* | (custom) |
Example: POST /Dashboard/Interactions Content-Type: */* Accept: application/json ... |
Response body:
media type | data type |
---|---|
application/json | (custom) |
Example: HTTP/1.1 201 Created Content-Type: application/json ... |
Messages
- POST /Dashboard/Messages
- Security Roles Allowed
- Koopid Admin, Provider Admin
Request body:
media type | data type |
---|---|
*/* | (custom) |
Example: POST /Dashboard/Messages Content-Type: */* Accept: application/json ... |
Response body:
media type | data type |
---|---|
application/json | (custom) |
Example: POST /Dashboard/Messages Content-Type: */* Accept: application/json ... |
Summary
- POST /Dashboard/Summary
- Security Roles Allowed
- Koopid Admin, Provider Admin
Request body:
media type | data type |
---|---|
application/json | (custom) |
Example: HTTP/1.1 201 Created Content-Type: application/json ... |
Response body:
media type | data type |
---|---|
*/* | (custom) |
Example: POST /Dashboard/Summary Content-Type: */* Accept: application/json ... |
Top Words
- POST /Dashboard/Summary
- Security Roles Allowed
- Koopid Admin, Provider Admin
Request body:
media type | data type |
---|---|
application/json | (custom) |
Example: HTTP/1.1 201 Created Content-Type: application/json ... |
Response body:
media type | data type |
---|---|
*/* | (custom) |
Example: POST /Dashboard/TopWords Content-Type: */* Accept: application/json ... |
User Activity
- GET /Dashboard/UserActivity
- Security Roles Allowed
- Koopid Admin, Provider Admin
Request body:
media type | data type |
---|---|
application/json | (custom) |
Example: HTTP/1.1 201 Created Content-Type: application/json ... |
Response body:
name | type | description | constraints |
---|---|---|---|
for | query | long | |
Example: GET /Dashboard/UserActivity Accept: application/json |
Conversation Stats
- GET /Dashboard/{providerId}/ConversationStats
- Get chat statistics for a providerId from the redacted data
- Security Roles Allowed
- Provider Admin
Request parameters:
name | type | description | constraints |
---|---|---|---|
providerId | path | providerId for which stats requested | |
end | query | end time | long |
start | query | start time | long |
tz | query |
Request body:
media type | data type |
---|---|
*/* | (custom) |
Example: GET /Dashboard/{providerId}/ConversationStats Content-Type: */* Accept: application/json ... |
Response body:
media type | data type |
---|---|
application/json | (custom) |
Example: HTTP/1.1 200 OK Content-Type: application/json ... |
Redacted Messages
- GET /Dashboard/{providerId}/RedactedMessages
- Get all redacted messages for a providerId
- Security Roles Allowed
- Provider Admin
Request parameters:
name | type | description | constraints |
---|---|---|---|
providerId | path | providerId for which redacted messages requested | |
end | query | end time | long |
start | query | start time | long |
Request body:
media type | data type |
---|---|
*/* | (custom) |
Example: GET /Dashboard/{providerId}/RedactedMessages Content-Type: */* Accept: application/json ... |
Response body:
media type | data type |
---|---|
application/json | (custom) |
Example: HTTP/1.1 200 OK Content-Type: application/json ... |
Redacted Messages With Plot
- GET /Dashboard/{providerId}/RedactedMessagesWithPlot
- Get all redacted messages for a providerId with a plot
- Security Roles Allowed
- Provider Admin
Request parameters:
name | type | description | constraints |
---|---|---|---|
providerId | path | providerId for which redacted messages requested | |
end | query | End time | long |
start | query | Start time | long |
viewtype | query | Type of plot requested. This is ignored currently |
Request body:
media type | data type |
---|---|
*/* | (custom) |
Example: GET /Dashboard/{providerId}/RedactedMessagesWithPlot Content-Type: */* Accept: application/json ... |
Response body:
media type | data type | description |
---|---|---|
application/json | (custom) | a JSON string with redactedMessages, htmlView and status. For eg. {"extractedMessages: [{}], "htmlView": "html code that displays the plot", "status": "success" } status: {success | No redacted messages | Failed to get plot} |
Example: HTTP/1.1 200 OK Content-Type: application/json ... |
GET Analytics
- GET /Dashboard/Analytics/{analysisType}/{providerId}
- Security Roles Allowed
- Koopid Admin, Provider Admin
Request parameters:
name | type | description | constraints |
---|---|---|---|
analysisType | path | ||
providerId | path | ||
data | query | ||
end | query | long |
|
start | query | long |
Request body:
media type | data type |
---|---|
*/* | (custom) |
Example: GET /Dashboard/Analytics/{analysisType}/{providerId} Content-Type: */* Accept: application/json ... |
Response body:
media type | data type |
---|---|
application/json | (custom) |
Example: HTTP/1.1 200 OK Content-Type: application/json ... |
POST Analytics
- POST /Dashboard/Analytics/{analysisType}/{providerId}
- Security Roles Allowed
- Koopid Admin, Provider Admin
Request parameters:
name | type | description |
---|---|---|
analysisType | path | |
providerId | path |
Request body:
media type | data type |
---|---|
application/json | (custom) |
Example: POST /Dashboard/Analytics/{analysisType}/{providerId} Content-Type: application/json Accept: application/json ... |
Response body:
media type | data type |
---|---|
application/json | (custom) |
Example: HTTP/1.1 201 Created Content-Type: application/json ... |