Get Account-Level Metrics

client.r2.buckets.metrics.list(, ?): MetricListResponse { infrequentAccess, standard }

GET/accounts/{account_id}/r2/metrics

Get Storage/Object Count Metrics across all buckets in your account. Note that Account-Level Metrics may not immediately reflect the latest data.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

ParametersExpand Collapse

params: MetricListParams { account_id }

account_id: string

Account ID.

maxLength32

ReturnsExpand Collapse

MetricListResponse { infrequentAccess, standard }

Metrics based on the class they belong to.

infrequentAccess?: InfrequentAccess { published, uploaded }

Metrics based on what state they are in(uploaded or published).

published?: Published { metadataSize, objects, payloadSize }

Metrics on number of objects/amount of storage used.

metadataSize?: number

Amount of.

objects?: number

Number of objects stored.

payloadSize?: number

Amount of storage used by object data.

uploaded?: Uploaded { metadataSize, objects, payloadSize }

Metrics on number of objects/amount of storage used.

metadataSize?: number

Amount of.

objects?: number

Number of objects stored.

payloadSize?: number

Amount of storage used by object data.

standard?: Standard { published, uploaded }

Metrics based on what state they are in(uploaded or published).

published?: Published { metadataSize, objects, payloadSize }

Metrics on number of objects/amount of storage used.

metadataSize?: number

Amount of.

objects?: number

Number of objects stored.

payloadSize?: number

Amount of storage used by object data.

uploaded?: Uploaded { metadataSize, objects, payloadSize }

Metrics on number of objects/amount of storage used.

metadataSize?: number

Amount of.

objects?: number

Number of objects stored.

payloadSize?: number

Amount of storage used by object data.

Get Account-Level Metrics

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const metrics = await client.r2.buckets.metrics.list({
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
});

console.log(metrics.infrequentAccess);

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "result": {
    "infrequentAccess": {
      "published": {
        "metadataSize": 0,
        "objects": 0,
        "payloadSize": 0
      },
      "uploaded": {
        "metadataSize": 0,
        "objects": 0,
        "payloadSize": 0
      }
    },
    "standard": {
      "published": {
        "metadataSize": 0,
        "objects": 0,
        "payloadSize": 0
      },
      "uploaded": {
        "metadataSize": 0,
        "objects": 0,
        "payloadSize": 0
      }
    }
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "result": {
    "infrequentAccess": {
      "published": {
        "metadataSize": 0,
        "objects": 0,
        "payloadSize": 0
      },
      "uploaded": {
        "metadataSize": 0,
        "objects": 0,
        "payloadSize": 0
      }
    },
    "standard": {
      "published": {
        "metadataSize": 0,
        "objects": 0,
        "payloadSize": 0
      },
      "uploaded": {
        "metadataSize": 0,
        "objects": 0,
        "payloadSize": 0
      }
    }
  },
  "success": true
}