Dynamic JSON Badge
The Dynamic JSON Badge allows you to extract an arbitrary value from any JSON Document using a JSONPath selector and show it on a badge.
Query Parameters |
---|
url string — REQUIREDThe URL to a JSON document Example:
|
query string — REQUIREDA JSONPath expression that will be used to query the document Example:
|
prefix stringOptional prefix to append to the value Example:
|
suffix stringOptional suffix to append to the value Example:
|
style stringPossible values: [ If not specified, the default style for this badge is "flat". Example:
|
logo stringIcon slug from simple-icons. 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:
|
logoColor stringThe color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos. Example:
|
logoSize stringMake icons adaptively resize by setting Example:
|
label stringOverride the default left-hand-side text (URL-Encoding needed for spaces or special characters!) Example:
|
labelColor stringBackground color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported). Example:
|
color stringBackground color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported). Example:
|
cacheSeconds stringHTTP 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:
|
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 |