API DocumentationAccount
User events histogram
Returns counts of user events over time, grouped by severity level.
Provide either a preset window or a custom from/to range (not both window and from).
Authorization
bearer_auth AuthorizationBearer <token>
OAuth Authentication
OpenScaler API uses OAuth, a standard for secure authorization. To access the API, obtain a token via the OpenScaler Platform.
Use the access_token in the Authorization header for requests:
Authorization: Bearer <token>Always keep your token secure and do not share it with anyone.
In: header
Query Parameters
project_id?string
Limit events to a project. When omitted, returns account-wide counts.
window?string
Preset time window. Mutually exclusive with from.
Value in
- "24h"
- "7d"
- "30d"
- "1y"
from?string
Custom range start (ISO 8601). Mutually exclusive with window.
Format
date-timeto?string
Custom range end (ISO 8601).
Format
date-timeResponse Body
application/json
application/json
text/pain
application/json
application/json
curl -X GET "https://example.com/v1/user-events/histogram"{ "start": 1721606400, "end": 1721692800, "step": 3600, "counts_by_level": { "DEBUG": [ 0 ], "INFO": [ 0 ], "SUCCESS": [ 0 ], "WARNING": [ 0 ], "ERROR": [ 0 ], "property1": [ 0 ], "property2": [ 0 ] }}{ "errors": [ { "message": "'vcpus' field must be an integer", "field": "resource_id" } ]}"Access denied"{ "errors": [ { "message": "User not initialized (missing required fields in token), please init user by sending POST request to `/v1/init` then refresh your token\n" } ]}{ "errors": [ { "message": "VM with ID 23 not found" } ]}