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

Permissões

Requer um usuário de serviço com a permissão ViewAccountCodeScans em nível Enterprise.

Filtros de tempo

Este endpoint exige os parâmetros de consulta time_after e time_before.
  • Tanto time_after quanto time_before são timestamps Unix em segundos, interpretados como UTC.
  • time_after deve ser anterior a time_before.
  • O intervalo de tempo entre time_after e time_before deve ser de 100 dias ou menos.
  • As métricas se aplicam apenas às varreduras de código criadas dentro desse intervalo de tempo.

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de consulta

time_before
integer
obrigatório
time_after
integer
obrigatório
org_ids
string[] | null

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.