Get Scorecard

GET

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

GET

/observability/scorecard/:id

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

200Retrieved

1 {
2   "id": "a3f47b2e-9c4d-4f1a-8b2e-3d7f9a1c5e6b",
3   "orgId": "org-9f8d7c6b5a4e3d2c1b0a",
4   "createdAt": "2024-01-15T09:30:00Z",
5   "updatedAt": "2024-04-20T14:45:00Z",
6   "metrics": [
7     {
8       "structuredOutputId": "metric-1234abcd-5678-efgh-9012-ijklmnopqrst",
9       "conditions": [
10         {
11           "comparator": ">=",
12           "value": 85,
13           "points": 50,
14           "description": "Score above 85 grants 50 points"
15         },
16         {
17           "comparator": "<",
18           "value": 85,
19           "points": 20,
20           "description": "Score below 85 grants 20 points"
21         }
22       ]
23     }
24   ],
25   "name": "Customer Support Quality Scorecard",
26   "description": "Scorecard to evaluate the quality of customer support calls based on response accuracy and sentiment analysis.",
27   "assistantIds": [
28     "assistant-0011223344556677"
29   ]
30 }

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

{
  "id": "a3f47b2e-9c4d-4f1a-8b2e-3d7f9a1c5e6b",
  "orgId": "org-9f8d7c6b5a4e3d2c1b0a",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-04-20T14:45:00Z",
  "metrics": [
    {
      "structuredOutputId": "metric-1234abcd-5678-efgh-9012-ijklmnopqrst",
      "conditions": [
        {
          "comparator": ">=",
          "value": 85,
          "points": 50,
          "description": "Score above 85 grants 50 points"
        },
        {
          "comparator": "<",
          "value": 85,
          "points": 20,
          "description": "Score below 85 grants 20 points"
        }
      ]
    }
  ],
  "name": "Customer Support Quality Scorecard",
  "description": "Scorecard to evaluate the quality of customer support calls based on response accuracy and sentiment analysis.",
  "assistantIds": [
    "assistant-0011223344556677"
  ]
}

Authentication

AuthorizationBearer

Retrieve your API Key from Dashboard.

Path parameters

idstringRequired

Response

idstring

This is the unique identifier for the scorecard.

orgIdstring

This is the unique identifier for the org that this scorecard belongs to.

createdAtdatetime

This is the ISO 8601 date-time string of when the scorecard was created.

updatedAtdatetime

This is the ISO 8601 date-time string of when the scorecard was last updated.

metricslist of objects

These are the metrics that will be used to evaluate the scorecard. Each metric will have a set of conditions and points that will be used to generate the score.

namestring<=80 characters

This is the name of the scorecard. It is only for user reference and will not be used for any evaluation.

descriptionstring<=500 characters

This is the description of the scorecard. It is only for user reference and will not be used for any evaluation.

assistantIdslist of strings

These are the assistant IDs that this scorecard is linked to. When linked to assistants, this scorecard will be available for evaluation during those assistants' calls.

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

1	{
2	"id": "a3f47b2e-9c4d-4f1a-8b2e-3d7f9a1c5e6b",
3	"orgId": "org-9f8d7c6b5a4e3d2c1b0a",
4	"createdAt": "2024-01-15T09:30:00Z",
5	"updatedAt": "2024-04-20T14:45:00Z",
6	"metrics": [
7	{
8	"structuredOutputId": "metric-1234abcd-5678-efgh-9012-ijklmnopqrst",
9	"conditions": [
10	{
11	"comparator": ">=",
12	"value": 85,
13	"points": 50,
14	"description": "Score above 85 grants 50 points"
15	},
16	{
17	"comparator": "<",
18	"value": 85,
19	"points": 20,
20	"description": "Score below 85 grants 20 points"
21	}
22	]
23	}
24	],
25	"name": "Customer Support Quality Scorecard",
26	"description": "Scorecard to evaluate the quality of customer support calls based on response accuracy and sentiment analysis.",
27	"assistantIds": [
28	"assistant-0011223344556677"
29	]
30	}