# Get workspace usage stats

GET //localhost:8080/api/v1/workspaces/{id}/stats

Returns real-time usage: tier, limits, active VKs/agents/members, logs this period, overage.

Reference: https://api.alephant.io/api-reference/saa-s-api/workspaces/get-workspace-usage-stats

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: saas-openapi
  version: 1.0.0
paths:
  /api/v1/workspaces/{id}/stats:
    get:
      operationId: get-workspace-usage-stats
      summary: Get workspace usage stats
      description: >-
        Returns real-time usage: tier, limits, active VKs/agents/members, logs
        this period, overage.
      tags:
        - subpackage_workspaces
      parameters:
        - name: id
          in: path
          description: Workspace UUID
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: Bearer {access_token}
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 'data: stats'
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/internal_api_handlers_workspaces.WorkspaceStatsResponse
        '400':
          description: BAD_REQUEST (invalid id)
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '401':
          description: AUTH_TOKEN_EXPIRED
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '403':
          description: FORBIDDEN (not a member)
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  description: Any type
servers:
  - url: //localhost:8080
components:
  schemas:
    internal_api_handlers_workspaces.WorkspaceStatsResponse:
      type: object
      properties:
        activeAgents:
          type: integer
        activeMembers:
          type: integer
        activeVks:
          type: integer
        baseVkLimit:
          type: integer
        currentPeriodLogCount:
          type: integer
        extraVkCount:
          type: integer
        logLimit:
          type: integer
        logsThisMonth:
          type: integer
        maxVks:
          type: integer
        overageCents:
          type: integer
        tier:
          type: string
        totalAgents:
          type: integer
        totalMembers:
          type: integer
        workspaceId:
          type: string
      title: internal_api_handlers_workspaces.WorkspaceStatsResponse

```

## SDK Code Examples

```python
import requests

url = "https://localhost:8080/api/v1/workspaces/id/stats"

headers = {"Authorization": "Authorization"}

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

print(response.json())
```

```javascript
const url = 'https://localhost:8080/api/v1/workspaces/id/stats';
const options = {method: 'GET', headers: {Authorization: 'Authorization'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://localhost:8080/api/v1/workspaces/id/stats"

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

	req.Header.Add("Authorization", "Authorization")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://localhost:8080/api/v1/workspaces/id/stats")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Authorization'

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://localhost:8080/api/v1/workspaces/id/stats")
  .header("Authorization", "Authorization")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://localhost:8080/api/v1/workspaces/id/stats', [
  'headers' => [
    'Authorization' => 'Authorization',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://localhost:8080/api/v1/workspaces/id/stats");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Authorization");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Authorization"]

let request = NSMutableURLRequest(url: NSURL(string: "https://localhost:8080/api/v1/workspaces/id/stats")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```