GET
/
totals
Get client totals
curl --request GET \
  --url https://use-tusk.uc.r.appspot.com/api/v1/analytics/totals \
  --header 'x-api-key: <api-key>'
{
  "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "totalUniquePrs": 123,
  "uniquePrsWithCreatedTests": 123,
  "uniquePrsWithPartiallyIncorporatedTests": 123,
  "uniquePrsWithFullyIncorporatedTests": 123,
  "uniquePrsWithAnyIncorporatedTests": 123,
  "numTestsIncorporated": 123,
  "numFailedTestsIncorporated": 123,
  "totalViews": 123,
  "numCoverbotPrs": 123,
  "numMergedCoverbotPrs": 123,
  "numCoverbotTestsCreated": 123,
  "numCoverbotTestsIncorporated": 123,
  "numCoverbotPotentialFailingTests": 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

usernames
string[]

GitHub/GitLab usernames to filter by

Response

200 - application/json

Success

clientId
string<uuid>
required
totalUniquePrs
number
required

Number of PRs processed by Tusk

uniquePrsWithCreatedTests
number
required

Number of PRs with Tusk tests generated

uniquePrsWithPartiallyIncorporatedTests
number
required

Number of PRs with some of Tusk tests incorporated

uniquePrsWithFullyIncorporatedTests
number
required

Number of PRs with all of Tusk tests incorporated

uniquePrsWithAnyIncorporatedTests
number
required

Number of PRs with any of Tusk tests incorporated

numTestsIncorporated
number
required

Number of individual tests incorporated

numFailedTestsIncorporated
number
required

Number of individual failing tests incorporated (i.e. potential bugs Tusk detected)

totalViews
number
required

Total number of views of Tusk output in GitHub/GitLab or Tusk UI

numCoverbotPrs
number
required

Number of PRs created by Coverbot

numMergedCoverbotPrs
number
required

Number of merged Coverbot PRs merged

numCoverbotTestsCreated
number
required

Number of individual tests created by Coverbot

numCoverbotTestsIncorporated
number
required

Number of individual tests in merged Coverbot PRs

numCoverbotPotentialFailingTests
number
required

Number of potential failing tests surfaced in Coverbot PRs