Get Bucket Usage

curl --request GET \
  --url https://api.mixpeek.com/v1/analytics/buckets/{bucket_id}/usage \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <api-key>'

import requests

url = "https://api.mixpeek.com/v1/analytics/buckets/{bucket_id}/usage"

headers = {
    "Authorization": "Bearer <token>",
    "X-Namespace": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'X-Namespace': '<api-key>'}
};

fetch('https://api.mixpeek.com/v1/analytics/buckets/{bucket_id}/usage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mixpeek.com/v1/analytics/buckets/{bucket_id}/usage",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Namespace: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mixpeek.com/v1/analytics/buckets/{bucket_id}/usage"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Namespace", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.mixpeek.com/v1/analytics/buckets/{bucket_id}/usage")
  .header("Authorization", "Bearer <token>")
  .header("X-Namespace", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/analytics/buckets/{bucket_id}/usage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "bucket_id": "<string>",
  "time_range": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "metrics": [
    {
      "time_bucket": "2023-11-07T05:31:56Z",
      "storage_gb_hours": 123,
      "upload_operations": 123,
      "sync_operations": 123,
      "total_credits": 123,
      "estimated_cost_usd": 123
    }
  ],
  "cost_breakdown": {
    "storage_percent": 123,
    "upload_percent": 123,
    "sync_percent": 123,
    "other_percent": 123
  },
  "total_credits": 123,
  "total_cost_usd": 123
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

Buckets

Get Bucket Usage

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

analytics

buckets

{bucket_id}

usage

Get Bucket Usage

curl --request GET \
  --url https://api.mixpeek.com/v1/analytics/buckets/{bucket_id}/usage \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <api-key>'

import requests

url = "https://api.mixpeek.com/v1/analytics/buckets/{bucket_id}/usage"

headers = {
    "Authorization": "Bearer <token>",
    "X-Namespace": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'X-Namespace': '<api-key>'}
};

fetch('https://api.mixpeek.com/v1/analytics/buckets/{bucket_id}/usage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mixpeek.com/v1/analytics/buckets/{bucket_id}/usage",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Namespace: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mixpeek.com/v1/analytics/buckets/{bucket_id}/usage"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Namespace", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.mixpeek.com/v1/analytics/buckets/{bucket_id}/usage")
  .header("Authorization", "Bearer <token>")
  .header("X-Namespace", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/analytics/buckets/{bucket_id}/usage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "bucket_id": "<string>",
  "time_range": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "metrics": [
    {
      "time_bucket": "2023-11-07T05:31:56Z",
      "storage_gb_hours": 123,
      "upload_operations": 123,
      "sync_operations": 123,
      "total_credits": 123,
      "estimated_cost_usd": 123
    }
  ],
  "cost_breakdown": {
    "storage_percent": 123,
    "upload_percent": 123,
    "sync_percent": 123,
    "other_percent": 123
  },
  "total_credits": 123,
  "total_cost_usd": 123
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

Authorizations

Authorization

string

header

required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.

X-Namespace

string

header

required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Path Parameters

bucket_id

string

required

Query Parameters

start_date

string<date-time> | null

Start date (UTC)

end_date

string<date-time> | null

End date (UTC)

group_by

string

default:day

Time grouping: hour, day, week, month

Response

Successful Response

Bucket usage and cost analytics response.

bucket_id

string

required

Bucket identifier

time_range

TimeRange · object

required

Query time range

Show child attributes

metrics

UsageMetric · object[]

required

Usage metrics

Show child attributes

cost_breakdown

CostBreakdown · object

required

Cost breakdown

Show child attributes

total_credits

integer

required

Total credits consumed

total_cost_usd

number

required

Total cost in USD

Namespaces

Buckets

Collections

Feature Extractors

Documents

Retrievers

Enrich & Improve

Automate

Administer

Advanced

Get Bucket Usage

Authorizations

Path Parameters

Query Parameters

Response