GraphQL reference: event-management-admin
Generated from the schema this service serves, so it cannot fall behind it. The same schema is published as a file for tools and agents.
| Endpoint | https://<your-host>/api/event-management/admin/graphql |
| Auth plane | identity — Instance-scoped administration. Takes the identity token login returns BEFORE a tenant is selected, and is authorized for the superuser or an operator. A tenant access token is rejected here. |
| Authorize with | identity token |
| Schema file | /schema/event-management-admin.graphql |
| Described | 12 of 12 elements |
Queries
tenantEventUsage
One tenant's event usage for each UTC calendar day from from to to, both inclusive,
oldest first. Every figure is counted by INGEST time, the time the platform received
each event, not the time the event is dated. Every day in the range is returned: a day
on which the tenant had no events reads zero, and so does every day of a tenant the
instance does not know (the record does not consult the tenant catalogue). complete
says whether the day's figures are final. Each UTC hour becomes final a few minutes
after it ends, so a day in progress lags by a little over an hour. At most 366 days per
request. Requires the usage:read authority.
Returns [TenantEventUsageDay!]!
| Argument | Type | Description |
|---|---|---|
from | String! | First day, as YYYY-MM-DD (UTC). |
tenant | String! | The tenant's token. |
to | String! | Last day, as YYYY-MM-DD (UTC). |
Objects
TenantEventUsageDay
object
One tenant's event usage on one UTC calendar day, counted from the events the event store holds by the time the platform received them. Devices that are registered but silent are not counted.
| Field | Type | Description |
|---|---|---|
complete | Boolean! | True once every hour of the day is final, after which the day's figures never change. A day still in progress, or one not (or never) fully measured, is false: a zero on such a day means not yet measured, not nothing used. |
day | String! | The day, as YYYY-MM-DD (UTC). |
devicesActive | Int! | Distinct devices with at least one event received on this day. |
devicesAvg | Float! | The mean of the day's 24 hourly distinct-device counts. An hour with no events, or one whose figures are not final yet, counts as zero. |
devicesPeak | Int! | The largest number of distinct devices with an event received in any single UTC hour of the day. |
eventsIngested | Float! | Events the platform received for the tenant on this day, each counted exactly once, as a whole number. A late or backfilled reading counts on the day it was received, never on the day it is dated, so a complete day is never revised. One per event, not per reading; a redelivered duplicate is stored once and counted once. |
tenant | String! | The tenant's token. |