> 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. # Retrieve the call overview GET https://api.jelliu.co/api/analytics/overview Returns the headline call KPIs for a rolling window: interactions, completed calls, successes, success rate, average duration, average sentiment (with its sample size), per-outcome counts and a breakdown by campaign channel and category, plus workspace-wide totals of agents, campaigns and contacts. **Filters.** `days` sets the window (rolling, ending now; missing or out-of-range values silently become 30). `direction`, `campaignId` and `agentId` narrow every call-activity number, including `outcomeBreakdown` and `channelBreakdown`. The entity counts (`totalAgents`, `totalCampaigns`, `activeCampaigns`, `totalContacts`, `convertedContacts`, `dncContacts`) are never windowed or filtered: they answer "how much do you have", not "what happened". `timezone` is accepted but not used (a value longer than 50 characters is still a `400`). **What counts as a success.** A completed call whose outcome is a success outcome of any campaign category (`sale_closed`, `appointment_booked`, `info_provided`, `issue_resolved`, `callback_scheduled`, `payment_promised`, ...). For the stricter, category-specific definition of one campaign, use `GET /api/analytics/campaigns/{campaignId}`. `channelBreakdown` only includes calls that belong to a campaign; manual and unassigned inbound calls count in the totals only. **No data.** Counts and `successRate` are `0`; `avgSentiment` is `null` when no call in the window was scored (`sentimentCallCount` is `0`). `avgDurationSeconds` is `null` when the breakdown has no voice campaign, and `0` when it does but no call completed. **Idempotency.** Safe to retry: this is a read. **Consistency.** Cached for 120 seconds, then served stale for up to 15 minutes while a background refresh runs. The response carries a weak `ETag`; send it back in `If-None-Match` to get `304 Not Modified` when the numbers have not changed. **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 ## 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. - `direction` (enum, optional, default: all) — Which calls to count: `inbound` (calls the agent answered), `outbound` (calls the agent placed) or `all` (both). - Allowed values: `inbound`, `outbound`, `all` - `campaignId` (string, optional) — Scope every number to one campaign of the workspace. Omit it to aggregate across all campaigns and manual calls. - `agentId` (string, optional) — Scope every number to one agent — the agent that served each call, so manual (campaign-less) calls count. Omit it to aggregate across agents. ## Response ### 200 The overview for the requested window. - `data` (object, optional) — Headline call KPIs. Call-activity numbers (interactions, outcomes, sentiment, duration, channel breakdown) cover the requested window and filters. Entity counts (agents, campaigns, contacts) are workspace-wide totals that ignore the window and every filter. Counts and rates are `0` when there is no data; averages are `null`. - `totalInteractions` (integer, optional) — Calls created in the window, any status. - `completedInteractions` (integer, optional) — Calls in the window with status `completed`. - `successes` (integer, optional) — Completed calls whose outcome is a success outcome of any category (`sale_closed`, `appointment_booked`, `info_provided`, `callback_scheduled`, ...). - `successRate` (double, optional) — Percentage 0-100, `successes / completedInteractions`, two decimals. `0` when nothing completed. - `avgDurationSeconds` (integer, optional, nullable) — Mean duration of completed calls in whole seconds. `null` when `channelBreakdown` has no voice item; `0` when it does but no call completed. - `avgSentiment` (double, optional, nullable) — Mean sentiment (-1 to 1) over scored calls, two decimals. `null` when none were scored (never `0`, which is a real neutral reading). - `sentimentCallCount` (integer, optional) — Calls that carried a sentiment score, the denominator of `avgSentiment`. - `totalAgents` (integer, optional) — Agents in the workspace (not deleted). Not windowed. - `totalCampaigns` (integer, optional) — Campaigns in the workspace (not deleted), any status. Not windowed. - `activeCampaigns` (integer, optional) — Campaigns with status `active`. Not windowed. - `totalContacts` (integer, optional) — Contacts across all campaigns (not deleted). Not windowed. - `convertedContacts` (integer, optional) — Contacts with status `converted`. Not windowed. - `dncContacts` (integer, optional) — Contacts with status `dnc` (do not call). Not windowed. - `channelBreakdown` (list of object, optional) — Window calls that belong to a campaign, grouped by campaign channel and category. `[]` when there are none. - `channel` (string, optional) — Campaign channel: `voice`, `whatsapp`, `webchat` or `email` (`voice` when the campaign has none). - `category` (string, optional) — Campaign category as stored (`sales` when the campaign has none), for example `sales`, `support`, `scheduling`, `surveys`, `collections`. - `interactions` (integer, optional) — Calls of this channel and category in the window, any status. - `completed` (integer, optional) — Of those, calls with status `completed`. - `successes` (integer, optional) — Completed calls whose outcome is a success outcome of any category. - `successRate` (double, optional) — Percentage 0-100, `successes / completed`, two decimals. `0` when nothing completed. - `successRateLabel` (enum, optional) — Category-specific name of the success rate: `conversionRate` (sales), `resolutionRate` (support), `bookingRate` (scheduling), `completionRate` (surveys), `recoveryRate` (collections), `retentionRate` (retention), `deliveryRate` (notifications), `interviewRate` (interview), `assessmentRate` (language_assessment), `successRate` (personal, general and anything else). - Allowed values: `conversionRate`, `resolutionRate`, `bookingRate`, `completionRate`, `recoveryRate`, `retentionRate`, `deliveryRate`, `interviewRate`, `assessmentRate`, `successRate` - `avgDurationSeconds` (integer, optional, nullable) — Mean duration of completed calls in whole seconds. `null` for non-voice channels; `0` for voice when nothing completed. - `excludedMetrics` (list of enum, optional) — Metrics that do not apply to this channel and category: `averageDurationSeconds`, `callsByHour` and `prepaidMinutes` for non-voice channels; `conversionRate` for `support` and `scheduling`. - Allowed values: `averageDurationSeconds`, `callsByHour`, `prepaidMinutes`, `conversionRate` - `outcomeBreakdown` (map from string to integer, optional) — Number of calls per outcome value in the window, any status. Outcomes with no calls are absent; `{}` when no call has an outcome. ## Errors ### 400 Bad Request Error `direction` is not `inbound`, `outbound` or `all`, `campaignId` or `agentId` is not a UUID, or `timezone` is longer than 50 characters. - `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). ### 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": { "totalInteractions": 412, "completedInteractions": 356, "successes": 97, "successRate": 27.25, "avgDurationSeconds": 184, "avgSentiment": 0.34, "sentimentCallCount": 298, "totalAgents": 4, "totalCampaigns": 7, "activeCampaigns": 3, "totalContacts": 2850, "convertedContacts": 214, "dncContacts": 37, "channelBreakdown": [ { "channel": "voice", "category": "sales", "interactions": 268, "completed": 231, "successes": 71, "successRate": 30.74, "successRateLabel": "conversionRate", "avgDurationSeconds": 201, "excludedMetrics": [] }, { "channel": "voice", "category": "scheduling", "interactions": 96, "completed": 88, "successes": 22, "successRate": 25, "successRateLabel": "bookingRate", "avgDurationSeconds": 142, "excludedMetrics": [ "conversionRate" ] } ], "outcomeBreakdown": { "appointment_booked": 22, "follow_up_needed": 33, "info_provided": 17, "no_answer": 41, "rejected": 64, "sale_closed": 58, "voicemail": 29 } } } ``` **SDK Code** ```python Analytics_getAnalyticsOverview_example import requests url = "https://api.jelliu.co/api/analytics/overview" querystring = {"agentId":"2f2d8b4d-aa6f-41e0-9d3e-4d61e1b07a11","campaignId":"0f3c8b52-6d1a-4e2f-9b7c-4a5e6d7f8a90","days":"30","direction":"outbound"} headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript Analytics_getAnalyticsOverview_example const url = 'https://api.jelliu.co/api/analytics/overview?agentId=2f2d8b4d-aa6f-41e0-9d3e-4d61e1b07a11&campaignId=0f3c8b52-6d1a-4e2f-9b7c-4a5e6d7f8a90&days=30&direction=outbound'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Analytics_getAnalyticsOverview_example package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.jelliu.co/api/analytics/overview?agentId=2f2d8b4d-aa6f-41e0-9d3e-4d61e1b07a11&campaignId=0f3c8b52-6d1a-4e2f-9b7c-4a5e6d7f8a90&days=30&direction=outbound" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Analytics_getAnalyticsOverview_example require 'uri' require 'net/http' url = URI("https://api.jelliu.co/api/analytics/overview?agentId=2f2d8b4d-aa6f-41e0-9d3e-4d61e1b07a11&campaignId=0f3c8b52-6d1a-4e2f-9b7c-4a5e6d7f8a90&days=30&direction=outbound") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java Analytics_getAnalyticsOverview_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.jelliu.co/api/analytics/overview?agentId=2f2d8b4d-aa6f-41e0-9d3e-4d61e1b07a11&campaignId=0f3c8b52-6d1a-4e2f-9b7c-4a5e6d7f8a90&days=30&direction=outbound") .header("Authorization", "Bearer ") .asString(); ``` ```php Analytics_getAnalyticsOverview_example request('GET', 'https://api.jelliu.co/api/analytics/overview?agentId=2f2d8b4d-aa6f-41e0-9d3e-4d61e1b07a11&campaignId=0f3c8b52-6d1a-4e2f-9b7c-4a5e6d7f8a90&days=30&direction=outbound', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp Analytics_getAnalyticsOverview_example using RestSharp; var client = new RestClient("https://api.jelliu.co/api/analytics/overview?agentId=2f2d8b4d-aa6f-41e0-9d3e-4d61e1b07a11&campaignId=0f3c8b52-6d1a-4e2f-9b7c-4a5e6d7f8a90&days=30&direction=outbound"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift Analytics_getAnalyticsOverview_example import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.jelliu.co/api/analytics/overview?agentId=2f2d8b4d-aa6f-41e0-9d3e-4d61e1b07a11&campaignId=0f3c8b52-6d1a-4e2f-9b7c-4a5e6d7f8a90&days=30&direction=outbound")! 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() ```