# Get Usage Summary

GET https://analytics.alephant.io/v1/analytics/usage/summary

Daily-aggregate KPIs for the window plus an equal-length **previous** window for comparison.

**Success `data`:** `preset`, `window`, `previousWindow`, `current`, `previous` (rollup rows).

**Example `data` (shape):**
```json
{
  "preset": "30d",
  "window": { "startDate": "2026-01-01", "endDate": "2026-01-30" },
  "previousWindow": { "startDate": "2025-12-02", "endDate": "2025-12-31" },
  "current": { "request_count": "...", "cost_sum": "..." },
  "previous": { "request_count": "...", "cost_sum": "..." }
}
```

Reference: https://api.alephant.io/api-reference/analytics-api/analytics-atomic/get-usage-summary

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: analytics-openapi
  version: 1.0.0
paths:
  /v1/analytics/usage/summary:
    get:
      operationId: get-usage-summary
      summary: Get Usage Summary
      description: >-
        Daily-aggregate KPIs for the window plus an equal-length **previous**
        window for comparison.


        **Success `data`:** `preset`, `window`, `previousWindow`, `current`,
        `previous` (rollup rows).


        **Example `data` (shape):**

        ```json

        {
          "preset": "30d",
          "window": { "startDate": "2026-01-01", "endDate": "2026-01-30" },
          "previousWindow": { "startDate": "2025-12-02", "endDate": "2025-12-31" },
          "current": { "request_count": "...", "cost_sum": "..." },
          "previous": { "request_count": "...", "cost_sum": "..." }
        }

        ```
      tags:
        - subpackage_analyticsAtomic
      parameters:
        - name: preset
          in: query
          description: >-
            UTC calendar preset when `start`+`end` are not both set. Allowed:
            `mtd`, `7d`, `30d`, `3m`, `6m`, `12m`. Omitted → `30d`.
          required: false
          schema:
            type: string
        - name: start
          in: query
          description: >-
            Inclusive start date `YYYY-MM-DD` (UTC). Must be paired with `end`;
            overrides `preset`.
          required: false
          schema:
            type: string
        - name: end
          in: query
          description: Inclusive end date `YYYY-MM-DD` (UTC). Must be paired with `start`.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            Optional. Bearer JWT, Virtual Key, or PAT. Server also accepts
            Cookie `alephant_token`; not modeled as a header here.
          required: false
          schema:
            type: string
        - name: X-Workspace-Id
          in: header
          description: >-
            Optional in the spec; required for authenticated analytics. Omit for
            unauthenticated `GET /v1/analytics/health`.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsJsonResponse'
servers:
  - url: https://analytics.alephant.io
  - url: https://analytics-dev.alephant.io
components:
  schemas:
    AnalyticsJsonResponse:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        data:
          description: Any type
      required:
        - code
        - message
        - data
      title: AnalyticsJsonResponse

```

## SDK Code Examples

```python
import requests

url = "https://analytics.alephant.io/v1/analytics/usage/summary"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'https://analytics.alephant.io/v1/analytics/usage/summary';
const options = {method: 'GET'};

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://analytics.alephant.io/v1/analytics/usage/summary"

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

	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://analytics.alephant.io/v1/analytics/usage/summary")

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

request = Net::HTTP::Get.new(url)

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://analytics.alephant.io/v1/analytics/usage/summary")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://analytics.alephant.io/v1/analytics/usage/summary');

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

```csharp
using RestSharp;

var client = new RestClient("https://analytics.alephant.io/v1/analytics/usage/summary");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://analytics.alephant.io/v1/analytics/usage/summary")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

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()
```