Pular para o conteúdo principal
POST
https://server.codeium.com
/
api
/
v1
/
UserPageAnalytics
Obter Analytics da página do usuário
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>"
}

​
Visão geral

Obtenha estatísticas de atividade do usuário que aparecem na página de Teams, incluindo nomes de usuários, emails, horários da última atividade e dias ativos.

​
Solicitação

​
service_key
string
obrigatório
Sua Service Key com permissões “Teams Read-only”
​
group_name
string
Filtra os resultados para usuários de um grupo específico (opcional)
​
start_timestamp
string
Horário de início no formato RFC 3339 (por exemplo, 2023-01-01T00:00:00Z)
​
end_timestamp
string
Horário de término no formato RFC 3339 (por exemplo, 2023-12-31T23:59:59Z)

​
Exemplo de solicitação

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

​
Resposta

​
userTableStats
array
Array de objetos de estatísticas de usuários

​
Exemplo de resposta

{
  "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
    }
  ]
}

​
Respostas de erro

​
error
string
Mensagem de erro descrevendo o que ocorreu
Cenários de erro comuns:
  • Service Key inválida ou permissões insuficientes
  • Formato de timestamp inválido
  • Grupo não encontrado
  • Limite de requisições excedido