> 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.

# Dashboard summary KPIs

GET https://api.smallest.ai/atoms/v1/analytics/summary

Returns high-level KPI metrics with current period value, previous period value, and percent change for trend comparison.

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

## Authentication

- `Authorization` header (bearer token, required) — API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

## Request

### Query parameters

- `agentId` (string, optional) — Comma-separated agent IDs to filter results
- `campaignId` (string, optional) — Campaign ID to filter results
- `callType` (string, optional) — Type of call to filter (e.g. `inbound`, `outbound`)
- `dateFrom` (datetime, optional) — Start of date range (ISO 8601)
- `dateTo` (datetime, optional) — End of date range (ISO 8601)

## Response

### 200

KPI summary

- `status` (boolean, optional)
- `data` (AnalyticsSummaryGetResponsesContentApplicationJsonSchemaData, optional)

## Errors

### 400 Bad Request Error

Invalid input

- `status` (boolean, optional)
- `errors` (list of string, optional)

### 401 Unauthorized Error

Unauthorized access

- `status` (boolean, optional)
- `errors` (list of string, optional)

### 500 Internal Server Error

Internal server error

- `status` (boolean, optional)
- `errors` (list of string, optional)

## Types

### AnalyticsSummaryGetResponsesContentApplicationJsonSchemaData

- `orgId` (string, optional)
- `totalCalls` (AnalyticsTrendMetric, optional) — A metric value with current and previous period values and percent change
- `pickupRate` (AnalyticsTrendMetric, optional) — A metric value with current and previous period values and percent change
- `avgDurationMs` (AnalyticsTrendMetric, optional) — A metric value with current and previous period values and percent change
- `medianDurationMs` (double, optional)
- `totalDurationMs` (AnalyticsTrendMetric, optional) — A metric value with current and previous period values and percent change
- `uniqueUsersReached` (AnalyticsTrendMetric, optional) — A metric value with current and previous period values and percent change
- `totalCost` (AnalyticsTrendMetric, optional) — A metric value with current and previous period values and percent change
- `period` (AnalyticsDateRange, optional)
- `previousPeriod` (AnalyticsDateRange, optional)

### AnalyticsTrendMetric

A metric value with current and previous period values and percent change

- `current` (double, optional)
- `previous` (double, optional)
- `percentChange` (double, optional)

### AnalyticsDateRange

- `from` (date, optional)
- `to` (date, optional)

## Examples

**Response**

```json
{
  "status": true,
  "data": {
    "orgId": "string",
    "totalCalls": {
      "current": 1.1,
      "previous": 1.1,
      "percentChange": 1.1
    },
    "pickupRate": {
      "current": 1.1,
      "previous": 1.1,
      "percentChange": 1.1
    },
    "avgDurationMs": {
      "current": 1.1,
      "previous": 1.1,
      "percentChange": 1.1
    },
    "medianDurationMs": 1.1,
    "totalDurationMs": {
      "current": 1.1,
      "previous": 1.1,
      "percentChange": 1.1
    },
    "uniqueUsersReached": {
      "current": 1.1,
      "previous": 1.1,
      "percentChange": 1.1
    },
    "totalCost": {
      "current": 1.1,
      "previous": 1.1,
      "percentChange": 1.1
    },
    "period": {
      "from": "2023-01-15",
      "to": "2023-01-15"
    },
    "previousPeriod": {
      "from": "2023-01-15",
      "to": "2023-01-15"
    }
  }
}
```

**SDK Code**

```python
import requests

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

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript
const url = 'https://api.smallest.ai/atoms/v1/analytics/summary';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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://api.smallest.ai/atoms/v1/analytics/summary"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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/summary")

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

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

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/summary")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.smallest.ai/atoms/v1/analytics/summary', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.smallest.ai/atoms/v1/analytics/summary");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.smallest.ai/atoms/v1/analytics/summary")! 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()
```