> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.jelliu.co/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.jelliu.co/_mcp/server.

# Compare inbound and outbound calls

GET https://api.jelliu.co/api/analytics/overview/by-direction

Returns total calls, success rate, average duration and average sentiment separately
for inbound calls, outbound calls and both together. Use it for the "inbound vs
outbound" comparison; for the full KPI set of one direction call
`GET /api/analytics/overview?direction=inbound`.

**Filters.** Only `days` is honoured (rolling window ending now; a missing or
out-of-range value becomes 30). `direction`, `campaignId`, `agentId` and `timezone` are
ignored. This endpoint never answers `400`: if any query parameter fails validation
(an unknown `direction`, a malformed `campaignId`, a `timezone` over 50 characters), the
whole query is discarded and the window silently becomes **90** days.

**How `total` is computed.** `totalCalls` is inbound + outbound. `successRate`,
`avgDuration` and `avgSentiment` are weighted by the calls that carry each measurement,
not averaged across the two directions. `avgDuration` covers completed calls on voice
campaigns and calls without a campaign.

**No data.** A direction without calls comes back as `totalCalls: 0`, `successRate: 0`,
`avgDuration: null`, `avgSentiment: null`, `sentimentCallCount: 0`.

**Idempotency.** Safe to retry: this is a read.

**Consistency.** Cached for 120 seconds per workspace and window. No ETag.

**Access**
- **Required scope:** `read`. Signed-in users need the owner, admin, member or viewer role.
- **Rate limit:** Analytics — 30 requests/min per workspace, in addition to the general API budget of your plan. See [Rate limits](/rate-limits).
- **Plan:** Available on every plan. A workspace without an active subscription (active, trialing or past due) gets `403 BILLING_ERROR`.


Reference: https://developer.jelliu.co/api-reference/analytics/get-analytics-overview-by-direction

## Authentication

- `Authorization` header (bearer token, required) — Workspace API key: `jl_` followed by 64 lowercase hex characters, created by the workspace owner in the dashboard (**Settings → API Keys**) and sent as `Authorization: Bearer jl_...`. The plaintext is shown once, at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys. | Scope | GET / HEAD | POST / PUT / PATCH / DELETE | Admin-only routes | | --- | --- | --- | --- | | `read` | Yes | No | No | | `write` | Yes | Yes | No | | `full` | Yes | Yes | Yes | Operations restricted to admins or owners reject keys without the `full` scope with `403`, and say so in their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret — that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds. See [Authentication](/authentication).

## Request

### Query parameters

- `days` (integer, optional, default: 30) — Size of the reporting window in days, ending now. On most analytics routes a missing or out-of-range value falls back to `30` instead of being rejected; the operation says when it is strict.

## Response

### 200

Metrics per direction and combined.

- `data` (object, optional) — Inbound, outbound and combined metrics. `total` weights each average by the calls that carry the measurement.
  - `inbound` (object, optional) — Call metrics for one direction (or both combined). A direction without calls has zero counts and `null` averages.
    - `totalCalls` (integer, optional) — Calls created in the window, any status.
    - `avgDuration` (integer, optional, nullable) — Mean duration in whole seconds of completed calls on voice campaigns or without a campaign. `null` when there are none.
    - `successRate` (double, optional) — Percentage 0-100 of completed calls whose outcome is a success outcome of any category. `0` when nothing completed.
    - `avgSentiment` (double, optional, nullable) — Mean sentiment (-1 to 1) over scored calls, two decimals. `null` when none were scored.
    - `sentimentCallCount` (integer, optional) — Calls that carried a sentiment score, the denominator of `avgSentiment`.
  - `outbound` (object, optional) — Call metrics for one direction (or both combined). A direction without calls has zero counts and `null` averages.
    - `totalCalls` (integer, optional) — Calls created in the window, any status.
    - `avgDuration` (integer, optional, nullable) — Mean duration in whole seconds of completed calls on voice campaigns or without a campaign. `null` when there are none.
    - `successRate` (double, optional) — Percentage 0-100 of completed calls whose outcome is a success outcome of any category. `0` when nothing completed.
    - `avgSentiment` (double, optional, nullable) — Mean sentiment (-1 to 1) over scored calls, two decimals. `null` when none were scored.
    - `sentimentCallCount` (integer, optional) — Calls that carried a sentiment score, the denominator of `avgSentiment`.
  - `total` (object, optional) — Call metrics for one direction (or both combined). A direction without calls has zero counts and `null` averages.
    - `totalCalls` (integer, optional) — Calls created in the window, any status.
    - `avgDuration` (integer, optional, nullable) — Mean duration in whole seconds of completed calls on voice campaigns or without a campaign. `null` when there are none.
    - `successRate` (double, optional) — Percentage 0-100 of completed calls whose outcome is a success outcome of any category. `0` when nothing completed.
    - `avgSentiment` (double, optional, nullable) — Mean sentiment (-1 to 1) over scored calls, two decimals. `null` when none were scored.
    - `sentimentCallCount` (integer, optional) — Calls that carried a sentiment score, the denominator of `avgSentiment`.

## Errors

### 401 Unauthorized Error

No usable credential. Either the `Authorization` header is missing or is not a well-formed `Bearer jl_…` key, or the key is unknown, revoked or expired. Do not retry with the same key. See [Authentication](/authentication#401-unauthorized).

- `error` (object, required) — The error object. Always has `code` and `message`.
  - `code` (string, required) — Stable machine-readable error code (for example `VALIDATION_FAILED`, `UNAUTHORIZED`, `FORBIDDEN`, `NOT_FOUND`, `BILLING_ERROR`, `COMPLIANCE_BLOCKED`, `RATE_LIMIT_EXCEEDED`, `INTERNAL_ERROR`). Switch on this, not on `message`. See [Errors](/errors).
  - `message` (string, required) — Human-readable explanation. English or Spanish depending on the route; may change without notice.
  - `details` (object or list of object, optional) — Present on `VALIDATION_FAILED` only. Its shape depends on how the route validates: * a field map, either Zod's `flatten()` output (`{ "formErrors": [], "fieldErrors": { "name": ["..."] } }`) or just its `fieldErrors` part (`{ "name": ["..."] }`); * an issue list, where each issue has at least `path`, `message` and `code`. `path` is a dot-separated string on routes that let the schema throw, and an array of keys on routes that forward Zod's raw issues (those also carry Zod's extra issue fields).
    - Field map
      - `formErrors` (list of string, optional)
      - `fieldErrors` (map from string to list of string, optional)
  - `metadata` (map from string to any, optional) — Structured detail exposed for a small allowlist of codes only — for example `BILLING_ERROR` carries `limit`, `current` and `tier` (resource caps) or `tier` and `feature` (feature gates).

### 403 Forbidden Error

No active subscription, a signed-in role outside owner/admin/member/viewer, an API key without the `read` scope, or a suspended workspace.

- `error` (object, required) — The error object. Always has `code` and `message`.
  - `code` (string, required) — Stable machine-readable error code (for example `VALIDATION_FAILED`, `UNAUTHORIZED`, `FORBIDDEN`, `NOT_FOUND`, `BILLING_ERROR`, `COMPLIANCE_BLOCKED`, `RATE_LIMIT_EXCEEDED`, `INTERNAL_ERROR`). Switch on this, not on `message`. See [Errors](/errors).
  - `message` (string, required) — Human-readable explanation. English or Spanish depending on the route; may change without notice.
  - `details` (object or list of object, optional) — Present on `VALIDATION_FAILED` only. Its shape depends on how the route validates: * a field map, either Zod's `flatten()` output (`{ "formErrors": [], "fieldErrors": { "name": ["..."] } }`) or just its `fieldErrors` part (`{ "name": ["..."] }`); * an issue list, where each issue has at least `path`, `message` and `code`. `path` is a dot-separated string on routes that let the schema throw, and an array of keys on routes that forward Zod's raw issues (those also carry Zod's extra issue fields).
    - Field map
      - `formErrors` (list of string, optional)
      - `fieldErrors` (map from string to list of string, optional)
  - `metadata` (map from string to any, optional) — Structured detail exposed for a small allowlist of codes only — for example `BILLING_ERROR` carries `limit`, `current` and `tier` (resource caps) or `tier` and `feature` (feature gates).

### 429 Too Many Requests Error

The analytics budget (30 requests/min) or the plan's general API budget is exhausted.

- `error` (object, required) — The error object. Always has `code` and `message`.
  - `code` (string, required) — Stable machine-readable error code (for example `VALIDATION_FAILED`, `UNAUTHORIZED`, `FORBIDDEN`, `NOT_FOUND`, `BILLING_ERROR`, `COMPLIANCE_BLOCKED`, `RATE_LIMIT_EXCEEDED`, `INTERNAL_ERROR`). Switch on this, not on `message`. See [Errors](/errors).
  - `message` (string, required) — Human-readable explanation. English or Spanish depending on the route; may change without notice.
  - `details` (object or list of object, optional) — Present on `VALIDATION_FAILED` only. Its shape depends on how the route validates: * a field map, either Zod's `flatten()` output (`{ "formErrors": [], "fieldErrors": { "name": ["..."] } }`) or just its `fieldErrors` part (`{ "name": ["..."] }`); * an issue list, where each issue has at least `path`, `message` and `code`. `path` is a dot-separated string on routes that let the schema throw, and an array of keys on routes that forward Zod's raw issues (those also carry Zod's extra issue fields).
    - Field map
      - `formErrors` (list of string, optional)
      - `fieldErrors` (map from string to list of string, optional)
  - `metadata` (map from string to any, optional) — Structured detail exposed for a small allowlist of codes only — for example `BILLING_ERROR` carries `limit`, `current` and `tier` (resource caps) or `tier` and `feature` (feature gates).

## Examples

**Response**

```json
{
  "data": {
    "inbound": {
      "totalCalls": 144,
      "avgDuration": 163,
      "successRate": 31.5,
      "avgSentiment": 0.41,
      "sentimentCallCount": 118
    },
    "outbound": {
      "totalCalls": 268,
      "avgDuration": 197,
      "successRate": 25.11,
      "avgSentiment": 0.3,
      "sentimentCallCount": 180
    },
    "total": {
      "totalCalls": 412,
      "avgDuration": 185,
      "successRate": 27.25,
      "avgSentiment": 0.34,
      "sentimentCallCount": 298
    }
  }
}
```

**SDK Code**

```python Analytics_getAnalyticsOverviewByDirection_example
import requests

url = "https://api.jelliu.co/api/analytics/overview/by-direction"

querystring = {"days":"30"}

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

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

print(response.json())
```

```javascript Analytics_getAnalyticsOverviewByDirection_example
const url = 'https://api.jelliu.co/api/analytics/overview/by-direction?days=30';
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 Analytics_getAnalyticsOverviewByDirection_example
package main

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

func main() {

	url := "https://api.jelliu.co/api/analytics/overview/by-direction?days=30"

	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 Analytics_getAnalyticsOverviewByDirection_example
require 'uri'
require 'net/http'

url = URI("https://api.jelliu.co/api/analytics/overview/by-direction?days=30")

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 Analytics_getAnalyticsOverviewByDirection_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.jelliu.co/api/analytics/overview/by-direction?days=30")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.jelliu.co/api/analytics/overview/by-direction?days=30', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp Analytics_getAnalyticsOverviewByDirection_example
using RestSharp;

var client = new RestClient("https://api.jelliu.co/api/analytics/overview/by-direction?days=30");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Analytics_getAnalyticsOverviewByDirection_example
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.jelliu.co/api/analytics/overview/by-direction?days=30")! 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()
```