ColdStack Docs
  • Introduction
  • ColdStack FAQ
  • Binance Smart Chain Bridge
    • Release
    • Customer Support
    • FAQ
    • Step-by-Step Guide
  • Concepts
    • Bucket versioning
    • Logging actions with a bucket
  • Tools
    • Supported tools
      • CyberDuck S3 Client
      • S3 Browser
      • AWS CLI Console client
      • SDKs for different languages
        • JavaScript SDK
        • Using extended API with JavaScript
        • AWS SDK for Java
        • Python SDK (boto)
  • S3 Compatible API
    • How to use the API
    • Signing Requests
    • API Reference
      • Bucket
        • HeadBucket
        • ListObjects/ListObjectsV2
        • PutBucketVersioning
        • PutBucketLogging
        • RenameBucket
        • GetBucketLocation
        • ListBuckets
      • Object
        • PutObject
        • GetObject
        • HeadObject
        • RenameObject
        • PutObjectAcl
      • Multipart upload
        • General multipart upload order
        • CreateMultipartUpload
        • UploadPart
        • CompleteMultipartUpload
        • ListMultipartUploads
      • Analytics
        • GetStatistics
        • GetBandwidthAnalytics
        • GetStorageAnalytics
      • Common request headers
      • Common response headers
      • Responses
Powered by GitBook
On this page
  • Request
  • Response

Was this helpful?

  1. S3 Compatible API
  2. API Reference
  3. Analytics

GetStorageAnalytics

PreviousGetBandwidthAnalyticsNextCommon request headers

Last updated 3 years ago

Was this helpful?

Returns storage analytics over time.

This operation is an extension to the standard S3 API, and is implemented to provide more information to the about their usage.

Request

GET /?storageAnalytics&fromDate={FromDate}&toDate={ToDate}&format={json/xml} HTTP/1.1

Response

Headings

The response can only contain .

Response codes

For a list of possible answers, see the section .

The successful response contains additional data in XML format, the schema of which is described below.

Data schema

<?xml version="1.0" encoding="UTF-8"?>
<StorageUsageAnalytics>
  <Record>
    <Timestamp>2021-08-13</Timestamp>
    <UsedStorage>0</UsedStorage>
    <UsedStorageReadable>0 B</UsedStorageReadable>
  </Record>
  ...
</StorageUsageAnalytics>

Element

Description

StorageUsageAnalytics

Root element.

Record

Array of records of analytics. There is only one record for an hour, but if no bandwidth was used for a specific hour then no record for that hour will be available.

Timestamp

Date and hour of the record

UsedStorage

Used storage at that timestamp.

UsedStorageReadable

Used storage at that timestamp in readable format.

general headers
Answers