Skip to main content
Version: Next

TimeRangeLimitsDashboardSchema

dashboard object
max_look_back objectnullable
quantityinteger

How many time grains.

time_grainstring

The ISO 8601 time grain, e.g. P1W.

max_look_forward objectnullable
quantityinteger

How many time grains.

time_grainstring

The ISO 8601 time grain, e.g. P1W.

max_span objectnullable
quantityinteger

How many time grains.

time_grainstring

The ISO 8601 time grain, e.g. P1W.

datasets object[]

The dashboard's chart datasets with a policy that the caller can read, including authorized embedded member datasets. Datasets the caller cannot read are omitted; their charts are not held client-side because of that omission and retain server access and limit checks.

  • Array [
  • error object

    Present when this dataset's policy cannot be loaded; policy is null. Only this dataset's charts must remain held.

    error_typestring
    extraobject

    POLICY_UNAVAILABLE details; stored value is included only for dataset editors on GET and is omitted on PUT.

    messagestring
    idinteger
    namestring
    policy objectnullable
    max_look_back objectnullable
    quantityinteger

    How many time grains.

    time_grainstring

    The ISO 8601 time grain, e.g. P1W.

    max_look_forward objectnullable
    quantityinteger

    How many time grains.

    time_grainstring

    The ISO 8601 time grain, e.g. P1W.

    max_span objectnullable
    quantityinteger

    How many time grains.

    time_grainstring

    The ISO 8601 time grain, e.g. P1W.

  • ]
  • editor_notice objectnullable

    The notice the current user gets as a dashboard editor when the global time range limits turned on or got stricter since they acknowledged them; null for everyone else.

    kindstring

    turned_on or tightened

    Possible values: [turned_on, tightened]

    effective object
    activeboolean
    max_look_back object
    constraints object[]
  • Array [
  • quantityinteger

    How many time grains.

    sourcestring

    global or dashboard

    time_grainstring

    The ISO 8601 time grain, e.g. P1W.

  • ]
  • display_labelstring
    max_look_forward object
    constraints object[]
  • Array [
  • quantityinteger

    How many time grains.

    sourcestring

    global or dashboard

    time_grainstring

    The ISO 8601 time grain, e.g. P1W.

  • ]
  • display_labelstring
    max_span object
    constraints object[]
  • Array [
  • quantityinteger

    How many time grains.

    sourcestring

    global or dashboard

    time_grainstring

    The ISO 8601 time grain, e.g. P1W.

  • ]
  • display_labelstring
    eligible_time_grains object[]

    The time grains a rule may use.

  • Array [
  • labelstring
    valuestring
  • ]
  • global object
    max_look_back objectnullable
    quantityinteger

    How many time grains.

    time_grainstring

    The ISO 8601 time grain, e.g. P1W.

    max_look_forward objectnullable
    quantityinteger

    How many time grains.

    time_grainstring

    The ISO 8601 time grain, e.g. P1W.

    max_span objectnullable
    quantityinteger

    How many time grains.

    time_grainstring

    The ISO 8601 time grain, e.g. P1W.

    global_revisioninteger

    Always 0.

    needs_review object[]
  • Array [
  • reasonstring

    LOOSER_THAN_GLOBAL or UNIT_MISMATCH

    rulestring
  • ]
  • schema_versioninteger
    time_grain_labels object

    The label of every time grain the registry knows, eligible or not, by value.

    property name*string
    timezonestring

    The server's time zone, to show: an IANA name when TZ is set, else an abbreviation such as CEST.

    TimeRangeLimitsDashboardSchema
    {
    "dashboard": {
    "max_look_back": {
    "quantity": 0,
    "time_grain": "string"
    },
    "max_look_forward": {
    "quantity": 0,
    "time_grain": "string"
    },
    "max_span": {
    "quantity": 0,
    "time_grain": "string"
    }
    },
    "datasets": [
    {
    "error": {
    "error_type": "string",
    "extra": {},
    "message": "string"
    },
    "id": 0,
    "name": "string",
    "policy": {
    "max_look_back": {
    "quantity": 0,
    "time_grain": "string"
    },
    "max_look_forward": {
    "quantity": 0,
    "time_grain": "string"
    },
    "max_span": {
    "quantity": 0,
    "time_grain": "string"
    }
    }
    }
    ],
    "editor_notice": {
    "kind": "turned_on"
    },
    "effective": {
    "active": true,
    "max_look_back": {
    "constraints": [
    {
    "quantity": 0,
    "source": "string",
    "time_grain": "string"
    }
    ],
    "display_label": "string"
    },
    "max_look_forward": {
    "constraints": [
    {
    "quantity": 0,
    "source": "string",
    "time_grain": "string"
    }
    ],
    "display_label": "string"
    },
    "max_span": {
    "constraints": [
    {
    "quantity": 0,
    "source": "string",
    "time_grain": "string"
    }
    ],
    "display_label": "string"
    }
    },
    "eligible_time_grains": [
    {
    "label": "string",
    "value": "string"
    }
    ],
    "global": {
    "max_look_back": {
    "quantity": 0,
    "time_grain": "string"
    },
    "max_look_forward": {
    "quantity": 0,
    "time_grain": "string"
    },
    "max_span": {
    "quantity": 0,
    "time_grain": "string"
    }
    },
    "global_revision": 0,
    "needs_review": [
    {
    "reason": "string",
    "rule": "string"
    }
    ],
    "schema_version": 0,
    "time_grain_labels": {},
    "timezone": "string"
    }