Skip to main content
GET
Get scorecard instances

Why you’d call this

This is how you discover the scorecard instance id you’ll pass to Get evaluated scorecard instance. A scorecard instance is the saved configuration (sections, metrics, weights, color thresholds) used to grade a slice of recordings for a given organization and conversation type. Typical flow:
1

List instances for the org and conversation type

Call this endpoint with organizationId (required) and optionally conversationTypeId and isActive=true.
2

Pick the instance id you want to evaluate

Most orgs have one active instance per conversation type. Each item in the response carries an id.
3

Run the evaluation

Pass that id to Get evaluated scorecard instance along with startAt, endAt, filterBy, and filterByIds.
Non-admin callers only see active instances scoped to their own organization and assigned conversation types. Org/group/Siro admins see every instance for the requested org.

Authorizations

x-siro-auth-token
string
header
default:<access-token>
required

Access token from POST https://auth.siro.ai/oauth2/token (client_credentials), or a Siro OAuth access token. Send x-siro-auth-token: <access-token>.

Query Parameters

organizationId
string
conversationTypeId
string
isActive
boolean | null

Response

Get scorecard instances

data
object
required
cursor
pageSize
number
limit
number
total
number | null
hasNextPage
boolean