Skip to main content

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

ParameterPlain meaning
requestedOrganizationIdYour Siro organization id
conversationTypeIdThe recording’s conversation type—same value as conversationType from Get recording details
startAt / endAtDate/time window that includes when the call happened (standard ISO 8601 timestamps)
filterBySet to RECORDING so results apply to one call
filterByIdsThe recording id. You can send one id or a list; if you send more than one, only the first id is used
Use the same x-siro-auth-token (usually an OAuth access token) as for other api.siro.ai requests.

What you get back

The response includes data.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). You still pass filters and dates in the query. Use evaluated-instances when you want a configured scorecard report over a slice of data. Use scorecard-metrics/values with filterBy=RECORDING when you simply need metrics for one recording id.