We are still updating this page. Some data may be missing here — we will complete it shortly.
Overview
Use Ping.make() to measure the response time of Bitrix24 REST API. The method returns a Promise with a numeric value of the response time in milliseconds.
// Basic usage
const responseTime = await $b24.tools.ping.make()
if (responseTime >= 0) {
console.log(`API response time: ${responseTime}ms`)
} else {
console.error('Failed to measure API response time')
}
Method Signature
make(
options?: { requestId?: string }
): Promise<number>
Parameters
Return Value
Promise<number> — a promise that resolves to a numeric value:
- Positive number — response time in milliseconds from sending the request to receiving the response.
-1— in case of error or timeout.
Examples
Measuring response time
Alternatives and Recommendations
- For availability check: Use
HealthCheck. - For measuring operation performance: Perform time measurements for specific API methods.
- On the client-side (browser): Use the built-in
B24Frameobject.
HealthCheck
Method for checking the availability of Bitrix24 REST API. Performs a simple request to the REST API to verify service health.
Logger
Logger inspired by PHP Monolog, provides a structured logging system with support for channels, handlers, processors, and formatters. Implementation follows PSR-3 principles and the chain of responsibility pattern.