Get Chat Availability
Retrieve the chat availability statistics for a specified time period
Authentication
Bearer token for authentication
Path Parameters
The ID of the organization to retrieve chat availability for
Query Parameters
The start date for the report period (ISO 8601 format)
The end date for the report period (ISO 8601 format)
The specific channel to filter results (if applicable)
Response
The availability percentage as a number between 0 and 100
An array of objects representing periods of downtime
The start time of the downtime period (ISO 8601 format)
The end time of the downtime period (ISO 8601 format)
The duration of the downtime period in milliseconds
The session ID associated with the downtime period
The total downtime in milliseconds for the specified period
The total time in milliseconds for the specified period
Calculation Method
The chat availability is calculated using the following method:
-
Message Gap Analysis: The system analyzes the time gaps between consecutive messages within the specified date range.
-
Downtime Threshold: A gap of more than 2 minutes between messages is considered as potential downtime.
-
Downtime Calculation: For each gap exceeding 2 minutes, the downtime is calculated as:
Downtime = (Time between messages) - 2 minutes
-
Total Downtime: The system sums up all individual downtimes to get the total downtime.
-
Availability Percentage: The availability percentage is calculated as:
Availability % = ((Total Time - Total Downtime) / Total Time) * 100
Where Total Time is the duration between the specified start and end dates.
Was this page helpful?