Skip to main content
GET
Get Table Sheet Score
Retrieve the current score payload for a sheet. If a legacy score configuration exists, this endpoint returns legacy score behavior. If no legacy score configuration exists and the sheet has an active scorecard with a completed calculation, this endpoint can return a scorecard-compatible payload (score_type: "scorecard"). Use /scorecard endpoints for full scorecard state, runs, and row breakdowns.

Authorizations

X-API-KEY
string
header
required

Headers

X-API-KEY
string
required

Your PromptLayer API key. The key's workspace scopes table resources for this request.

Path Parameters

table_id
string<uuid>
required

Table ID.

sheet_id
string<uuid>
required

Table sheet ID.

Response

Successful response

success
boolean
required
sheet_id
string<uuid>
required
scoring_type
enum<string> | null
required
Available options:
auto,
boolean,
numeric,
custom,
null
columns
TableSheetScoreColumn · object[]
required
aggregate_score
number | null
required
total_rows
integer
required
scored_rows
integer
required
excluded_rows
integer
required
calculated_at
string<date-time> | null
required
score_matrix
((number | string | TableSheetScoreCellObject · object | null)[])[] | null
required
score_matrix_metrics
TableSheetScoreMetric · object[] | null
required
status
enum<string> | null
required
Available options:
queued,
running,
completed,
failed,
null
score_calculation_error
string | null
required
has_custom_scoring
boolean
required
score_configuration
TableSheetScoreConfiguration · object | null
required
score_type
enum<string>
required
Available options:
none,
single_column,
multi_column,
custom
overall_score
number | null
required
details
object
required
aggregate
object
required
per_column
object
required