get__v2_stats_storage_breakdown_by

GET /v2/stats/storage/breakdown/{by}

Get Storage Gateway Breakdown

Storage breakdown by dimension. Use this for breakdowns other than providers.

Parameters

Name	In	Type	Required	Description
scope	query	string	true	Scope level: org, workspace, or repo
id	query	string	false	Required when scope is workspace or repo
window	query	string	true	Time window, e.g. 24h, 7d, 30d
timeBucketSize	query	string	false	Time grouping size, e.g., 1h, 1d
by	path	string	true	The dimension to group by: workspaces, repos, buckets, nodes
includeSeries	query	boolean	false	Include time-series for each entity
limit	query	integer	false	Max entities to return
offset	query	integer	false	Offset for pagination
bucketId	query	string	false	Filter source dataset by Storage Bucket ID
apiKeyId	query	string	false	Filter source dataset by Repo API Key ID

TypeScript Client Library

// Using the Flashgate TypeScript client
import { FlashgateClient } from '@flashgatetech/flashgateclient';

const client = new FlashgateClient({
  accessToken: 'your-access-token'
});

try {
  const result = await client.getStorageGatewayBreakdown('dimension_name', {
    scope: 'org',
    id: 'org-id',
    window: '24h'});
  console.log('Get Storage Gateway Breakdown:', result);
} catch (error) {
  console.error('Failed to retrieve get storage gateway breakdown:', error);
}

Code Samples

Shell

# You can also use wget
curl -X GET "https://backend.flashback.tech/v2/stats/storage/breakdown/dimension?scope=org&id=org-id&window=24h" \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

HTTP

GET /v2/stats/storage/breakdown/dimension?scope=org&id=org-id&window=24h HTTP/1.1
Host: backend.flashback.tech
Accept: application/json
Authorization: Bearer {access-token}

JavaScript

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

const queryParams = new URLSearchParams({
  scope: 'org',
  id: 'org-id',
  window: '24h'
});

fetch(`https://backend.flashback.tech/v2/stats/storage/breakdown/dimension?${queryParams.toString()}`,
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.json();
})
.then(function(body) {
    console.log(body);
});

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://backend.flashback.tech/v2/stats/storage/breakdown/dimension',
  params: {
    scope: 'org',
    id: 'org-id',
    window: '24h'
  }, headers: headers

p JSON.parse(result)

Python

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

params = {
  'scope': 'org',
  'id': 'org-id',
  'window': '24h'
}

r = requests.get('https://backend.flashback.tech/v2/stats/storage/breakdown/dimension', headers=headers, params=params)

print(r.json())

PHP

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

$queryParams = array(
    'scope' => 'org',
    'id' => 'org-id',
    'window' => '24h'
);

try {
    $response = $client->request('GET','https://backend.flashback.tech/v2/stats/storage/breakdown/dimension', array(
        'headers' => $headers,
        'query' => $queryParams,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

Java

import java.net.HttpURLConnection;
import java.net.URL;
import java.io.BufferedReader;
import java.io.InputStreamReader;

String baseUrl = "https://backend.flashback.tech/v2/stats/storage/breakdown/dimension";
String queryString = "scope=org&id=org-id&window=24h";
URL obj = new URL(baseUrl + "?" + queryString);
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
con.setRequestProperty("Accept", "application/json");
con.setRequestProperty("Authorization", "Bearer {access-token}");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Go

package main

import (
       "net/http"
       "net/url"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    params := url.Values{}
    params.Add("scope", "org")
    params.Add("id", "org-id")
    params.Add("window", "24h")

    req, err := http.NewRequest("GET", "https://backend.flashback.tech/v2/stats/storage/breakdown/dimension?" + params.Encode(), nil)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Example responses 200 Response

{
  "success": true,
  "meta": {
    "start": 1704067200,
    "end": 1704153600,
    "scope": "org",
    "window": "24h",
    "timeBucketSize": "1h"
  },
  "summary": {
    "total": 1500,
    "avg": 50,
    "stdDev": 10,
    "min": 0,
    "max": 100,
    "p10": 10,
    "p50": 50,
    "p90": 90
  },
  "entities": [
    {
      "entityId": "example-id",
      "entityName": "Example Entity",
      "totals": {
        // domain specific metrics
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful request	Inline
400	Bad Request	Invalid request parameters	Inline
500	Internal Server Error	Internal server error	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» success	boolean	true	none	Indicates if the request was successful
» meta	object	true	none	Metadata for the response
» summary	object	true	none	Statistical summary
» entities	[object]	true	none	Array of breakdown entities
»» entityId	string	true	none	The dimension ID
»» entityName	string	false	none	The dimension Name (if applicable)
»» totals	object	true	none	Total metrics for this entity
»»» uplBytes	integer	true	none	Uploaded bytes
»»» dwlBytes	integer	true	none	Downloaded bytes
»»» sizeChange	integer	true	none	Net size change
»»» latencyMs	number	true	none	Average latency in ms
»»» requests	integer	true	none	Total requests
»» series	[object]	false	none	Time-series data for this entity (if requested)
»»» ts	integer	true	none	Unix timestamp
»»» uplBytes	integer	true	none	Uploaded bytes
»»» dwlBytes	integer	true	none	Downloaded bytes
»»» sizeChange	integer	true	none	Net size change
»»» latencyMs	number	true	none	Average latency in ms
»»» requests	integer	true	none	Total requests

Status Code 400

Name	Type	Required	Restrictions	Description
» success	boolean	true	none	Always false for error responses
» message	string	true	none	Error message

Status Code 500

Name	Type	Required	Restrictions	Description
» success	boolean	true	none	Always false for error responses
» message	string	true	none	Error message