---
title: "List Usage Metrics"
method: GET
path: "/api/v1/beta/usage-metrics"
tags: ["Beta", "Usage Metrics"]
---

# List Usage Metrics

`GET /api/v1/beta/usage-metrics`

List usage metrics with filtering and pagination.

## Query parameters

- `page_size` integer, nullable — Number of items per page
- `page_token` string, nullable — Token for pagination
- `include_total` boolean — Include total count in response
- `project_id` string, uuid, nullable — Filter by project ID
- `user_id` string, nullable — Filter by user ID
- `event_types` string[], nullable — Filter by event types
- `days` string[], nullable — Filter by specific days (YYYY-MM-DD)
- `day_on_or_before` string, nullable — Filter by days on or before this date (YYYY-MM-DD)
- `day_on_or_after` string, nullable — Filter by days on or after this date (YYYY-MM-DD)
- `event_aggregation_type` string, nullable — Filter by event aggregation type
- `event_aggregation_key` string, nullable — Filter by event aggregation key
- `organization_id` string, uuid, required

## Cookies

- `session` string, nullable

## Response `200`

Successful Response

- UsageMetricQueryResponse — Paginated response containing usage metrics.
  - `items` UsageMetric[], required — The list of items.
    - `id` string, uuid, required — The system-generated UUID for the metric
    - `user_id` string, required — The ID of the user
    - `event_type` 'pages_indexed' | 'pages_embedded' | 'pages_parsed' | 'set_total_pages_indexed' | 'set_total_indexes' | 'layout_extracted' | 'layout_aware_parsing' | 'layout_aware_chart_extraction' | 'chart_parsing_agentic' | 'chart_parsing_plus' | 'chart_parsing_efficient' | 'image_classified' | 'precise_bbox_extraction' | 'audio_seconds_parsed' | 'extraction_num_pages' | 'extraction_num_pages_parsed' | 'pages_split' | 'pages_classified' | 'directory_file_count_snapshot' | 'directory_count_snapshot', required — The event type that is emitted
    - `project_id` string, required — The project ID
    - `organization_id` string, required — The organization ID
    - `value` integer, required — The unit measurement associated with the event type
    - `properties` object — Properties associated with the metric
    - `day` string, required — The day the metric was emitted [UTC], in the format 'YYYY-MM-DD'
    - `event_aggregation_key` string, required — The source job identifier, i.e. job_id or file_id
    - `event_aggregation_type` string, required — The source job aggregation type, i.e. pdf
    - `credits` number, nullable — The number of credits consumed by this metric
  - `next_page_token` string, nullable — A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
  - `total_size` integer, nullable — The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/run-llama/apis/llama-platform.md) · [All operations](https://skmtc.net/run-llama/apis/llama-platform/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/run-llama/llama-platform/versions/b17341164de9/schema)