Documentation Index
Fetch the complete documentation index at: https://docs.siro.ai/llms.txt
Use this file to discover all available pages before exploring further.
What this page covers
If you need scorecard metrics for one specific recording (for example one consultation tied to a CRM appointment), use:GET /v1/core/scorecards/scorecard-metrics/values
Full technical schema: Get scorecard metric values.
What to send
| Parameter | Plain meaning |
|---|---|
requestedOrganizationId | Your Siro organization id |
conversationTypeId | The recording’s conversation type—same value as conversationType from Get recording details |
startAt / endAt | Date/time window that includes when the call happened (standard ISO 8601 timestamps) |
filterBy | Set to RECORDING so results apply to one call |
filterByIds | The recording id. You can send one id or a list; if you send more than one, only the first id is used |
x-siro-auth-token (usually an OAuth access token) as for other api.siro.ai requests.
What you get back
The response includesdata.metricValues: the calculated coaching metrics for that request, and data.recordingsEvaluatedCount: how many recordings were included (for one recording id, that count reflects that scope).
Finding which metrics your org supports
Before building reports, list available definitions with Get available scorecard metrics.Advanced: evaluated scorecard view
GET /v1/core/scorecards/evaluated-instances/{id} runs a saved scorecard configuration (the {id} in the URL is that configuration’s id—not the recording id) and returns the configured tree of sections and metrics with rubric-based scoring, color thresholds, and—for user-level views—AI coaching spotlights with cited quotes.
To find the {id}, list your org’s saved instances with GET /v1/core/scorecards/instances.
When to use which:
evaluated-instances/{id}— you want a configured scorecard report (with weighted sections, pass/fail colors, AI commentary) over a slice of data.scorecard-metrics/valueswithfilterBy=RECORDING— you just need raw metrics for one recording id, no saved scorecard configuration applied.