Skip to main content

Usage Events screen

The Usage Events screen lists the usage-event collections of your organization. To open it, go to Usage > Usage Events.

Controls

Columns

Click a sortable column header to sort in ascending order. Click it again to sort in descending order. Click it a third time to remove the sorting.

Filters

After you set a filter, click APPLY FILTER. To remove all filters, click Clear All Filters.

Add Usage Event screen

ADD USAGE EVENT on the Usage Events screen opens the Add Usage Event screen. It creates a usage-event collection.

Fields

Actions

Usage-event collection screen

Clicking a usage-event collection on the Usage Events screen opens the screen of the usage-event collection. The screen shows the name of the usage-event collection as its title.

Details

Sample Request window

New field to data schema

NEW FIELD TO DATA SCHEMA expands a form that adds a data field. You cannot remove or rename a data field after you add it. You cannot change its data type either. Usage events that arrived before the data field was added have no value for it.

S3 Ingestion

When your organization has no bucket connection, this area links to Settings instead of showing the controls.

Events Table

The Events Table shows the 20 usage events with the latest timestamp. The newest usage event comes first. The table has one column for each field. A usage event can take a few seconds to show.

Add New Event panel

ADD EVENT stores the usage event. It closes the panel. CANCEL closes the panel without adding a usage event.

Upload CSV window

Export Events window

Permissions

The default Owner role has every permission. The default User role has read permissions only. Sending usage events through the API needs an API key. See API keys.

API reference

The API reference names these operations “usage event”. Each operation acts on a usage-event collection. Sending usage events to a usage-event collection uses its API slug endpoint. The API reference does not list the API slug endpoint. See Send usage events through the API.

Troubleshooting