Skip to main content
GET
/
api
/
v0
/
repositories
/
{repo_id}
/
insights
Insights for a single repository.
curl --request GET \
  --url https://api.example.com/api/v0/repositories/{repo_id}/insights
import requests

url = "https://api.example.com/api/v0/repositories/{repo_id}/insights"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/api/v0/repositories/{repo_id}/insights', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v0/repositories/{repo_id}/insights",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/api/v0/repositories/{repo_id}/insights"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/api/v0/repositories/{repo_id}/insights")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v0/repositories/{repo_id}/insights")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "criticalFindings": 123,
  "highFindings": 123,
  "mediumFindings": 123,
  "lowFindings": 123,
  "informationalFindings": 123,
  "gasOptimizationFindings": 123,
  "newFindings": 123,
  "inReviewFindings": 123,
  "disputedFindings": 123,
  "rejectedFindings": 123,
  "spamFindings": 123,
  "duplicateFindings": 123,
  "confirmedFindings": 123,
  "acknowledgedFindings": 123,
  "fixedFindings": 123,
  "withdrawnFindings": 123,
  "totalFindings": 123,
  "outline": {},
  "reviewersJoined": 123,
  "reviewers": [
    {
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "username": "<string>",
      "avatar": "<string>",
      "isBot": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "pingsLeft": 123,
      "reputation": 123,
      "disabledAt": "2023-11-07T05:31:56Z",
      "deletedFromRepoAt": "2023-11-07T05:31:56Z"
    }
  ],
  "totalRewards": "<string>",
  "avgResponseSeconds": 123
}
{
"msg": "<string>"
}
{
"msg": "<string>"
}
{
"msg": "<string>"
}
{
"msg": "<string>"
}
{
"msg": "<string>"
}

Path Parameters

repo_id
string<uuid>
required

Query Parameters

since
string<date-time> | null

Get the insights since a certain timestamp.

Defaults to the entire lifetime of the repository.

Response

The repository's insights

Insights into a repository.

criticalFindings
integer<int32>
required
highFindings
integer<int32>
required
mediumFindings
integer<int32>
required
lowFindings
integer<int32>
required
informationalFindings
integer<int32>
required
gasOptimizationFindings
integer<int32>
required
newFindings
integer<int32>
required
inReviewFindings
integer<int32>
required
disputedFindings
integer<int32>
required
rejectedFindings
integer<int32>
required
spamFindings
integer<int32>
required
duplicateFindings
integer<int32>
required
confirmedFindings
integer<int32>
required
acknowledgedFindings
integer<int32>
required
fixedFindings
integer<int32>
required
withdrawnFindings
integer<int32>
required
totalFindings
integer<int32>
required
outline
object
required

Outline of the findings over status and severity

reviewersJoined
integer<int32>
required
reviewers
object[]
required
totalRewards
string | null

Total rewards assigned to findings in the repository.

avgResponseSeconds
integer<int64> | null

Number of seconds it takes to get a response to a new finding on average.

This will be null if the repository has no findings, or it has findings, but they have not yet received any feedback (a change or a comment).