Create Insight

POST

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

POST

/reporting/insight

1 curl -X POST https://api.vapi.ai/reporting/insight \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "type": "bar",
6   "queries": [
7     {
8       "type": "vapiql-json",
9       "table": "call",
10       "column": "id",
11       "operation": "count"
12     }
13   ]
14 }'

Try it

201Created

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

Get Insight

Authentication

AuthorizationBearer

Retrieve your API Key from [Dashboard](dashboard.vapi.ai).

Request

This endpoint expects an object.

CreateBarInsightFromCallTableDTOobjectRequired

OR

CreatePieInsightFromCallTableDTOobjectRequired

OR

CreateLineInsightFromCallTableDTOobjectRequired

OR

CreateTextInsightFromCallTableDTOobjectRequired

Response

barobject

OR

pieobject

OR

lineobject

OR

textobject

Retrieve your API Key from Dashboard.

1	curl -X POST https://api.vapi.ai/reporting/insight \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"type": "bar",
6	"queries": [
7	{
8	"type": "vapiql-json",
9	"table": "call",
10	"column": "id",
11	"operation": "count"
12	}
13	]
14	}'

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