v1

latestOpenAPI 3.0.32026-07-24354865.6 KB
Coverage

Coverage trend

Returns a paginated list of timeseries measurements aggregated by the specified interval. If there are no measurements on start_date then the response will include 1 measurement older than start_date so that the coverage value can be carried forward if necessary.

Optionally filterable by:

  • branch
  • start_date
  • end_date
get/{service}/{owner_username}/repos/{repo_name}/coverage/

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

end_datestring date-time

end datetime (inclusive)

interval'1d' | '30d' | '7d' required
  • 1d - 1 day
  • 7d - 7 day
  • 30d - 30 day
pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

start_datestring date-time

start datetime (inclusive)

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}