SDK
SDK Javascript v6.x
1

# getStats

Returns statistics snapshots within a provided timestamp range. By default, snapshots are made every 10 seconds and they are stored for 1 hour.

These statistics include:

  • the number of connected users per protocol (not available for all protocols)
  • the number of ongoing requests
  • the number of completed requests since the last frame
  • the number of failed requests since the last frame

Copied to clipboard!
getStats(startTime, stopTime, [options]);

Arguments Type Description
startTime
number, string
Begining of statistics frame set (timestamp or datetime format)
stopTime
number, string
End of statistics frame set (timestamp or datetime format)
options
object
Query options

# Options

Additional query options

Property Type
(default)
Description
queuable
boolean

(true)
If true, queues the request during downtime, until connected to Kuzzle again

# Resolve

Resolves to an object containing statistics snapshots within the provided range.

# Usage

Copied to clipboard!
try {
  const stats = await kuzzle.server.getStats('1234567890101', '1541426610304');
  console.log('Kuzzle Stats:', JSON.stringify(stats));
} catch (error) {
  console.error(error.message);
}