Pular para o conteúdo principal
GET
Obter métricas de varredura de código

Permissões

Requer um usuário de serviço ou token de acesso pessoal 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 não deve ser posterior 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.
Para uma única organização, use Obter métricas de varredura de código (Organização).

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 varreduras de código.

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

scans_count
integer
obrigatório

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

repos_scanned_count
integer
obrigatório

Número de repositórios distintos submetidos à varredura.

prs_created_count
integer
obrigatório

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

prs_open_count
integer
obrigatório

Número de PRs de remediação atualmente no estado open.

prs_merged_count
integer
obrigatório

Número de PRs de remediação com merge realizado.

prs_closed_count
integer
obrigatório

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

avg_pr_time_to_merge_seconds
number | null
obrigatório

Tempo médio entre a criação da PR e o merge, em segundos. Null quando nenhuma PR tiver passado por merge.

avg_pr_open_duration_seconds
number | null
obrigatório

Tempo médio em que uma PR está (ou esteve) aberta, em segundos: da criação até o merge/fechamento para PRs concluídas, da criação até agora para PRs abertas. Null quando nenhuma PR tiver sido criada.

open_critical_findings_count
integer
obrigatório

Número de resultados abertos com severidade critical.

open_high_findings_count
integer
obrigatório

Número de resultados abertos com severidade high.

open_medium_findings_count
integer
obrigatório

Número de resultados abertos com severidade medium.

open_low_findings_count
integer
obrigatório

Número de resultados abertos com severidade low.