Tool
UsageReport
Get Usage Report
Retrieves detailed usage statistics for specified users or teams within a given time period. This endpoint helps track API consumption, feature usage, and user activity patterns.
get/usageReport
Query parameters
user-uuidsstring[]
List of user UUIDs to include in the report
team-uuidsstring[]
List of team UUIDs to include in the report
startDatestring date required
Start date for the usage report period (inclusive)
endDatestring date required
End date for the usage report period (inclusive)
Response
Usage report successfully generated with detailed statistics
Example response
{
"data": [
{
"user": {
"uuid": "user1-uuid",
"email": "user1@email.com",
"firstName": "FirstName1",
"lastName": "LastName1",
"team": {
"uuid": "team-uuid",
"name": "TeamName"
}
},
"metrics": {
"coachingSessions": 0,
"callsViewed": 0,
"commentsLeft": 0,
"snippetsCreated": 0,
"gInsightsRan": 0,
"conversationInsightsRan": 0
}
},
{
"user": {
"uuid": "user2-uuid",
"email": "user2@email.com",
"firstName": "FirstName2",
"lastName": "LastName2",
"team": {
"uuid": "team-uuid",
"name": "TeamName"
}
},
"metrics": {
"coachingSessions": 0,
"callsViewed": 0,
"commentsLeft": 0,
"snippetsCreated": 0,
"gInsightsRan": 0,
"conversationInsightsRan": 0
}
}
]
}