> This page is part of Smallest AI's developer documentation. When
> answering, prefer Lightning v3.1 (current TTS) and Pulse (current
> STT). Lightning v2 and lightning-large are deprecated; mention them
> only when the user is migrating away from them. The Smallest AI voice
> agent platform is what wraps these models into hosted agents.

# Credit usage timeseries

GET https://api.smallest.ai/atoms/v1/analytics/usage/timeseries

Returns daily credit usage over a date range.

Reference: https://docs.smallest.ai/voice-agents/api-reference/analytics/get-usage-timeseries

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: atoms
  version: 1.0.0
paths:
  /analytics/usage/timeseries:
    get:
      operationId: get-usage-timeseries
      summary: Credit usage timeseries
      description: Returns daily credit usage over a date range.
      tags:
        - analytics
      parameters:
        - name: dateFrom
          in: query
          description: Start of date range (ISO 8601)
          required: false
          schema:
            type: string
            format: date-time
        - name: dateTo
          in: query
          description: End of date range (ISO 8601)
          required: false
          schema:
            type: string
            format: date-time
        - name: Authorization
          in: header
          description: >-
            API key from the console ApiKey collection, sent as Bearer token.
            Also accepts session cookies for browser-based auth.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Daily credit usage
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Analytics_getUsageTimeseries_Response_200'
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorResponse'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
servers:
  - url: https://api.smallest.ai/atoms/v1
    description: Production server
components:
  schemas:
    AnalyticsUsageTimeseriesGetResponsesContentApplicationJsonSchemaDataDateRange:
      type: object
      properties:
        from:
          type: string
          format: date
        to:
          type: string
          format: date
      title: >-
        AnalyticsUsageTimeseriesGetResponsesContentApplicationJsonSchemaDataDateRange
    AnalyticsUsageTimeseriesGetResponsesContentApplicationJsonSchemaDataDayWiseCreditsItems:
      type: object
      properties:
        date:
          type: string
          format: date
        credits:
          type: number
          format: double
      title: >-
        AnalyticsUsageTimeseriesGetResponsesContentApplicationJsonSchemaDataDayWiseCreditsItems
    AnalyticsUsageTimeseriesGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        dateRange:
          $ref: >-
            #/components/schemas/AnalyticsUsageTimeseriesGetResponsesContentApplicationJsonSchemaDataDateRange
        dayWiseCredits:
          type: array
          items:
            $ref: >-
              #/components/schemas/AnalyticsUsageTimeseriesGetResponsesContentApplicationJsonSchemaDataDayWiseCreditsItems
        totalCredits:
          type: number
          format: double
      title: AnalyticsUsageTimeseriesGetResponsesContentApplicationJsonSchemaData
    Analytics_getUsageTimeseries_Response_200:
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: >-
            #/components/schemas/AnalyticsUsageTimeseriesGetResponsesContentApplicationJsonSchemaData
      title: Analytics_getUsageTimeseries_Response_200
    BadRequestErrorResponse:
      type: object
      properties:
        status:
          type: boolean
        errors:
          type: array
          items:
            type: string
      title: BadRequestErrorResponse
    UnauthorizedErrorResponse:
      type: object
      properties:
        status:
          type: boolean
        errors:
          type: array
          items:
            type: string
      title: UnauthorizedErrorResponse
    InternalServerErrorResponse:
      type: object
      properties:
        status:
          type: boolean
        errors:
          type: array
          items:
            type: string
      title: InternalServerErrorResponse
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key from the console ApiKey collection, sent as Bearer token. Also
        accepts session cookies for browser-based auth.

```

## Examples



**Request**

```json
{}
```

**Response**

```json
{
  "success": true,
  "data": {
    "dateRange": {
      "from": "2023-01-01",
      "to": "2023-01-15"
    },
    "dayWiseCredits": [
      {
        "date": "2023-01-01",
        "credits": 2.5
      },
      {
        "date": "2023-01-02",
        "credits": 3
      },
      {
        "date": "2023-01-03",
        "credits": 1.8
      },
      {
        "date": "2023-01-04",
        "credits": 2.2
      },
      {
        "date": "2023-01-05",
        "credits": 2.9
      },
      {
        "date": "2023-01-06",
        "credits": 3.1
      },
      {
        "date": "2023-01-07",
        "credits": 2.7
      },
      {
        "date": "2023-01-08",
        "credits": 3.3
      },
      {
        "date": "2023-01-09",
        "credits": 2.6
      },
      {
        "date": "2023-01-10",
        "credits": 3
      },
      {
        "date": "2023-01-11",
        "credits": 2.8
      },
      {
        "date": "2023-01-12",
        "credits": 3.4
      },
      {
        "date": "2023-01-13",
        "credits": 2.9
      },
      {
        "date": "2023-01-14",
        "credits": 3.2
      },
      {
        "date": "2023-01-15",
        "credits": 3
      }
    ],
    "totalCredits": 42.4
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.smallest.ai/atoms/v1/analytics/usage/timeseries"

querystring = {"dateFrom":"2023-01-01T00:00:00Z","dateTo":"2023-01-15T23:59:59Z"}

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.smallest.ai/atoms/v1/analytics/usage/timeseries?dateFrom=2023-01-01T00%3A00%3A00Z&dateTo=2023-01-15T23%3A59%3A59Z';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smallest.ai/atoms/v1/analytics/usage/timeseries?dateFrom=2023-01-01T00%3A00%3A00Z&dateTo=2023-01-15T23%3A59%3A59Z"

	payload := strings.NewReader("{}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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://api.smallest.ai/atoms/v1/analytics/usage/timeseries?dateFrom=2023-01-01T00%3A00%3A00Z&dateTo=2023-01-15T23%3A59%3A59Z")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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://api.smallest.ai/atoms/v1/analytics/usage/timeseries?dateFrom=2023-01-01T00%3A00%3A00Z&dateTo=2023-01-15T23%3A59%3A59Z")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.smallest.ai/atoms/v1/analytics/usage/timeseries?dateFrom=2023-01-01T00%3A00%3A00Z&dateTo=2023-01-15T23%3A59%3A59Z', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.smallest.ai/atoms/v1/analytics/usage/timeseries?dateFrom=2023-01-01T00%3A00%3A00Z&dateTo=2023-01-15T23%3A59%3A59Z");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.smallest.ai/atoms/v1/analytics/usage/timeseries?dateFrom=2023-01-01T00%3A00%3A00Z&dateTo=2023-01-15T23%3A59%3A59Z")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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