Jelliu API documentation

{
  "data": [
    {
      "type": "roi_analysis",
      "name": "ROI Analysis",
      "description": "Calculates cost savings vs. human agents, total COGS, and return on investment for AI-powered calls."
    },
    {
      "type": "campaign_comparison",
      "name": "Campaign Comparison",
      "description": "Side-by-side comparison of campaigns ranked by success rate, including calls, duration, sentiment, and cost."
    },
    {
      "type": "cost_per_call",
      "name": "Cost Per Call",
      "description": "Time-series breakdown of cost per call and cost per minute, grouped by day."
    },
    {
      "type": "agent_performance",
      "name": "Agent Performance",
      "description": "Ranks AI agents by success rate with outcome breakdowns, average duration, and sentiment scores."
    },
    {
      "type": "contact_funnel",
      "name": "Contact Funnel",
      "description": "Funnel analysis showing contacts by status (PENDING, CALLED, CONVERTED, DNC) with conversion rates."
    }
  ]
}

Returns the fixed catalog of report types that POST /api/reports can generate, each with a display name and a description. The list is static and not paginated.

The description text of campaign_comparison and agent_performance still says “success rate”. It is display copy returned verbatim by the server and has not been reworded yet; the figure those reports return is the CONNECTION rate — the share of dials that were answered — and since 2026-09-16 the field is named connectionRate. Do not infer the field name from this text.

Consistency. Sent with Cache-Control: public, max-age=86400, so clients and proxies may cache it for a day. It only changes when Jelliu ships a new report type.

Idempotency. A read with no side effects. Safe to retry.

Access

Required scope: read or write. Human users need the owner, admin, member or viewer role; billing users are refused.
Rate limit: General API — 120 requests/min per workspace on Starter or with no active plan, 200 on Growth, 300 on Business, 600 on Enterprise. See Rate limits.
Plan: Requires an active subscription (active, trialing or past_due); without one the request is refused with 403 BILLING_ERROR (metadata.kind: subscription_required).

Authentication

AuthorizationBearer

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.

Response headers

Cache-ControlstringOptional

Public cache for one day.

Response

The report catalog, in a fixed order.

datalist of objects

Always the same five entries.

Errors

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error