---
title: "Scorecard data model"
url: "https://docs.unified.to/uc/scorecard/model"
description: "The Scorecard data model object in Unified's Scorecard API: 12 fields, including created_at, updated_at and call_id, with types and enum values."
---
# Scorecard data model

 View field support, webhooks, and list parameters for each integration on the [Supported Integrations](https://docs.unified.to/uc/integrations.md) page. 

| Field                              | Type                                                                                         | Required | Description                                                                                                                       |
| ---------------------------------- | -------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------- |
| id                                 | string                                                                                       | No       |                                                                                                                                   |
| created\_at                        | string (date-time)                                                                           | No       | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)                                                                                          |
| updated\_at                        | string (date-time)                                                                           | No       | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)                                                                                          |
| call\_id                           | string                                                                                       | No       |                                                                                                                                   |
| scorecardtemplate\_id              | string                                                                                       | No       |                                                                                                                                   |
| name                               | string                                                                                       | No       | name of the scorecard template that was filled in                                                                                 |
| user\_id                           | string                                                                                       | No       | the user being reviewed; reference to HrisEmployee (reference to HrisEmployee)                                                    |
| reviewer\_user\_id                 | string                                                                                       | No       | the user who filled in the scorecard; reference to HrisEmployee (reference to HrisEmployee)                                       |
| reviewed\_at                       | string (date-time)                                                                           | No       | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)                                                                                          |
| score                              | number                                                                                       | No       | overall score                                                                                                                     |
| questions                          | [UcScorecardQuestion](https://docs.unified.to/uc/scorecard/model.md#UcScorecardQuestion)\[\] | No       |                                                                                                                                   |
| questions\[\].question\_identifier | string                                                                                       | No       |                                                                                                                                   |
| questions\[\].text                 | string                                                                                       | No       |                                                                                                                                   |
| questions\[\].answer               | string                                                                                       | No       |                                                                                                                                   |
| questions\[\].score                | number                                                                                       | No       |                                                                                                                                   |
| questions\[\].is\_not\_applicable  | boolean                                                                                      | No       |                                                                                                                                   |
| metadata                           | [UcMetadata](https://docs.unified.to/uc/scorecard/model.md#UcMetadata)\[\]                   | No       |                                                                                                                                   |
| metadata\[\].id                    | string                                                                                       | No       |                                                                                                                                   |
| metadata\[\].slug                  | string                                                                                       | No       |                                                                                                                                   |
| metadata\[\].value                 | object                                                                                       | No       |                                                                                                                                   |
| metadata\[\].namespace             | string                                                                                       | No       |                                                                                                                                   |
| metadata\[\].format                | enum                                                                                         | No       | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE\_SELECT, MULTIPLE\_SELECT, MEASUREMENT, PRICE, YES\_NO, CURRENCY, URL |
| metadata\[\].extra\_data           | object                                                                                       | No       |                                                                                                                                   |

## TypeScript

```typescript
export type UcScorecard = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	call_id?: string;
	scorecardtemplate_id?: string;
	name?: string; // name of the scorecard template that was filled in
	user_id?: string; // the user being reviewed; reference to HrisEmployee (reference to HrisEmployee)
	reviewer_user_id?: string; // the user who filled in the scorecard; reference to HrisEmployee (reference to HrisEmployee)
	reviewed_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	score?: number; // overall score
	questions?: [];
	metadata?: [];
	raw?: any;
} 
```

## Zod

```typescript
import { z } from 'zod';

export const ZodUcScorecard = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	call_id: z.string().optional(),
	scorecardtemplate_id: z.string().optional(),
	name: z.string().optional().describe("name of the scorecard template that was filled in"),
	user_id: z.string().optional().describe("the user being reviewed; reference to HrisEmployee (reference to HrisEmployee)"),
	reviewer_user_id: z.string().optional().describe("the user who filled in the scorecard; reference to HrisEmployee (reference to HrisEmployee)"),
	reviewed_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	score: z.number().optional().describe("overall score"),
	questions: z.array().optional(),
	metadata: z.array().optional(),

});
```

## Python

```python
import dataclasses

@dataclasses.dataclass
class UcScorecard:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	call_id: Optional[str]
	scorecardtemplate_id: Optional[str]
	"""name of the scorecard template that was filled in"""
	name: Optional[str]
	"""the user being reviewed; reference to HrisEmployee (reference to HrisEmployee)"""
	user_id: Optional[str]
	"""the user who filled in the scorecard; reference to HrisEmployee (reference to HrisEmployee)"""
	reviewer_user_id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	reviewed_at: Optional[str]
	"""overall score"""
	score: Optional[int]
	questions: Optional[PropertyUcScorecardQuestions]
	metadata: Optional[PropertyUcScorecardMetadata]

```