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

1 {
2   "type": "bar",
3   "createdAt": "2024-01-15T09:30:00Z",
4   "id": "string",
5   "orgId": "string",
6   "queries": [
7     {
8       "column": "id",
9       "filters": [
10         {
11           "column": "assistantId",
12           "operator": "=",
13           "value": "string"
14         }
15       ],
16       "name": "Total Calls",
17       "operation": "count",
18       "table": "call",
19       "type": "vapiql-json"
20     }
21   ],
22   "updatedAt": "2024-01-15T09:30:00Z",
23   "formulas": [
24     {
25       "formula": "string",
26       "name": "Booking Rate"
27     }
28   ],
29   "groupBy": "assistantId",
30   "metadata": {
31     "xAxisLabel": "string",
32     "yAxisLabel": "string",
33     "yAxisMin": 1.1,
34     "yAxisMax": 1.1,
35     "name": "string"
36   },
37   "name": "string",
38   "timeRange": {
39     "step": "minute",
40     "start": "\"2025-01-01\" or \"-7d\" or \"now\"",
41     "end": "\"2025-01-01\" or \"now\"",
42     "timezone": "string"
43   }
44 }

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.

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the [Vapi Dashboard](https://dashboard.vapi.ai) 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.