Recuperar análises da página do usuário

curl --request POST \
  --url https://server.codeium.com/api/v1/UserPageAnalytics \
  --header 'Authorization: Bearer <token>' \
  --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>"
}

POST

api

UserPageAnalytics

Recuperar análises da página do usuário

curl --request POST \
  --url https://server.codeium.com/api/v1/UserPageAnalytics \
  --header 'Authorization: Bearer <token>' \
  --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

Recupere as estatísticas de atividade dos usuários exibidas na página Teams, incluindo nomes de usuário, e-mails, horários da última atividade, dias ativos e créditos de prompt utilizados.

Requisição

service_key

string

obrigatório

Sua chave de serviço com a permissão “Teams Read-only”

group_name

string

Filtra os resultados para usuários em um grupo específico (opcional)

start_timestamp

string

Data/hora 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 fornecido, o valor padrão será 1 ano atrás.

end_timestamp

string

Data/hora 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 fornecido, o valor padrão será o horário atual.

Exemplo de requisição

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

Resposta

userTableStats

array

Lista de objetos com estatísticas de usuários

Mostrar Objeto de estatísticas do usuário

name

string

Nome de exibição do usuário

string

Endereço de e-mail do usuário

lastUpdateTime

string

Timestamp da última atividade do usuário no formato RFC 3339

apiKey

string

Versão com hash da Chave de API do usuário

activeDays

number

Número de dias em que o usuário esteve ativo dentro do intervalo consultado (definido por start_timestamp e end_timestamp). Um dia é considerado ativo se o usuário teve alguma aceitação de autocomplete, uso do Cascade ou uso de comandos nesse dia.

disableCodeium

boolean

Indica se o acesso ao Devin Desktop foi desativado para o usuário por um admin. Esse campo só estará presente se o acesso tiver sido explicitamente desativado e, nesse caso, sempre terá o valor true.

role

string

A função do usuário na equipe (por exemplo, admin, membro)

Timestamp de quando o usuário se cadastrou, no formato RFC 3339

lastAutocompleteUsageTime

string

O timestamp mais recente de uso da modalidade Tab/Autocomplete, no formato RFC 3339

lastChatUsageTime

string

O timestamp mais recente de uso da modalidade Cascade, no formato RFC 3339

lastCommandUsageTime

string

O timestamp mais recente de uso da modalidade Command, no formato RFC 3339

promptCreditsUsed

number

O número total de créditos de prompt usados por este usuário durante o ciclo de faturamento atual, retornado em centavos (1 crédito = 100 centavos). Para obter o uso real de créditos, divida esse valor por 100. Esse valor não é afetado pelos parâmetros de requisição start_timestamp ou end_timestamp. A janela do ciclo de faturamento é indicada pelos campos de nível superior billingCycleStart e billingCycleEnd.

teamStatus

string

O status de associação do usuário à equipe. Valores possíveis: USER_TEAM_STATUS_UNSPECIFIED, USER_TEAM_STATUS_PENDING, USER_TEAM_STATUS_APPROVED, USER_TEAM_STATUS_REJECTED. Observe que a API retorna todos os usuários independentemente do status na equipe, enquanto a UI Manage Members mostra apenas os usuários aprovados.

billingCycleStart

string

Início do ciclo de faturamento atual no formato RFC 3339. Os valores de promptCreditsUsed em userTableStats correspondem ao uso dentro deste ciclo de faturamento.

billingCycleEnd

string

Fim do ciclo de faturamento atual no formato RFC 3339. Os valores de promptCreditsUsed em userTableStats correspondem ao uso dentro deste ciclo de faturamento.

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 comuns de erro:

Chave de serviço inválida ou permissões insuficientes
Formato de timestamp inválido
Grupo não encontrado
Limite de requisições excedido

API de análises Consultar análises do Cascade

⌘I

Documentation Index

​Visão geral

​Requisição

​Exemplo de requisição

​Resposta

​Exemplo de resposta

​Respostas de erro

Visão geral

Requisição

Exemplo de requisição

Resposta

Exemplo de resposta

Respostas de erro