Skip to main content
GET
/
v1
/
core
/
scorecards
/
scorecard-metrics
/
values
Get scorecard metrics values
curl --request GET \
  --url https://api.siro.ai/v1/core/scorecards/scorecard-metrics/values \
  --header 'x-siro-auth-token: <api-key>'
{
  "data": {
    "recordingsEvaluatedCount": 150,
    "metricValues": [
      {
        "id": "metric_value_001",
        "name": "Conversation Time",
        "unit": "seconds",
        "unitAbbreviated": "sec",
        "metricType": "CONVERSATION_TIME",
        "description": "Total duration of the conversation in seconds",
        "value": 1800,
        "passRate": 123
      }
    ],
    "startAt": "2024-01-01T00:00:00Z",
    "endAt": "2024-01-31T23:59:59Z",
    "filterByIds": [
      "user_001",
      "user_002"
    ],
    "filterBy": "USER"
  },
  "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
required

ID of the organization to get metrics for

Example:

"org_123"

​
conversationTypeId
string
required

ID of the conversation type to filter by

Example:

"conv_type_456"

​
startAt
string
required

Start date for the metrics range (ISO 8601 format)

Example:

"2024-01-01T00:00:00Z"

​
endAt
string
required

End date for the metrics range (ISO 8601 format)

Example:

"2024-01-31T23:59:59Z"

​
filterByIds
required

IDs to filter by (can be array or single string)

Minimum array length: 1
Example:
["user_001", "user_002"]
​
filterBy
required

Entity type to filter by (RECORDING, USER, TEAM, ORGANIZATION)

Minimum array length: 1

The entity type to filter scorecard metrics by

Available options:
RECORDING,
USER,
TEAM,
ORGANIZATION
Example:

"USER"

​
groupBy

Optional grouping for the metrics

Minimum array length: 1

The entity type to filter scorecard metrics by

Available options:
RECORDING,
USER,
TEAM,
ORGANIZATION
Example:

"TEAM"

Response

Get scorecard metrics values

​
data
object
required

Response containing scorecard metrics for the specified time range and filters

​
cursor
​
pageSize
number
​
limit
number
​
total
number | null
​
hasNextPage
boolean