Direct APIAPI Reference

Get API Key Usage

Gets the usage stats for an api key.

Authentication

AuthorizationBearer

API key passed as Bearer token in Authorization header (e.g., “Authorization: Bearer YOUR_API_KEY”)

Query parameters

fromstringOptionalformat: "date"
tostringOptionalformat: "date"

Response

The usage stats for the api key for the timeframe specified.
successCountdouble
Number of successful api requests made with this API Key in the specified timeframe.
errorCountdouble
Number of failed api requests made with this API Key in the specified timeframe.
totalCountdouble
Total number of api requests made with this API Key in the specified timeframe.
averageLatencydouble
The mean latency for all requests made with this API Key in the specified timeframe.
maxLatencydouble
The max latency for all requests made with this API Key in the specified timeframe.
minLatencydouble
The min latency for all requests made with this API Key in the specified timeframe.
medianLatencydouble
The median latency for all requests made with this API Key in the specified timeframe.
p90Latencydouble
The p90 latency for all requests made with this API Key in the specified timeframe.
p95Latencydouble
The p95 latency for all requests made with this API Key in the specified timeframe.
p99Latencydouble
The p99 latency for all requests made with this API Key in the specified timeframe.
p999Latencydouble
The p999 latency for all requests made with this API Key in the specified timeframe.
numberOfSimulationsdouble
The number of simulations initiated with this API Key in the specified timeframe.
numberOfSimulatedTwinsdouble
The number of simulated twins attributable to this API Key in the specified timeframe.
numberOfSnapshotsCreateddouble
The number of snapshots created by this API Key in the specified timeframe.
numberOfSnapshotsTotaldouble
The total number of snapshots that were created in the specified timeframe.
numberOfCoresReprocesseddouble
The number of cores that were processed for snapshots attributable to this API Key in the specified timeframe.
numberOfPsychometricsRequestsdouble
The number of requests this API Key made to retrieve psychometrics in the specified timeframe.
numberOfMindTopicsRequestsdouble
The number of requests this API Key made to retrieve mind topics in the specified timeframe.

Errors