Skip to main content

Dashboard file

File nameResource
*.dashboard.yamlDashboard

GitOps file for a single space.

Queries​

panels[].queries[].query, panels[].query each take a Hamelin query, either inline as a string or as { $ref: <path> } pointing at a .hmln file. A $ref path is case-sensitive and must stay inside the GitOps directory.

Identity​

  • originKey: GitOps identity of the resource this file owns. The same value as the API's originKey.
  • id: Server-assigned id. Absent until the resource exists.

Fields​

FieldTypeRequiredDescription
defaultTimeRangestringRequired
folderstringOptionalA Folder by its originKey (managed in this repo) or its server id (FLD_…).
idstringOptionalServer-assigned id. Absent until the resource exists. Pattern: ^DSH_[A-Z0-9]{1,7}$.
namestringRequired
originKeystringRequiredGitOps identity of the resource this file owns. The same value as the API's originKey. Pattern: ^(?!perpetual:)[a-z][a-z0-9-]{0,31}:[A-Za-z0-9._~\-/:@]{1,256}$.
panelsarray of object (four variants)OptionalDefaults to [].
panels[][markdown].contentstringOptionalDefaults to .
panels[][markdown].idstringRequired
panels[][markdown].layoutobjectRequired
panels[][markdown].layout.hintegerRequiredMinimum 1.
panels[][markdown].layout.wintegerRequiredMinimum 1. Maximum 24.
panels[][markdown].layout.xintegerRequiredMinimum 0. Maximum 23.
panels[][markdown].layout.yintegerRequiredMinimum 0.
panels[][markdown].titleobjectOptional
panels[][markdown].title.alignenumOptionalOne of left, center, right.
panels[][markdown].title.sizeenumOptionalOne of sm, md, lg.
panels[][markdown].title.textstringRequired
panels[][markdown].typestringRequiredAlways markdown.
panels[][title].collapsedbooleanOptionalDefaults to false.
panels[][title].idstringRequired
panels[][title].layoutobjectRequired
panels[][title].layout.hintegerRequiredMinimum 1.
panels[][title].layout.wintegerRequiredMinimum 1. Maximum 24.
panels[][title].layout.xintegerRequiredMinimum 0. Maximum 23.
panels[][title].layout.yintegerRequiredMinimum 0.
panels[][title].titleobjectRequired
panels[][title].title.alignenumOptionalOne of left, center, right.
panels[][title].title.sizeenumOptionalOne of sm, md, lg.
panels[][title].title.textstringRequired
panels[][title].typestringRequiredAlways title.
panels[][table].idstringRequired
panels[][table].layoutobjectRequired
panels[][table].layout.hintegerRequiredMinimum 1.
panels[][table].layout.wintegerRequiredMinimum 1. Maximum 24.
panels[][table].layout.xintegerRequiredMinimum 0. Maximum 23.
panels[][table].layout.yintegerRequiredMinimum 0.
panels[][table].queryobject (one variants)RequiredOr a string.
panels[][table].query[variant 1].$refstringRequiredPath to a .hmln file, relative to this file. Must not be empty.
panels[][table].timeRangestringOptionalDefaults to .
panels[][table].titleobjectOptional
panels[][table].title.alignenumOptionalOne of left, center, right.
panels[][table].title.sizeenumOptionalOne of sm, md, lg.
panels[][table].title.textstringRequired
panels[][table].typestringRequiredAlways table.
panels[][vega-lite].idstringRequired
panels[][vega-lite].layoutobjectRequired
panels[][vega-lite].layout.hintegerRequiredMinimum 1.
panels[][vega-lite].layout.wintegerRequiredMinimum 1. Maximum 24.
panels[][vega-lite].layout.xintegerRequiredMinimum 0. Maximum 23.
panels[][vega-lite].layout.yintegerRequiredMinimum 0.
panels[][vega-lite].queriesarray of objectOptional
panels[][vega-lite].queries[].idstringRequiredMust not be empty.
panels[][vega-lite].queries[].namestringRequiredMust not be empty.
panels[][vega-lite].queries[].queryobject (one variants)RequiredOr a string.
panels[][vega-lite].queries[].query[variant 1].$refstringRequiredPath to a .hmln file, relative to this file. Must not be empty.
panels[][vega-lite].queryobject (one variants)OptionalRetired: use queries. Read as the panel's only query when queries is absent. Or a string.
panels[][vega-lite].query[variant 1].$refstringRequiredPath to a .hmln file, relative to this file. Must not be empty.
panels[][vega-lite].specobjectRequired
panels[][vega-lite].timeRangestringOptionalDefaults to .
panels[][vega-lite].titleobjectOptional
panels[][vega-lite].title.alignenumOptionalOne of left, center, right.
panels[][vega-lite].title.sizeenumOptionalOne of sm, md, lg.
panels[][vega-lite].title.textstringRequired
panels[][vega-lite].typestringRequiredAlways vega-lite.
refreshIntervalintegerRequired
spaceIdstringRequiredSpace the resource belongs to. Pattern: ^SPC_[A-Z0-9]{1,7}$.
templateVariablesarray of object (two variants)OptionalDefaults to [].
templateVariables[][primitive].defaultValuestringOptionalAt most 1024 characters.
templateVariables[][primitive].descriptionstringOptionalAt most 1024 characters.
templateVariables[][primitive].idstringRequiredMust not be empty.
templateVariables[][primitive].kindstringRequiredAlways primitive.
templateVariables[][primitive].namestringRequiredPattern: ^[a-zA-Z_][a-zA-Z_0-9]*$. Must not be empty. At most 64 characters.
templateVariables[][primitive].typeenumRequiredOne of int, double, boolean, string, interval.
templateVariables[][primitive].valuesarray of stringRequiredAt most 200 items.
templateVariables[][identifier_fragment].defaultValuestringRequiredPattern: ^[a-zA-Z0-9_]+$. At most 1024 characters.
templateVariables[][identifier_fragment].descriptionstringOptionalAt most 1024 characters.
templateVariables[][identifier_fragment].idstringRequiredMust not be empty.
templateVariables[][identifier_fragment].kindstringRequiredAlways identifier_fragment.
templateVariables[][identifier_fragment].namestringRequiredPattern: ^[a-zA-Z_][a-zA-Z_0-9]*$. Must not be empty. At most 64 characters.
templateVariables[][identifier_fragment].valuesarray of stringRequiredAt least 1 item. At most 200 items.

In a content pack​

A content pack's source directory uses the same file, with these differences:

  • Not used in a pack: originKey, spaceId.
  • These fields are new in a pack, or have a different type, requirement or meaning there:
FieldTypeRequiredDescription
folderstringOptionalid of a Folder file in the same pack. Omit to place the item at the pack root. Format: uuid. Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$.
idstringRequiredFormat: uuid. Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$.

Perpetual CLI 0.5.0