How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Codacy Coverage API

Code coverage for pull requests and files.

Codacy Coverage API is one of 8 APIs that Codacy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Coverage. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 3.0.

Requests are made against a single base URL, https://api.codacy.com/api/v3.

2 operations 2 paths 4 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0
Base URL
https://api.codacy.com/api/v3
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Codacy Coverage API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-token (api-token). By default, every request must be authenticated.

  • api-token — Account API token created in your Codacy account settings.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Coverage 2

Code coverage for pull requests and files.

GET
/coverage/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}
Get coverage for a pull request.
getRepositoryPullRequestCoverage 4 params → 200
GET
/coverage/organizations/{provider}/{remoteOrganizationName}/repositories/{repositoryName}/pull-requests/{pullRequestNumber}/files
Get per-file coverage for a pull request.
getRepositoryPullRequestFilesCoverage 4 params → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are FileCoverage (4 properties), PaginationInfo (3 properties), PullRequestFilesCoverageResponse (2 properties), PullRequestWithCoverageResponse (1 property). Each schema is shown below with its type and property counts.

PullRequestWithCoverageResponse
object
1 property
PaginationInfo
object
3 properties
FileCoverage
object
4 properties
PullRequestFilesCoverageResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

codacy-coverage-api-openapi.yml Raw ↑

Other APIs Codacy publishes across the network.

Codacy Account API
Codacy Issues API
Codacy Organizations API
Codacy Pull Requests API
Codacy Quality Settings API
Codacy Repositories API
Codacy Security API
Where this information came from

This is an independent, third-party profile of Codacy Coverage API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.