Preview Insight

Runs an insight definition without first saving it, returning a preview of the resulting 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

idstring

The unique identifier for the insight run.

insightIdstring

The unique identifier for the insight that was run.

orgIdstring

The unique identifier for the organization that owns the run.

createdAtdatetime

The ISO 8601 timestamp when the insight run was created.

updatedAtdatetime

The ISO 8601 timestamp when the insight run was last updated.

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

1	{
2	"id": "string",
3	"insightId": "string",
4	"orgId": "string",
5	"createdAt": "2024-01-15T09:30:00Z",
6	"updatedAt": "2024-01-15T09:30:00Z"
7	}