Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1398228598.3 KB
Scorecard

Get Scorecards Summary

Retrieves detailed usage statistics for specified users or teams within a given time period.

post/scorecards/summary

Request body

fromDateTimestring date-time required

Start date and time for filtering scorecards (ISO 8601 format)

toDateTimestring date-time required

End date and time for filtering scorecards (ISO 8601 format)

scorecardsItemsUUIDsstring[] required
scorecardUUIDstring required
teamUUIDsstring[] required
userUUIDsstring[] required

Example request

{
  "scorecardUUID": "sc-uuid-123",
  "fromDateTime": "2024-01-01T00:00:00Z",
  "toDateTime": "2024-03-31T23:59:59Z",
  "teamUUIDs": [
    "team-uuid-1",
    "team-uuid-2"
  ],
  "userUUIDs": [
    "user-uuid-1",
    "user-uuid-2"
  ],
  "scorecardsItemsUUIDs": [
    "si-uuid-1",
    "si-uuid-2"
  ]
}

Response

Scorecards summary successfully generated with detailed statistics

Example response

{
  "data": [
    {
      "userName": "Jane Smith",
      "teamName": "Sales Team",
      "overallScoreTotals": 85.5,
      "metricsCount": 12,
      "min": 65,
      "max": 98,
      "itemAverageTotals": [
        {
          "scorecardItemUUID": "si-uuid-1",
          "title": "Discovery Quality",
          "average": 88
        }
      ],
      "metrics": []
    }
  ]
}