Get Insights

GET

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

AuthorizationBearer

Retrieve your API Key from Dashboard.

idstringOptional

pagedoubleOptional>=1

This is the page number to return. Defaults to 1.

sortOrderenumOptional

This is the sort order for pagination. Defaults to 'DESC'.

Allowed values:

limitdoubleOptional0-1000

This is the maximum number of items to return. Defaults to 100.

createdAtGtdatetimeOptional

This will return items where the createdAt is greater than the specified value.

createdAtLtdatetimeOptional

This will return items where the createdAt is less than the specified value.

createdAtGedatetimeOptional

This will return items where the createdAt is greater than or equal to the specified value.

createdAtLedatetimeOptional

This will return items where the createdAt is less than or equal to the specified value.

updatedAtGtdatetimeOptional

This will return items where the updatedAt is greater than the specified value.

updatedAtLtdatetimeOptional

This will return items where the updatedAt is less than the specified value.

updatedAtGedatetimeOptional

This will return items where the updatedAt is greater than or equal to the specified value.

updatedAtLedatetimeOptional

This will return items where the updatedAt is less than or equal to the specified value.

resultslist of objects

metadataobject

1	{
2	"results": [
3	{
4	"type": "bar",
5	"id": "a1b2c3d4-e5f6-7890-abcd-1234567890ef",
6	"orgId": "org-9876543210",
7	"createdAt": "2024-01-15T09:30:00Z",
8	"updatedAt": "2024-01-15T09:30:00Z",
9	"name": "Monthly Revenue Overview"
10	}
11	],
12	"metadata": {
13	"itemsPerPage": 10,
14	"totalItems": 50,
15	"currentPage": 1,
16	"itemsBeyondRetention": false,
17	"createdAtLe": "2024-01-15T09:30:00Z",
18	"createdAtGe": "2023-12-01T00:00:00Z"
19	}
20	}

1	{
2	"results": [
3	{
4	"type": "bar",
5	"id": "a1b2c3d4-e5f6-7890-abcd-1234567890ef",
6	"orgId": "org-9876543210",
7	"createdAt": "2024-01-15T09:30:00Z",
8	"updatedAt": "2024-01-15T09:30:00Z",
9	"name": "Monthly Revenue Overview"
10	}
11	],
12	"metadata": {
13	"itemsPerPage": 10,
14	"totalItems": 50,
15	"currentPage": 1,
16	"itemsBeyondRetention": false,
17	"createdAtLe": "2024-01-15T09:30:00Z",
18	"createdAtGe": "2023-12-01T00:00:00Z"
19	}
20	}

$	curl https://api.vapi.ai/reporting/insight \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"