Skip to main content
GET
/
coverbot-coverage-gains
Get CoverBot coverage gains
curl --request GET \
  --url https://use-tusk.uc.r.appspot.com/api/v1/analytics/coverbot-coverage-gains \
  --header 'x-api-key: <api-key>'
import requests

url = "https://use-tusk.uc.r.appspot.com/api/v1/analytics/coverbot-coverage-gains"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://use-tusk.uc.r.appspot.com/api/v1/analytics/coverbot-coverage-gains', 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://use-tusk.uc.r.appspot.com/api/v1/analytics/coverbot-coverage-gains",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);

$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://use-tusk.uc.r.appspot.com/api/v1/analytics/coverbot-coverage-gains"

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

req.Header.Add("x-api-key", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://use-tusk.uc.r.appspot.com/api/v1/analytics/coverbot-coverage-gains")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://use-tusk.uc.r.appspot.com/api/v1/analytics/coverbot-coverage-gains")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "repoId": 123,
      "repoName": "<string>",
      "scheduledTestRunId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "prNumber": 123,
      "prTitle": "<string>",
      "prStatus": "<string>",
      "prCreatedAt": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "runAverageLineCoverageGain": 123,
      "runAverageBranchCoverageGain": 123,
      "requestedPrReviewers": [
        "<string>"
      ],
      "filePath": "<string>",
      "lineCoverageBefore": 123,
      "lineCoverageAfter": 123,
      "lineCoverageGain": 123,
      "branchCoverageBefore": 123,
      "branchCoverageAfter": 123,
      "branchCoverageGain": 123,
      "externalPullRequestUrl": "<string>"
    }
  ],
  "count": 123
}

Authorizations

x-api-key
string
header
required

Query Parameters

startDate
string<date-time>

Start date to filter by (inclusive)

endDate
string<date-time>

End date to filter by (inclusive)

repoIds
number[]

Repo IDs to filter by

Response

200 - application/json

Success

data
object[]
required
count
number
required