Skip to main content
GET
/
v1
/
core
/
scorecards
/
scorecard-metrics
/
available
Get available scorecard metrics
curl --request GET \
  --url https://api.siro.ai/v1/core/scorecards/scorecard-metrics/available \
  --header 'x-siro-auth-token: <api-key>'
{
  "data": {
    "scorecardMetrics": [
      {
        "id": "metric_001",
        "name": "Conversation Time",
        "unit": "seconds",
        "unitAbbreviated": "sec",
        "metricType": "CONVERSATION_TIME",
        "description": "Total duration of the conversation in seconds",
        "llmPrompt": "Analyze the conversation duration and provide insights"
      }
    ]
  },
  "cursor": "<string>",
  "pageSize": 123,
  "limit": 123,
  "total": 123,
  "hasNextPage": true
}

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.

Authorizations

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

OAuth access token for user-scoped requests (Authorization Code or machine-to-machine). Send header x-siro-auth-token: . Not an organization API key.

Query Parameters

requestedOrganizationId
string
conversationTypeId
string
requestedOrganizationGroupId
string
getAllMetrics
boolean | null

Response

Get available scorecard metrics

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