Skip to main content
GET
Obter métricas da varredura de código

Permissões

Requer um usuário de serviço ou um token de acesso pessoal com a permissão ViewCodeScans no nível da organização.

Filtros de tempo

Este endpoint exige os parâmetros de consulta time_after e time_before.
  • time_after e time_before são timestamps Unix em segundos, interpretados como UTC.
  • time_after deve ser anterior a time_before.
  • O intervalo entre time_after e time_before deve ser de 100 dias ou menos.
  • As métricas abrangem apenas varreduras de código criadas dentro desse intervalo.
Para ver métricas de todas as organizações em uma Enterprise, use métricas de varreduras de código (Enterprise).

Autorizações

Authorization
string
header
obrigatório

Credencial de usuário de serviço (prefixo: cog_)

Parâmetros de caminho

org_id
string
obrigatório

ID da organização (prefixo: org-)

Exemplo:

"org-abc123def456"

Parâmetros de consulta

time_before
integer
obrigatório
time_after
integer
obrigatório

Resposta

Resposta bem-sucedida

Modelo de resposta para métricas de varredura de código.

Todas as métricas se aplicam às varreduras de código criadas dentro do intervalo de tempo especificado: resultados e PRs de remediação são atribuídos à varredura que os gerou.

avg_pr_open_duration_seconds
number | null
obrigatório

Tempo médio em que uma PR fica (ou ficou) aberta, em segundos: da criação até o merge/fechamento para PRs concluídas; da criação até agora para PRs abertas. Nulo quando nenhuma PR foi criada.

avg_pr_time_to_merge_seconds
number | null
obrigatório

Tempo médio entre a criação da PR e o merge, em segundos. Nulo quando nenhuma PR tiver sido mesclada.

open_critical_findings_count
integer
obrigatório

Número de resultados abertos com severidade crítica.

open_high_findings_count
integer
obrigatório

Número de resultados abertos com severidade alta.

open_low_findings_count
integer
obrigatório

Número de resultados abertos com severidade baixa.

open_medium_findings_count
integer
obrigatório

Número de resultados abertos com severidade média.

prs_closed_count
integer
obrigatório

Número de PRs de remediação fechadas sem serem mescladas.

prs_created_count
integer
obrigatório

Número de PRs criadas pelas sessões de remediação das varreduras.

prs_merged_count
integer
obrigatório

Número de PRs de remediação mescladas.

prs_open_count
integer
obrigatório

Número de PRs de remediação atualmente em estado aberto.

repos_scanned_count
integer
obrigatório

Número de repositórios distintos verificados.

scans_count
integer
obrigatório

Número de varreduras de código criadas dentro do intervalo de tempo especificado.