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 stringrequired

The name of the bucket

Query Parameters

filter[start_time] date-timerequired

The start time of the period to filter the usage (ISO microsecond format)

Examples:

• start_time

Example: 2020-01-01T00:00:00.000Z

filter[end_time] date-timerequired

The end time of the period to filter the usage (ISO microsecond format)

Examples:

• end_time

Example: 2020-01-01T00:00:00.000Z

200: Bucket Usage

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

categories

object[]

Array [

bytes_sent integer

The number of bytes sent

bytes_received integer

The number of bytes received

ops integer

The number of operations

successful_ops integer

The number of successful operations

category string

Possible values: [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

]

total

object

bytes_sent integer

The number of bytes sent

bytes_received integer

The number of bytes received

ops integer

The number of operations

successful_ops integer

The number of successful operations

timestamp date-time

The time the usage was recorded

]

{
  "data": [
    {
      "categories": [
        {
          "bytes_sent": 123456,
          "bytes_received": 123456,
          "ops": 123456,
          "successful_ops": 123456,
          "category": "put_obj"
        }
      ],
      "total": {
        "bytes_sent": 123456,
        "bytes_received": 123456,
        "ops": 123456,
        "successful_ops": 123456
      },
      "timestamp": "2020-01-01T00:00:00Z"
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/storage/buckets/:bucketName/usage/api' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200

---

{
  "data": [
    {
      "categories": [
        {
          "bytes_sent": 123456,
          "bytes_received": 123456,
          "ops": 123456,
          "successful_ops": 123456,
          "category": "put_obj"
        }
      ],
      "total": {
        "bytes_sent": 123456,
        "bytes_received": 123456,
        "ops": 123456,
        "successful_ops": 123456
      },
      "timestamp": "2020-01-01T00:00:00Z"
    }
  ]
}