List Scorecards

GET

https://api.vapi.ai/observability/scorecard

GET

/observability/scorecard

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

200Retrieved

1 {
2   "results": [
3     {
4       "id": "a3f1c9d2-4b7e-4f8a-9d3e-2b5f7c6a1e9d",
5       "orgId": "org-9f8b7c6d-1234-5678-90ab-cdef12345678",
6       "createdAt": "2024-01-15T09:30:00Z",
7       "updatedAt": "2024-02-20T14:45:00Z",
8       "metrics": [
9         {
10           "structuredOutputId": "metric-7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
11           "conditions": [
12             {
13               "comparator": ">=",
14               "points": 50,
15               "value": 90
16             },
17             {
18               "comparator": "<",
19               "points": 20,
20               "value": 90
21             }
22           ]
23         }
24       ],
25       "name": "Customer Support Quality Scorecard",
26       "description": "Scorecard evaluating key metrics for customer support call quality and agent performance.",
27       "assistantIds": [
28         "assistant-123e4567-e89b-12d3-a456-426614174000"
29       ]
30     }
31   ],
32   "metadata": {
33     "itemsPerPage": 10,
34     "totalItems": 25,
35     "currentPage": 1,
36     "itemsBeyondRetention": false,
37     "createdAtLe": "2024-03-01T00:00:00Z",
38     "createdAtGe": "2023-12-01T00:00:00Z"
39   }
40 }

Returns scorecards for the authenticated organization. Filter results by ID or creation and update timestamps.

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.

Query parameters

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.

Response

resultslist of objects

The scorecards returned for the current page.

metadataobject

Pagination metadata for the scorecard result set.