Scorecard data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
call_idstringNo
scorecardtemplate_idstringNo
namestringNoname of the scorecard template that was filled in
user_idstringNothe user being reviewed; reference to HrisEmployee (reference to HrisEmployee)
reviewer_user_idstringNothe user who filled in the scorecard; reference to HrisEmployee (reference to HrisEmployee)
reviewed_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
scorenumberNooverall score
questionsUcScorecardQuestion[]No
questions[].question_identifierstringNo
questions[].textstringNo
questions[].answerstringNo
questions[].scorenumberNo
questions[].is_not_applicablebooleanNo
metadataUcMetadata[]No
metadata[].idstringNo
metadata[].slugstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

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

Zod
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]
Are we missing anything? Let us know
Was this page helpful?