Create Insight

POST

https://api.vapi.ai/reporting/insight

POST

/reporting/insight

curl -X POST https://api.vapi.ai/reporting/insight \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "type": "bar",
  "queries": [
    {
      "column": "id",
      "operation": "count",
      "table": "call",
      "type": "vapiql-json"
    }
  ]
}'

201Created

{
  "type": "bar",
  "createdAt": "2024-01-15T09:30:00Z",
  "id": "string",
  "orgId": "string",
  "queries": [
    {
      "column": "id",
      "filters": [
        {
          "column": "assistantId",
          "operator": "=",
          "value": "string"
        }
      ],
      "name": "Total Calls",
      "operation": "count",
      "table": "call",
      "type": "vapiql-json"
    }
  ],
  "updatedAt": "2024-01-15T09:30:00Z",
  "formulas": [
    {
      "formula": "string",
      "name": "Booking Rate"
    }
  ],
  "groupBy": "assistantId",
  "metadata": {
    "xAxisLabel": "string",
    "yAxisLabel": "string",
    "yAxisMin": 1.1,
    "yAxisMax": 1.1,
    "name": "string"
  },
  "name": "string",
  "systemKey": "string",
  "timeRange": {
    "step": "minute",
    "start": "\"2025-01-01\" or \"-7d\" or \"now\"",
    "end": "\"2025-01-01\" or \"now\"",
    "timezone": "string"
  }
}

Creates a saved reporting insight that queries call data and presents the results as a bar chart, pie chart, line chart, or text value.

Authentication

AuthorizationBearer

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the Vapi Dashboard and send it in the Authorization header as Bearer <token>. Keep private API keys out of client-side code and public repositories.

Request

This endpoint expects an object.

barobjectRequired

Configuration used to create a bar-chart insight from call data using metric queries, formulas, grouping, and a stepped time range.

pieobjectRequired

Configuration used to create a pie-chart insight from call data using metric queries, formulas, grouping, and a time range.

lineobjectRequired

Configuration used to create a line-chart insight from call data using metric queries, formulas, grouping, and a stepped time range.

textobjectRequired

Configuration used to create a text-value insight from call data using metric queries, a formula, and a time range.

Response

barobject

A saved bar-chart insight containing its call-data queries, formulas, grouping, stepped time range, metadata, and lifecycle information.

pieobject

A saved pie-chart insight containing its call-data queries, formulas, grouping, time range, and lifecycle information.

lineobject

A saved line-chart insight containing its call-data queries, formulas, grouping, stepped time range, metadata, and lifecycle information.

textobject

A saved text-value insight containing its call-data queries, formula, time range, and lifecycle information.