v1

latestOpenAPI 3.0.32026-07-24354865.6 KB
Coverage

Commit coverage report

Similar to the coverage totals endpoint but also returns line-by-line coverage info (hit=0/miss=1/partial=2).

By default that commit is the head of the default branch but can also be specified explictily by:

  • sha - return report for the commit with the given SHA
  • branch - return report for the head commit of the branch with the given name

The report can be optionally filtered by specifying:

  • path - only show report info for pathnames that start with this value
  • flag - only show report info that applies to the specified flag name
  • component_id - only show report info that applies to the specified component
get/{service}/{owner_username}/repos/{repo_name}/report/

Path parameters

owner_usernamestring required

username from service provider

repo_namestring required

repository name

service'bitbucket' | 'bitbucket_server' | 'github' | 'github_enterprise' | 'gitlab' | 'gitlab_enterprise' required

Git hosting service provider

Query parameters

branchstring

branch name for which to return report (of head commit)

component_idstring

filter report to only include info pertaining to given component id

flagstring

filter report to only include info pertaining to given flag name

pathstring

filter report to only include file paths starting with this value

shastring

commit SHA for which to return report

Response

commit_file_urlstring required