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

id string

Unique identifier for the event.
host string

The host that generated the event.
time string

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

format = "date-time"
type string

Unique identifier for the event type.

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

The source of the event.

default = "com.qlik/qix-sessions"
ownerid string

The owner ID of the event.
originip string

The origin IP address of the event source.
specversion string

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

Can be one of: "1.0"
datacontenttype string

The content type of the event payload.

default = "application/json"
reason string

The reason why the event was triggered.
userid string

The unique identifier for the user related to the event.
spaceid string

The unique identifier for the space related to the event.
authtype string

Representing the type of principal that triggered the occurrence.
clientid string

The unique identifier for the client related to the event.
tenantid string

Required

The unique identifier for the tenant related to the event.
sessionid string

The unique identifier for the session related to the event.
authclaims string

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

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

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

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

Represents a snapshot of the total application quota usage for a tenant.
Show data properties
- unit string
  
  Required
  
  The unit of measurement for quota usage (currently byte).
  
  Can be one of: "byte"
- quota string
  
  Required
  
  The name of the quota being reported.
  
  Can be one of: "appSizeTotalDefault"
- usage integer
  
  Required
  
  The total quota usage in the specified unit.
- spaceUsages array of objects
  
  The quota usage breakdown per space within the tenant.
  
  Show spaceUsages properties
  
  unit string
  
  The unit of measurement for the space quota usage (currently byte).
  
  Can be one of: "byte"
  
  usage integer
  
  The quota usage for this space in the specified unit.
  
  spaceId string
  
  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": "service_account",
  "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
  }
}