Skip to main content

Codecov branch

You may specify a Codecov badge token to get coverage for a private repository.

You can find the token under the badge section of your project settings page, in this url: https://codecov.io/{vcsName}/{user}/{repo}/settings/badge.

Path Parameters
vcsName string — REQUIRED

Possible values: [github, gh, bitbucket, bb, gl, gitlab]

Example: github
user string — REQUIRED
Example: codecov
repo string — REQUIRED
Example: example-node
branch string — REQUIRED
Example: master
Query Parameters
token string
Example: a1b2c3d4e5
flag string
Example: flag_name
style string

One of: flat (default), flat-square, plastic, for-the-badge, social

Example: flat
logo string

One of the named logos (bitcoin, dependabot, gitlab, npm, paypal, serverfault, stackexchange, superuser, telegram, travis) or simple-icons. All simple-icons are referenced using icon slugs. You can click the icon title on simple-icons to copy the slug or they can be found in the slugs.md file in the simple-icons repository. Further info.

Example: appveyor
logoColor string

The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for named logos and Shields logos but not for custom logos. For multicolor Shields logos, the corresponding named logo will be used and colored.

Example: violet
label string

Override the default left-hand-side text (URL-Encoding needed for spaces or special characters!)

Example: healthiness
labelColor string

Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported).

Example: abcdef
color string

Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported).

Example: fedcba
cacheSeconds string

HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored).

Example: 3600
link string[]

Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an <object> HTML tag, but not an <img> tag or a markup language.