# `dataplan.usage_events`

The `dataplan.usage_events` dataset stores aggregated data usage events for your team. Each event captures a unit of ingestion after ratios have been applied, letting you query your team's consumption alongside any other data in Coralogix using [DataPrime](https://coralogix.com/docs/dataprime/index.md).

Use this dataset to analyze usage trends, build custom dashboards and alerts on top of raw usage events, and correlate consumption with other telemetry — without relying solely on the Data Usage page.

## Enable the dataset

The dataset is exposed through Coralogix's dataset management and is populated only when ingestion is enabled for `dataplan.usage_events`.

1. In the navigation bar, select **Settings**, then **Data Usage**.
1. Select **Settings** in the top-right actions bar to open the Data Usage settings panel.
1. In the **data.usage.history** row, select **Enable data.usage.history**. Coralogix takes you to **Dataspace management**, where you can enable write access for the `dataplan.usage_events` system dataset.

Once ingestion is enabled, new usage events are written to the dataset as they are aggregated. You can return to the settings panel to open the dataset directly in Explore with **View dataset in Explore**.

## Query the dataset

Query `dataplan.usage_events` using DataPrime:

```dataprime
source system/"dataplan.usage_events"
```

Filter and aggregate like any other dataset:

```dataprime
source system/"dataplan.usage_events"
| filter $d.labels.pillar == "logs"
| groupby $d.labels.applicationname aggregate sum($d.measurement.consumed_cx_units) as units
```

## Schema description

Each event represents one aggregated bucket of team data usage for a given logical key and time window, published by Coralogix's data usage exporter after unit ratios have been applied.

| Field                              | Type               | Description                                                                                                                                                                                                                               |
| ---------------------------------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `$d.measurement`                   | object             | The aggregated measurement for the bucket.                                                                                                                                                                                                |
| `$d.measurement.value`             | integer            | Raw measured value for the bucket.                                                                                                                                                                                                        |
| `$d.measurement.kind`              | string             | Measurement kind — for example, `processed_data_size`, `egress_data_size`, `events`, `samples`, `tokens`, or `olly`.                                                                                                                      |
| `$d.measurement.unit`              | string             | Unit of the raw measured value — for example, `bytes`, `events`, `samples`, or `tokens`.                                                                                                                                                  |
| `$d.measurement.consumed_cx_units` | number             | Billable Coralogix units consumed by the raw measured value.                                                                                                                                                                              |
| `$d.timestamp`                     | string (date-time) | UTC timestamp for the usage bucket.                                                                                                                                                                                                       |
| `$d.bucket_duration_millis`        | integer            | Duration of the aggregated usage bucket, in milliseconds.                                                                                                                                                                                 |
| `$d.labels`                        | object             | String-to-string map of Coralogix and user labels for the record. Commonly present keys: `pillar`, `entity_type`, `priority`, `severity`, `feature_id`, `feature_group_id`, `data_space`, `data_set`, `applicationname`, `subsystemname`. |

Note

`$d.labels` is a dynamic string map — reference an individual label as `$d.labels.<key>` (for example, `$d.labels.pillar`). Label values for `severity` and `priority` are lowercase.

## Example queries

Consumed Coralogix units by pillar:

```dataprime
source system/"dataplan.usage_events"
| groupby $d.labels.pillar aggregate sum($d.measurement.consumed_cx_units) as units
| orderby units desc
```

Raw bytes ingested by application over the last 24 hours:

```dataprime
source system/"dataplan.usage_events"
| filter $d.timestamp > now() - 24h && $d.measurement.kind == "processed_data_size"
| groupby $d.labels.applicationname aggregate sum($d.measurement.value) as total_bytes
| orderby total_bytes desc
| limit 5
```

## Notes and limits

- `dataplan.usage_events` is a `system` dataset maintained by Coralogix. Like other system datasets, events count toward your daily quota; volumes are typically small compared to your user data.
- Each event is one aggregated bucket; multiple raw events may be merged into a single usage event per logical key and time window.

## Next steps

- Manage dataset access and retention in [Dataset management](https://coralogix.com/docs/user-guides/data-layer/dataset-management/dataset-management/index.md).
- Track quota activity with [`dataplan.quota_events`](https://coralogix.com/docs/user-guides/data-layer/system_dataspace/quota_events/index.md).
- Audit account actions with [`aaa.audit_events`](https://coralogix.com/docs/user-guides/data-layer/system_dataspace/aaa_audit-events/index.md).