Pular para o conteúdo principal
POST
/
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,
      "role": "<string>",
      "signupTime": "<string>",
      "lastAutocompleteUsageTime": "<string>",
      "lastChatUsageTime": "<string>",
      "lastCommandUsageTime": "<string>",
      "promptCreditsUsed": 123,
      "teamStatus": "<string>"
    }
  ],
  "billingCycleStart": "<string>",
  "billingCycleEnd": "<string>",
  "error": "<string>"
}

​
Visão geral

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

​
Solicitação

​
service_key
string
obrigatório
Sua Chave de serviço com permissões “Teams somente leitura”
​
group_name
string
Filtre 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). Afeta apenas o cálculo de activeDays. Se não for informado, o padrão é 1 ano antes.
​
end_timestamp
string
Horário de término no formato RFC 3339 (por exemplo, 2023-12-31T23:59:59Z). Afeta apenas o cálculo de activeDays. Se não for informado, o padrão é o horário atual.

​
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ário
​
billingCycleStart
string
Início do ciclo de cobrança atual no formato RFC 3339. Os valores de promptCreditsUsed em userTableStats correspondem ao uso dentro desse ciclo de cobrança.
​
billingCycleEnd
string
Fim do ciclo de cobrança atual no formato RFC 3339. Os valores de promptCreditsUsed em userTableStats correspondem ao uso dentro desse ciclo de cobrança.

​
Exemplo de resposta

{
  "userTableStats": [
    {
      "name": "Alice",
      "email": "alice@windsurf.com",
      "lastUpdateTime": "2024-10-10T22:56:10.771591Z",
      "apiKey": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "activeDays": 178,
      "role": "admin",
      "signupTime": "2024-01-15T08:30:00Z",
      "lastAutocompleteUsageTime": "2024-10-10T22:56:10Z",
      "lastChatUsageTime": "2024-10-10T20:30:00Z",
      "promptCreditsUsed": 12500,
      "teamStatus": "USER_TEAM_STATUS_APPROVED"
    },
    {
      "name": "Bob",
      "email": "bob@windsurf.com",
      "lastUpdateTime": "2024-10-10T18:11:23.980237Z",
      "apiKey": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
      "activeDays": 210,
      "role": "member",
      "signupTime": "2024-02-01T10:00:00Z",
      "lastAutocompleteUsageTime": "2024-10-10T18:11:23Z",
      "lastChatUsageTime": "2024-10-09T14:22:00Z",
      "lastCommandUsageTime": "2024-10-08T09:15:00Z",
      "promptCreditsUsed": 8300,
      "teamStatus": "USER_TEAM_STATUS_APPROVED"
    }
  ],
  "billingCycleStart": "2024-10-01T00:00:00Z",
  "billingCycleEnd": "2024-11-01T00:00:00Z"
}

​
Respostas de erro

​
error
string
Mensagem de erro que descreve o problema
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