---
title: "Get API Usage"
method: GET
path: "/storage/buckets/{bucketName}/usage/api"
tags: ["Bucket Usage"]
---

# Get API Usage

`GET /storage/buckets/{bucketName}/usage/api`

Returns the detail on API usage on a bucket of a particular time period, group by method category.

## Path parameters

- `bucketName` string, required

## Query parameters

- `filter` object, required
  - `end_time` string, date-time, required — The end time of the period to filter the usage (ISO microsecond format)
  - `start_time` string, date-time, required — The start time of the period to filter the usage (ISO microsecond format)

## Response `200`

Bucket Usage

- object
  - `data` BucketAPIUsageResponse[]
    - `categories` BucketOps[]
      - `bytes_received` integer — The number of bytes received
      - `bytes_sent` integer — The number of bytes sent
      - `category` 'list_bucket' | 'list_buckets' | 'get-bucket_location' | 'create_bucket' | 'stat_bucket' | 'get_bucket_versioning' | 'set_bucket_versioning' | 'get_obj' | 'put_obj' | 'delete_obj' — The category of the bucket operation
      - `ops` integer — The number of operations
      - `successful_ops` integer — The number of successful operations
    - `timestamp` string, date-time — The time the usage was recorded
    - `total` BucketOpsTotal
      - `bytes_received` integer — The number of bytes received
      - `bytes_sent` integer — The number of bytes sent
      - `ops` integer — The number of operations
      - `successful_ops` integer — The number of successful operations

## Other responses

- `401` — Unauthorized
- `404` — Bucket not found
- `422` — Unprocessable Entity

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api-2.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api-2/revisions/1571b0380bd7/schema)