Skip to main content
POST
/
scorecards
/
summary
Get scorecards summary
curl --request POST \
  --url https://api.attention.tech/v2/scorecards/summary \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "fromDateTime": "2023-11-07T05:31:56Z",
  "toDateTime": "2023-11-07T05:31:56Z",
  "scorecardsItemsUUIDs": [
    "<string>"
  ],
  "scorecardUUID": "<string>",
  "teamUUIDs": [
    "<string>"
  ],
  "userUUIDs": [
    "<string>"
  ]
}'
{
  "data": [
    {
      "overallScoreTotals": 123,
      "min": 123,
      "userName": "<string>",
      "teamName": "<string>",
      "metrics": [
        {
          "overallScore": 123,
          "itemAverages": [
            {
              "title": "<string>",
              "scorecardItemUUID": "<string>",
              "average": 123
            }
          ],
          "date": "2023-11-07T05:31:56Z",
          "entityInfo": {
            "uuid": "<string>",
            "title": "<string>"
          }
        }
      ],
      "max": 123,
      "itemAverageTotals": [
        {
          "title": "<string>",
          "scorecardItemUUID": "<string>",
          "average": 123
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Body

Request containing the content to be analyzed and analysis parameters

fromDateTime
string<date-time>
required

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

toDateTime
string<date-time>
required

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

scorecardsItemsUUIDs
string[]
required
scorecardUUID
string
required
teamUUIDs
string[]
required
userUUIDs
string[]
required

Response

Scorecards summary successfully generated with detailed statistics

data
object[]
required

Array of resources matching the query