Create Analytics Queries

Authentication

AuthorizationBearer

Retrieve your API Key from Dashboard.

Request

This endpoint expects an object.

querieslist of objectsRequired

This is the list of metric queries you want to perform.

Response

namestring

This is the unique key for the query.

timeRangeobject

This is the time range for the query.

resultlist of objects

This is the result of the query, a list of unique groups with result of their aggregations.

Example: “result”: [ { “date”: “2023-01-01”, “assistantId”: “123”, “endedReason”: “customer-ended-call”, “sumDuration”: 120, “avgCost”: 10.5 }, { “date”: “2023-01-02”, “assistantId”: “123”, “endedReason”: “customer-did-not-give-microphone-permission”, “sumDuration”: 0, “avgCost”: 0 }, // Additional results ]

This is the result of the query, a list of unique groups with result of their aggregations. Example: "result": [ { "date": "2023-01-01", "assistantId": "123", "endedReason": "customer-ended-call", "sumDuration": 120, "avgCost": 10.5 }, { "date": "2023-01-02", "assistantId": "123", "endedReason": "customer-did-not-give-microphone-permission", "sumDuration": 0, "avgCost": 0 }, // Additional results ]

1	from vapi import AnalyticsOperation, AnalyticsQuery, Vapi
2
3	client = Vapi(
4	token="YOUR_TOKEN",
5	)
6	client.analytics.get(
7	queries=[
8	AnalyticsQuery(
9	table="call",
10	name="name",
11	operations=[
12	AnalyticsOperation(
13	operation="sum",
14	column="id",
15	)
16	],
17	)
18	],
19	)

1	[
2	{
3	"name": "string",
4	"timeRange": {
5	"step": "second",
6	"start": "2024-01-15T09:30:00Z",
7	"end": "2024-01-15T09:30:00Z",
8	"timezone": "string"
9	},
10	"result": [
11	{}
12	]
13	}
14	]