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

# Attempt cohort analysis

GET https://api.smallest.ai/atoms/v1/analytics/attempt-cohort

Returns cohort analysis of call attempt numbers, showing how pickup rate changes across the 1st, 2nd, 3rd (etc.) attempts to reach the same number, including cumulative rates and marginal gain per additional attempt.

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

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

Attempt cohort data

- `status` (boolean, optional)
- `data` (AnalyticsAttemptCohortGetResponsesContentApplicationJsonSchemaData, 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

### AnalyticsAttemptCohortGetResponsesContentApplicationJsonSchemaData

- `orgId` (string, optional)
- `cohorts` (list of AnalyticsAttemptCohortGetResponsesContentApplicationJsonSchemaDataCohortsItems, optional)
- `totalUniqueNumbers` (double, optional)
- `maxAttemptsSeen` (double, optional)
- `avgAttemptsToPickup` (double, optional)
- `period` (AnalyticsDateRange, optional)

### AnalyticsAttemptCohortGetResponsesContentApplicationJsonSchemaDataCohortsItems

- `attemptNumber` (double, optional)
- `totalCalls` (double, optional)
- `answeredCalls` (double, optional)
- `pickupRate` (double, optional)
- `cumulativeAnswered` (double, optional)
- `cumulativeRate` (double, optional)
- `marginalGain` (double, optional)

### AnalyticsDateRange

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

## Examples

**Response**

```json
{
  "status": true,
  "data": {
    "orgId": "string",
    "cohorts": [
      {
        "attemptNumber": 1.1,
        "totalCalls": 1.1,
        "answeredCalls": 1.1,
        "pickupRate": 1.1,
        "cumulativeAnswered": 1.1,
        "cumulativeRate": 1.1,
        "marginalGain": 1.1
      }
    ],
    "totalUniqueNumbers": 1.1,
    "maxAttemptsSeen": 1.1,
    "avgAttemptsToPickup": 1.1,
    "period": {
      "from": "2023-01-15",
      "to": "2023-01-15"
    }
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.smallest.ai/atoms/v1/analytics/attempt-cohort"

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

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

print(response.json())
```

```javascript
const url = 'https://api.smallest.ai/atoms/v1/analytics/attempt-cohort';
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/attempt-cohort"

	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/attempt-cohort")

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/attempt-cohort")
  .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/attempt-cohort', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.smallest.ai/atoms/v1/analytics/attempt-cohort");
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/attempt-cohort")! 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()
```