Os relatórios de uso mostram informações detalhadas sobre o uso GitHub da sua conta, incluindo a quantidade de cada SKU usada e o valor faturável resultante.
Para gerar um relatório de uso, consulte Como exibir o uso de licenças e produtos mensuráveis.
Tipos de relatório
Os tipos de relatório a seguir estão disponíveis.
- Página de uso limitado: * Relatório de uso resumido: um resumo do uso de todos os produtos pagos por um período máximo de um ano. * Relatório de uso detalhado: um relatório de uso detalhado para todos os produtos pagos por um período máximo de 31 dias.
- Página de análise de solicitações premium: * Relatório de uso de solicitações Premium: uma análise detalhada por usuário das solicitações premium consumidas por um período máximo de 31 dias.
Relatório de uso resumido
Este relatório soma os campos quantity, gross_amount, discount_amount e net_amount com base na combinação dos seguintes valores: date, sku, repository, cost_center_name. Se o relatório de uso for para uma empresa com organizações, os valores também serão resumidos segundo a organização.
Relatório de uso detalhado
O relatório de uso detalhado inclui os mesmos campos do relatório resumido e adiciona username e workflow_path.
O relatório soma os campos quantity, gross_amount, discount_amount e net_amount com base na combinação dos seguintes valores: date, sku, organization, repository, cost_center_name, username, workflow_path.
Observação
Os dados do relatório de uso detalhado só estão disponíveis por meio da interface web GitHub e não podem ser obtidos por meio do ponto de extremidade da API /usage REST. A API REST fornece acesso apenas a informações de cobrança resumidas.
Relatório de uso de solicitações Premium
Este relatório inclui detalhes adicionais sobre o uso da solicitação premium. O relatório soma os campos quantity, gross_amount, discount_amount e net_amount com base na combinação dos seguintes valores: date, model e username.
Este relatório contém o uso a partir de 01 de outubro de 2025 00:00 UTC.
Campos do relatório de uso
Os relatórios de uso contêm os campos a seguir.
| Campo | Descrição |
|---|---|
date | O dia em que o uso ocorreu. Todo o uso é registrado em UTC. |
product | O produto do GitHub usado. |
sku | A SKU do produto do GitHub específico que foi usado. |
quantity | A quantidade da SKU que foi usada. |
unit_type | A unidade de medida da SKU do produto. |
applied_cost_per_quantity | O custo unitário da SKU do produto. |
gross_amount | A quantidade da SKU do produto que foi usada. |
discount_amount | A quantidade de uso que foi descontada. O uso com desconto como parte do uso incluído de sua conta é mostrado nesse campo. Também inclui descontos referentes ao uso do GitHub Actions para executores padrão hospedados no GitHub em repositórios públicos e para executores auto-hospedados. |
net_amount | A quantidade faturável de uso após a aplicação do discount_amount. Esse é o valor que sua conta será cobrada. gross_amount - discount_amount = net_amount |
username | O usuário associado ao uso, se aplicável. Não incluído no Summarized usage report. |
organization | A organização associada ao uso, se aplicável. |
repository | O repositório associado ao uso, se aplicável. |
workflow_path | O caminho do fluxo de trabalho do GitHub Actions que gerou o uso, se aplicável. Disponível somente no Detailed usage report |
cost_center_name | O centro de custo associado ao uso, se aplicável. |
model | O modelo utilizado. Pode ser um LLM como claude-sonnet-4 ou um modelo específico do produto, como Code Review model. Disponível somente no Premium request usage report |
exceeds_quota | Indica se a solicitação premium excede a cota mensal do usuário: |
-
`FALSE`: a solicitação é coberta pela cota mensal incluída no plano do usuário.<br>
-
`TRUE`: a solicitação excede a cota mensal e será cobrada <br><br>Disponível somente no `Premium request usage report` |
| total_monthly_quota | O número de solicitações incluídas no plano atual do usuário.
Disponível somente no Premium request usage report |
Recebendo o relatório
Os relatórios de uso são enviados por email para o endereço de email padrão associado à sua conta do GitHub. Você só pode solicitar um relatório de uso por conta por vez.
Campos de relatório de uso medido que foram encerrados
O GitHub tem como objetivo minimizar as alterações na estrutura do relatório de uso; no entanto, às vezes, a estrutura ou os campos do relatório podem ser alterados.
Os campos a seguir foram removidos dos relatórios de uso.
| Campo | Substituição |
|---|---|
usage_at | Consulte date em vez disso. |
workflow_name | Consulte workflow_path em vez disso. |