diff --git a/docs/api-reference/endpoint/report/agent-activity.mdx b/docs/api-reference/endpoint/report/agent-activity.mdx index dd5435fc6..d07175c59 100644 --- a/docs/api-reference/endpoint/report/agent-activity.mdx +++ b/docs/api-reference/endpoint/report/agent-activity.mdx @@ -12,6 +12,12 @@ This endpoint provides insights into agent activity, showing the number of activ The unique identifier of the organization. +## Authentication + + + Bearer token for authentication + + ### Query Parameters diff --git a/docs/api-reference/endpoint/report/agent-performance.mdx b/docs/api-reference/endpoint/report/agent-performance.mdx index 742235c22..07fa86a7e 100644 --- a/docs/api-reference/endpoint/report/agent-performance.mdx +++ b/docs/api-reference/endpoint/report/agent-performance.mdx @@ -6,6 +6,12 @@ description: "Retrieve performance metrics for agents based on chat sessions" This endpoint provides performance metrics for agents, including the total number of chats handled and their average duration. Performance in this context refers to the quantity of chats an agent manages and how quickly they resolve them. +## Authentication + + + Bearer token for authentication + + ### Path Parameters diff --git a/docs/api-reference/endpoint/report/agent-response-time.mdx b/docs/api-reference/endpoint/report/agent-response-time.mdx index ac200d5d8..4ac8c2893 100644 --- a/docs/api-reference/endpoint/report/agent-response-time.mdx +++ b/docs/api-reference/endpoint/report/agent-response-time.mdx @@ -6,6 +6,12 @@ description: "Retrieve average response times for agents in chat sessions" This endpoint provides data on the average response times for agents in chat sessions. It helps analyze how quickly agents are responding to customer messages, which is crucial for assessing customer service efficiency. +## Authentication + + + Bearer token for authentication + + ### Path Parameters diff --git a/docs/api-reference/endpoint/report/chat-availability.mdx b/docs/api-reference/endpoint/report/chat-availability.mdx index 3336e2636..c4aab6cc3 100644 --- a/docs/api-reference/endpoint/report/chat-availability.mdx +++ b/docs/api-reference/endpoint/report/chat-availability.mdx @@ -4,6 +4,12 @@ api: "GET https://api-v2.opencopilot.so/backend/reports/{orgId}/chats/availabili description: "Retrieve the chat availability statistics for a specified time period" --- +## Authentication + + + Bearer token for authentication + + ### Path Parameters diff --git a/docs/api-reference/endpoint/report/chat-duration.mdx b/docs/api-reference/endpoint/report/chat-duration.mdx index 178487392..ec7fafe59 100644 --- a/docs/api-reference/endpoint/report/chat-duration.mdx +++ b/docs/api-reference/endpoint/report/chat-duration.mdx @@ -4,6 +4,12 @@ api: "GET https://api-v2.opencopilot.so/backend/reports/{orgId}/chats/duration" description: "Retrieve the average duration of chat sessions based on specified criteria" --- +## Authentication + + + Bearer token for authentication + + ### Path Parameters diff --git a/docs/api-reference/endpoint/report/chat-engagement.mdx b/docs/api-reference/endpoint/report/chat-engagement.mdx index ec213ae3c..35e4b5ac8 100644 --- a/docs/api-reference/endpoint/report/chat-engagement.mdx +++ b/docs/api-reference/endpoint/report/chat-engagement.mdx @@ -6,6 +6,12 @@ description: "Retrieve chat engagement metrics for a specified period and organi This endpoint provides chat engagement metrics, including the total number of chats, the number of engaged chats, and the engagement rate. +## Authentication + + + Bearer token for authentication + + ### Path Parameters diff --git a/docs/api-reference/endpoint/report/chat-satisfaction.mdx b/docs/api-reference/endpoint/report/chat-satisfaction.mdx index ca76f5f67..909aa4666 100644 --- a/docs/api-reference/endpoint/report/chat-satisfaction.mdx +++ b/docs/api-reference/endpoint/report/chat-satisfaction.mdx @@ -6,6 +6,12 @@ description: "Retrieve the average satisfaction score for chat sessions" This endpoint returns the average satisfaction score for chat sessions based on the provided query parameters. +## Authentication + + + Bearer token for authentication + + ### Path Parameters diff --git a/docs/api-reference/endpoint/report/insights-alerts.mdx b/docs/api-reference/endpoint/report/insights-alerts.mdx index 679e02369..272c9919d 100644 --- a/docs/api-reference/endpoint/report/insights-alerts.mdx +++ b/docs/api-reference/endpoint/report/insights-alerts.mdx @@ -3,6 +3,11 @@ title: "Get Alerts" api: "GET https://api-v2.opencopilot.so/backend/reports/:orgId/insights/alerts" description: "Retrieve alerts based on predefined thresholds for chat sessions" --- +## Authentication + + + Bearer token for authentication + ### Query Parameters diff --git a/docs/api-reference/endpoint/report/missed-chat.mdx b/docs/api-reference/endpoint/report/missed-chat.mdx index 4be9483e3..f05fdcc8f 100644 --- a/docs/api-reference/endpoint/report/missed-chat.mdx +++ b/docs/api-reference/endpoint/report/missed-chat.mdx @@ -4,6 +4,12 @@ api: "GET https://api-v2.opencopilot.so/backend/reports/{orgId}/chats/missed" description: "Retrieve the count of missed chats based on specified criteria" --- +## Authentication + + + Bearer token for authentication + + ### Path Parameters diff --git a/docs/api-reference/endpoint/report/staffing-prediction.mdx b/docs/api-reference/endpoint/report/staffing-prediction.mdx index 3a90192e2..4ca0384da 100644 --- a/docs/api-reference/endpoint/report/staffing-prediction.mdx +++ b/docs/api-reference/endpoint/report/staffing-prediction.mdx @@ -6,6 +6,12 @@ description: "Retrieve a prediction for staffing needs based on historical chat This endpoint provides a staffing prediction based on historical chat data. It analyzes the number of chats per hour and the number of chats that required human intervention to help optimize agent allocation and improve response times. +## Authentication + + + Bearer token for authentication + + ### Path Parameters diff --git a/docs/api-reference/endpoint/report/total-chats.mdx b/docs/api-reference/endpoint/report/total-chats.mdx index f11668a0d..945137771 100644 --- a/docs/api-reference/endpoint/report/total-chats.mdx +++ b/docs/api-reference/endpoint/report/total-chats.mdx @@ -6,6 +6,12 @@ description: "Retrieve the total number of chat sessions based on specified crit This endpoint returns the total count of chat sessions that match the given query parameters. It can be used to analyze chat volume over time, filtered by various attributes such as channel and status. +## Authentication + + + Bearer token for authentication + + ### Path Parameters