跳转到主要内容
POST
https://server.codeium.com
/
api
/
v1
/
UserPageAnalytics
获取用户页面 Analytics
curl --request POST \
  --url https://server.codeium.com/api/v1/UserPageAnalytics \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_key": "<string>",
  "group_name": "<string>",
  "start_timestamp": "<string>",
  "end_timestamp": "<string>"
}
'
{
  "userTableStats": [
    {
      "name": "<string>",
      "email": "<string>",
      "lastUpdateTime": "<string>",
      "apiKey": "<string>",
      "activeDays": 123,
      "disableCodeium": true,
      "lastAutocompleteUsageTime": "<string>",
      "lastChatUsageTime": "<string>",
      "lastCommandUsageTime": "<string>"
    }
  ],
  "error": "<string>"
}

​
概览

获取 Teams 页面上显示的用户活动统计信息，包括用户名、emails、最近活动时间和活跃天数。

​
请求

​
service_key
string
必填
具有 “Teams Read-only” 权限的服务密钥
​
group_name
string
将结果筛选为特定组内的用户（可选）
​
start_timestamp
string
开始时间，采用 RFC 3339 格式（例如：2023-01-01T00:00:00Z）
​
end_timestamp
string
结束时间，采用 RFC 3339 格式（例如：2023-12-31T23:59:59Z）

​
示例请求

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "group_name": "engineering_team",
  "start_timestamp": "2024-01-01T00:00:00Z",
  "end_timestamp": "2024-12-31T23:59:59Z"
}' \
https://server.codeium.com/api/v1/UserPageAnalytics

​
响应

​
userTableStats
array
用户统计对象数组

​
示例回复

{
  "userTableStats": [
    {
      "name": "Alice",
      "email": "[email protected]",
      "lastUpdateTime": "2024-10-10T22:56:10.771591Z",
      "apiKey": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "activeDays": 178
    },
    {
      "name": "Bob",
      "email": "[email protected]",
      "lastUpdateTime": "2024-10-10T18:11:23.980237Z",
      "apiKey": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
      "activeDays": 462
    },
    {
      "name": "Charlie",
      "email": "[email protected]",
      "lastUpdateTime": "2024-10-10T16:43:46.117870Z",
      "apiKey": "cccccccc-cccc-cccc-cccc-cccccccccccc",
      "activeDays": 237
    }
  ]
}

​
错误响应

​
error
string
描述问题原因的错误信息
常见错误情形：
  • 服务密钥无效或权限不足
  • 时间戳格式无效
  • 未找到分组
  • 超出速率限制