Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding authetication to reporting apis #792

Merged
merged 1 commit into from
Jul 9, 2024
Merged

Adding authetication to reporting apis #792

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/api-reference/endpoint/report/agent-activity.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
6 changes: 6 additions & 0 deletions docs/api-reference/endpoint/report/agent-performance.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
6 changes: 6 additions & 0 deletions docs/api-reference/endpoint/report/agent-response-time.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
6 changes: 6 additions & 0 deletions docs/api-reference/endpoint/report/chat-availability.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
6 changes: 6 additions & 0 deletions docs/api-reference/endpoint/report/chat-duration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
6 changes: 6 additions & 0 deletions docs/api-reference/endpoint/report/chat-engagement.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
6 changes: 6 additions & 0 deletions docs/api-reference/endpoint/report/chat-satisfaction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
5 changes: 5 additions & 0 deletions docs/api-reference/endpoint/report/insights-alerts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 6 additions & 0 deletions docs/api-reference/endpoint/report/missed-chat.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
6 changes: 6 additions & 0 deletions docs/api-reference/endpoint/report/staffing-prediction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
6 changes: 6 additions & 0 deletions docs/api-reference/endpoint/report/total-chats.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
Loading