GET
/
prs
Get PRs
curl --request GET \
  --url https://use-tusk.uc.r.appspot.com/api/v1/analytics/prs \
  --header 'x-api-key: <api-key>'
[
  {
    "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "repoId": 123,
    "repoName": "<string>",
    "prNumber": 123,
    "prTitle": "<string>",
    "prStatus": "<string>",
    "prExternalCreatorId": "<string>",
    "latestTestingCommitCheckRunCreatedAt": "2023-11-07T05:31:56Z",
    "latestTestingCommitCheckRunId": "<string>",
    "hasTests": true,
    "hasFailedTests": true,
    "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
​
repoId
number
required

Unique ID for repo

​
repoName
string
required

Name of repo

​
prNumber
number
required

PR number

​
prTitle
string
required

Title of PR

​
prStatus
string
required

Status of PR

​
prExternalCreatorId
string
required

GitHub/GitLab username of PR creator

​
latestTestingCommitCheckRunCreatedAt
string<date-time>
required

Date and time of latest Tusk run

​
latestTestingCommitCheckRunId
string
required

ID of latest Tusk run

​
hasTests
boolean
required

Whether the PR had Tusk tests generated on any commit

​
hasFailedTests
boolean
required

Whether the PR had failing Tusk tests (i.e. potential bugs Tusk detected) generated on any commit

​
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