App usages

Download AsyncAPI spec

App usage events provide insights into how your Qlik Cloud applications are being used, including session opens, closes, and user interactions with analytics content.

Published when application quota usage is recorded for a tenant. The event provides a snapshot of total quota consumption and per-space usage breakdowns, enabling subscribers to track storage allocation, enforce capacity policies, and optimize resource distribution across spaces.

Payload

object

idstring

Unique identifier for the event.
hoststring

The host that generated the event.
timestring

Timestamp of when the event occurred, in ISO 8601 format.

format = "date-time"
typestring

Unique identifier for the event type.

default = "com.qlik.v1.app-usage.quota.consumed"
sourcestring

The source of the event.

default = "com.qlik/qix-sessions"
owneridstring

The owner ID of the event.
originipstring

The origin IP address of the event source.
specversionstring

The event is compatible with the CloudEvents specification v1.0.

Can be one of: "1.0"
datacontenttypestring

The content type of the event payload.

default = "application/json"
reasonstring

The reason why the event was triggered.
useridstring

The unique identifier for the user related to the event.
spaceidstring

The unique identifier for the space related to the event.
authtypestring

Representing the type of principal that triggered the occurrence.
clientidstring

The unique identifier for the client related to the event.
tenantidstring
Required

The unique identifier for the tenant related to the event.
sessionidstring

The unique identifier for the session related to the event.
authclaimsstring

A JSON string representing claims of the principal that triggered the event.
tracestatestring

A comma-delimited list of key-value pairs for distributed tracing state.
traceparentstring

Contains a version, trace ID, span ID, and trace options in W3C Trace Context format.
toplevelresourceidstring

The unique identifier for the top-level resource related to the event.
dataobject

Represents a snapshot of the total application quota usage for a tenant.
Show data properties
- unitstring
  Required
  
  The unit of measurement for quota usage (currently byte).
  
  Can be one of: "byte"
- quotastring
  Required
  
  The name of the quota being reported.
  
  Can be one of: "appSizeTotalDefault"
- usageinteger
  Required
  
  The total quota usage in the specified unit.
- spaceUsagesarray of objects
  
  The quota usage breakdown per space within the tenant.
  
  Show spaceUsages properties
  
  unitstring
  
  The unit of measurement for the space quota usage (currently byte).
  
  Can be one of: "byte"
  
  usageinteger
  
  The quota usage for this space in the specified unit.
  
  spaceIdstring
  
  The unique identifier for the space.

com.qlik.v1.app-usage.quota.consumed

Example payload of the "App usage quota consumed" event

{
  "id": "id123",
  "host": "qlik.example.com",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.v1.app-usage.quota.consumed",
  "source": "com.qlik/qix-sessions",
  "ownerid": "id123",
  "originip": "192.168.1.1",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "reason": "some reason",
  "userid": "id123",
  "spaceid": "id123",
  "authtype": "qix-sessions",
  "clientid": "id123",
  "tenantid": "id123",
  "sessionid": "id123",
  "authclaims": "{\"iss\": \"qlik.api.internal/qix-sessions\", \"sub\": \"qix-sessions\", \"subType\": \"service\"}",
  "tracestate": "b3=f0cc846cd24db3f68e384e9ccdfbf225-226ac0c507065555-1",
  "traceparent": "00-f0cc846cd24db3f68e384e9ccdfbf225-226ac0c507065555-01",
  "toplevelresourceid": "id123",
  "data": {
    "unit": "byte",
    "quota": "appSizeTotalDefault",
    "usage": 2048
  }
}