Analytics
Analytics - Buckets

Get Bucket Usage

Changed on

A bucket's storage, upload and sync usage over time.

Per period: storage_gb_hours, the bytes the bucket held integrated over time from its hourly storage snapshots (GB is 10^9 bytes; time before the first snapshot in the window is not counted); upload_operations, the objects created through the object create endpoints; and sync_operations, the sync runs that finished, successful or failed. Objects a sync creates count under its run, not as uploads.

Credits and estimated cost read 0: storage, uploads and syncs have no price yet, and this route reports quantities until the invoice's price table carries them. The default window is the last 30 days.

get/v1/analytics/buckets/{bucket_id}/usage

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/analytics/buckets/{bucket_id}/usage
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

bucket_idstring required

Query parameters

start_datestring date-time nullable

Start date (UTC)

end_datestring date-time nullable

End date (UTC)

group_bystring

Time grouping: hour, day, week, month

Response

Successful Response

bucket_idstring required

Bucket identifier

total_creditsinteger required

Total credits consumed

total_cost_usdnumber required

Total cost in USD

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • b75474e978ffRevision changes
    • info

      removed the non-success response with the status