GET
/
users
Get users
curl --request GET \
  --url https://use-tusk.uc.r.appspot.com/api/v1/analytics/users \
  --header 'x-api-key: <api-key>'
[
  {
    "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "prExternalCreatorId": "<string>",
    "hasActiveSeat": true,
    "totalUniquePrs": 123,
    "prsWithTests": 123,
    "prsWithFullyIncorporatedTests": 123,
    "prsWithPartiallyIncorporatedTests": 123,
    "prsWithAnyIncorporatedTests": 123,
    "numTestsIncorporated": 123,
    "numFailedTestsIncorporated": 123,
    "totalViews": 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
​
prExternalCreatorId
string
required

GitHub/GitLab username of PR creator

​
hasActiveSeat
boolean
required

Whether the user has an active seat

​
totalUniquePrs
number
required

Number of PRs processed by Tusk

​
prsWithTests
number
required

Number of PRs with Tusk tests generated

​
prsWithFullyIncorporatedTests
number
required

Number of PRs with all of Tusk tests incorporated

​
prsWithPartiallyIncorporatedTests
number
required

Number of PRs with some of Tusk tests incorporated

​
prsWithAnyIncorporatedTests
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