# get\_\_bucket\_stats

`GET /bucket/stats`

*Get Bucket Statistics*

Get statistics for storage buckets

#### TypeScript Client Library

```typescript
public getBucketStats = async (params?: { bucketId?: string[] }): Promise<BucketStatsResponse> => {
  const queryParams = new URLSearchParams();
  if (params && params.bucketId && params.bucketId.length > 0) {
    queryParams.append('bucketId', params.bucketId.join(','));
  }
  return this.makeRequest<BucketStatsResponse>(
    `bucket/stats${queryParams.toString() ? `?${queryParams.toString()}` : ''}`,
    'GET',
    null
  );
};
```

#### Code Samples

{% tabs %}
{% tab title="Shell" %}

```shell
# You can also use wget
curl -X GET https://backend.flashback.tech/bucket/stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'
```

{% endtab %}

{% tab title="HTTP" %}

```http
GET https://backend.flashback.tech/bucket/stats HTTP/1.1
Host: localhost:3000
Accept: application/json
```

{% endtab %}

{% tab title="JavaScript" %}

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

fetch('https://backend.flashback.tech/bucket/stats',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
```

{% endtab %}

{% tab title="Ruby" %}

```ruby
require 'rest-client'
require 'json'

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

result = RestClient.get 'https://backend.flashback.tech/bucket/stats',
  params: {
  }, headers: headers

p JSON.parse(result)
```

{% endtab %}

{% tab title="Python" %}

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

r = requests.get('https://backend.flashback.tech/bucket/stats', headers = headers)

print(r.json())
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php

require 'vendor/autoload.php';

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

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

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

 // ...
```

{% endtab %}

{% tab title="Java" %}

```java
URL obj = new URL("https://backend.flashback.tech/bucket/stats");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
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());
```

{% endtab %}

{% tab title="Go" %}

```go
package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://backend.flashback.tech/bucket/stats", data)
    req.Header = headers

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

{% endtab %}
{% endtabs %}

#### Parameters <a href="#get__bucket_stats-parameters" id="get__bucket_stats-parameters"></a>

| Name     | In    | Type   | Required | Description                        |
| -------- | ----- | ------ | -------- | ---------------------------------- |
| bucketId | query | string | false    | Comma-separated list of bucket IDs |

> Example responses

> 200 Response

```json
{
  "success": true,
  "stats": [
    {
      "bucketId": "550e8400-e29b-41d4-a716-446655440000",
      "totalCount": "1250",
      "totalUploadBytes": "1073741824",
      "totalDownloadBytes": "536870912",
      "totalSizeChange": "536870912"
    }
  ]
}
```

#### Responses <a href="#get__bucket_stats-responses" id="get__bucket_stats-responses"></a>

| Status | Meaning                                                 | Description       | Schema |
| ------ | ------------------------------------------------------- | ----------------- | ------ |
| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Bucket statistics | Inline |

#### Response Schema <a href="#get__bucket_stats-responseschema" id="get__bucket_stats-responseschema"></a>

Status Code **200**

| Name                  | Type      | Required | Restrictions | Description                             |
| --------------------- | --------- | -------- | ------------ | --------------------------------------- |
| » success             | boolean   | false    | none         | Indicates if the request was successful |
| » stats               | \[object] | false    | none         | Array of bucket statistics              |
| »» bucketId           | string    | false    | none         | Unique identifier for the bucket        |
| »» totalCount         | string    | false    | none         | Total number of objects in the bucket   |
| »» totalUploadBytes   | string    | false    | none         | Total bytes uploaded to the bucket      |
| »» totalDownloadBytes | string    | false    | none         | Total bytes downloaded from the bucket  |
| »» totalSizeChange    | string    | false    | none         | Net change in bucket size (bytes)       |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.flashback.tech/support-reference/platform-api-reference/storage-apis/bucket-management/get__bucket_stats.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.