Merge pull request #792 from openchatai/feat/better_docs

Adding authetication to reporting apis
openchatai · Jul 9, 2024 · fef5036 · fef5036
2 parents c2a3d97 + c3bef80
commit fef5036
Show file tree

Hide file tree

Showing 11 changed files with 65 additions and 0 deletions.
diff --git 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.
 </ParamField>
 
+## Authentication
+
+<ParamField header="Authorization" type="string" required>
+  Bearer token for authentication
+</ParamField>
+
 ### Query Parameters
 
 <ParamField query="startDate" type="string" format="date-time" optional>

diff --git 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
+
+<ParamField header="Authorization" type="string" required>
+  Bearer token for authentication
+</ParamField>
+
 ### Path Parameters
 
 <ParamField path="orgId" type="string" required>

diff --git 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
+
+<ParamField header="Authorization" type="string" required>
+  Bearer token for authentication
+</ParamField>
+
 ### Path Parameters
 
 <ParamField path="orgId" type="string" required>

diff --git 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
+
+<ParamField header="Authorization" type="string" required>
+  Bearer token for authentication
+</ParamField>
+
 ### Path Parameters
 
 <ParamField path="orgId" type="string" required>

diff --git 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
+
+<ParamField header="Authorization" type="string" required>
+  Bearer token for authentication
+</ParamField>
+
 ### Path Parameters
 
 <ParamField path="orgId" type="string" required>

diff --git 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
+
+<ParamField header="Authorization" type="string" required>
+  Bearer token for authentication
+</ParamField>
+
 ### Path Parameters
 
 <ParamField path="orgId" type="string" required>

diff --git 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
+
+<ParamField header="Authorization" type="string" required>
+  Bearer token for authentication
+</ParamField>
+
 ### Path Parameters
 
 <ParamField path="orgId" type="string" required>

diff --git 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
+
+<ParamField header="Authorization" type="string" required>
+  Bearer token for authentication
+</ParamField>
 
 ### Query Parameters
 

diff --git 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
+
+<ParamField header="Authorization" type="string" required>
+  Bearer token for authentication
+</ParamField>
+
 ### Path Parameters
 
 <ParamField path="orgId" type="string" required>

diff --git 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
+
+<ParamField header="Authorization" type="string" required>
+  Bearer token for authentication
+</ParamField>
+
 ### Path Parameters
 
 <ParamField path="orgId" type="string" required>

diff --git 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
+
+<ParamField header="Authorization" type="string" required>
+  Bearer token for authentication
+</ParamField>
+
 ### Path Parameters
 
 <ParamField path="orgId" type="string" required>