Sign in

v1

latestOpenAPI 3.0.02026-07-26870415.2 KB
insights

Get automation rate

Returns the automation-rate metric (human vs AI-handled contact split) for a workspace over a date range: numerator (AI-handled decisions), denominator (all decisions), rate, the echoed range, a formula_version to detect silent formula changes, and a per-day series (one zero-filled entry per calendar day in the range, ascending by date, each with its own numerator/denominator/rate) matching the Insights dashboard automation-rate chart. The top-level numerator/denominator equal the sums over the series. Hits BigQuery, so it carries a dedicated 10 requests/minute per-workspace limit in addition to the general public API limit.

get/v1/insights/automation_rate

Query parameters

workspace_idstring required

Workspace to query.

Example:j57demo8f8x7c9v0n2q4r6t8y1u3i5o
start_datestring required

Inclusive range start (ISO 8601 date).

Example:2026-06-01
end_datestring required

Inclusive range end (ISO 8601 date). Max 90 days from start.

Example:2026-06-30
category_namestring

Optional inbox type / contact category to segment by. Omit for the whole workspace.

Example:guest

Response

Automation-rate metric for the workspace and date range

Example response

{
  "data": {
    "numerator": 40,
    "denominator": 52,
    "rate": 0.7692,
    "range": {
      "start_date": "2026-06-01",
      "end_date": "2026-06-30"
    },
    "formula_version": "2026-07-10",
    "series": [
      {
        "date": "2026-06-01",
        "numerator": 40,
        "denominator": 52,
        "rate": 0.7692
      },
      {
        "date": "2026-06-02",
        "numerator": 0,
        "denominator": 0,
        "rate": 0
      }
    ]
  }
}