Sign in
Dashboards

List all dashboards

Lists all current dashboards in your account.

get/v1/dashboards

Query parameters

limitinteger

Limit the number of results

Limit the number of results

pagenumber

Page number

Page number

Headers

x-checkly-accountstring uuid

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Response

Successful

customUrlstring nullable

A subdomain name under "checklyhq.com". Needs to be unique across all users.

customDomainstring nullable

A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.

headerstring

A piece of text displayed at the top of your dashboard.

descriptionstring nullable

A piece of text displayed below the header or title of your dashboard.

width'FULL' | '960PX'

Determines whether to use the full screen or focus in the center.

refreshRatenumber

How often to refresh the dashboard in seconds.

paginateboolean

Determines of pagination is on or off.

paginationRatenumber

How often to trigger pagination in seconds.

sortByStatusboolean

Sort checks by status with failing checks first.

checksPerPagenumber nullable

Number of checks displayed per page.

useTagsAndOperatorboolean nullable

When to use AND operator for tags lookup.

hideTagsboolean

Show or hide the tags on the dashboard.

enableIncidentsboolean

Enable or disable incidents on the dashboard.

expandChecksboolean

Expand or collapse checks on the dashboard.

tagsstring[]

A list of one or more tags that filter which checks to display on the dashboard.

showHeaderboolean

Show or hide header and description on the dashboard.

showCheckRunLinksboolean

Show or hide check run links on the dashboard.

showGroupNamesboolean

Show or hide group names on the dashboard.

customCSSstring nullable

Custom CSS to be applied to the dashboard.

isPrivateboolean

Determines if the dashboard is public or private.

showP95boolean

Show or hide the P95 stats on the dashboard.

showP99boolean

Show or hide the P99 stats on the dashboard.

idnumber required
dashboardIdstring required

The dashboard ID.

created_atstring date-time required

Example response

[
  {
    "projectBindings": {
      "owner": {
        "binding": {
          "logicalId": "homepage-check"
        }
      },
      "references": [
        {
          "binding": {
            "logicalId": "homepage-check"
          }
        }
      ]
    }
  }
]

Changes

Changed in 1 of the 4 revisions of this API.1

  • 87d29dc7b4fe1See the full diff
    • ○

      added the optional property items/projectBindings to the response with the 200 status

      response-optional-property-added

    This revision also has 566 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog