v3
latestOpenAPI 3.1.02026-07-311725107.3 KBCoverage
Get file coverage
Retrieve line-by-line test coverage data for a file at a specific Git reference or commit SHA
get/gh/{ownerKeyOrId}/projects/{projectKeyOrId}/coverage/file
Path parameters
ownerKeyOrIdstring required
Repository owner name (login) or workspace ID
Example:acme-corp
Repository owner name (login) or workspace ID
projectKeyOrIdstring required
Repository name or project ID
Example:my-repo
Repository name or project ID
Query parameters
referencestring required
Git reference (refs/heads/branch, refs/tags/tag) or commit SHA
Example:refs/heads/main
Git reference (refs/heads/branch, refs/tags/tag) or commit SHA
pathstring required
File path to get coverage for
Example:src/index.ts
File path to get coverage for
Response
Retrieve file coverage for the specified path
Example response
{
"tags": [
"unit",
"integration"
],
"files": [
{
"path": "src/index.ts",
"hits": [
1,
0,
1,
1,
0
],
"tag": "unit",
"coveredLines": 42,
"missedLines": 8,
"omitLines": 10,
"totalLines": 60
}
]
}