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>'
{
  "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>",
      "status": "pending",
      "runType": "scheduled",
      "strategy": "files_with_low_coverage",
      "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