As APIs de análise fornecem métricas agregadas de uso e atividade de um espaço de trabalho do ChatGPT. A API unificada de análise de uso diário apresenta dados diários sobre o uso do ChatGPT, do Codex e do modo Work. Antes de usar o endpoint, confirme se ele está habilitado para o seu espaço de trabalho.
A referência da API de administração é a fonte oficial de informações atualizadas sobre requisitos de acesso, rotas, schemas de requisição e resposta, métricas, interpretação dos dados temporais e paginação.
Quando usar a API de análise
Use a API de análise quando precisar:
- Automatizar a geração periódica de relatórios de uso do espaço de trabalho.
- Cruzar métricas agregadas de uso com dados internos da organização.
- Criar uma camada de relatórios com acesso restrito a públicos autorizados.
- Evitar que uma integração dependa de um painel interativo.
A API de análise não dá acesso a logs brutos de auditoria. Use a API de Compliance quando o fluxo de trabalho exigir registros de atividade auditáveis.
Confirme os limites do acesso administrativo
Os resultados da API de análise se limitam a um espaço de trabalho do ChatGPT. Para acessar a API unificada de análise de uso diário, use uma chave de administração restrita ao espaço de trabalho e com o escopo enterprise.analytics.usage.read. O escopo codex.enterprise.analytics.read do Codex não concede acesso a esse endpoint.
A referência da API especifica como provisionar chaves, quais escopos são necessários, quais rotas, schemas e campos estão disponíveis, como interpretar os dados temporais e como funciona a paginação. Consulte a referência para ver a especificação atual, que não é reproduzida nesta página.