openapi: 3.0.3 info: title: Splunk Observability Cloud — Dashboards version: 3.3.0 description: 'API for creating, retrieving, updating, and deleting dashboards. Requirements You must have an organization access token with the API permission or a session token to use the API. You must have the Splunk Observability Cloud admin or power role to use the POST /dashboard, POST /dashboard/simple, PUT /dashboard/{id}, and DELETE /dashboard/{id} endpoints. You must have the Splunk Observability Cloud admin, power, read-only, or usage role to use the GET /dashboard and GET /dashboard/{id} endpoints.' x-provenance: method: reconstructed authored_by: Splunk (content) / API Evangelist (assembly) reconstructed_by: API Evangelist reconstructed_on: '2026-08-19' first_party: false provider_published: false note: Splunk's own OpenAPI objects, extracted from the React Server Component payload embedded in each of the 48 API reference pages at dev.splunk.com. The operations and schemas are Splunk's; the assembly into standalone documents is API Evangelist's. Splunk serves no fetchable spec file — dev.splunk.com answers 200 with an identical 6,638-byte shell for every asset path, including invented control paths — so this is NOT first-party publication and is not graded as such. x-evidence: - type: source url: https://dev.splunk.com/observability/reference/ - type: source url: https://dev.splunk.com/observability/docs/apibasics/api_list/ servers: - url: https://api.{REALM}.observability.splunkcloud.com/v2 description: Endpoint URL for Dashboards API variables: REALM: default: us0 description: Splunk Observability Cloud realm the organization is provisioned in (for example us0, us1, eu0, jp0, au0). security: - SessionToken: [] components: securitySchemes: SessionToken: type: apiKey in: header name: X-SF-Token description: Splunk Observability Cloud session token or org access token. paths: /dashboard: get: summary: Retrieve Dashboards Using Query description: 'Retrieves one or more dashboard objects, based on query parameters you encode on the request URL. If you don''t specify parameters, the request returns the first 50 objects that the user has access to, based on the access token specified in the request header. Query parameters also control the point in the result set at which the system starts returning objects, and the number of objects to return. Note: Splunk Observability Cloud returns a maximum of 10,000 objects, even if your organization contains more than 10,000. To learn more, see the Considerations for retrieve operations section in the developer guide.' parameters: - name: chartId in: query description: Search string that will find the dashboard that contains the chart with this chart ID. schema: type: string - name: limit in: query description: 'The maximum number of dashboards to return. If the value isn''t valid, the system defaults to 50 dashboards.' schema: type: integer format: int32 - name: name in: query description: 'Search string that the system compares to existing dashboard names. A match occurs if the string matches any part of the dashboard name. For example, the query specification name="per" matches the following (ellipses represent other parts of the name): "...dropped per day..." "...95th percentile" "personal disk usage..." If you specify name="", the system ignores the search string. The string must only contain ASCII characters.' schema: type: string - name: offset in: query description: '0-based index of the point in the query results where the system starts returning dashboards. If the offset value is greater than the size of the result set, you don''t receive any results.' schema: type: integer format: int32 - name: Content-Type in: header description: Format of the request body. Always application/json. required: true schema: type: string - name: X-SF-TOKEN in: header description: Authentication token required: true schema: type: string responses: '200': description: HTTP 200 response content: application/json: schema: type: object properties: count: type: integer format: int32 description: 'Number of dashboards that matched the provided search criteria. Note: This value is the total number of matches. The number of dashboards that the system returns is affected by the limit and offset query parameters. In summary: count: Size of result set number of returned dashboards: (limit - offset) >= count: count (limit - offset) < count: limit - offset' results: type: array items: type: object properties: authorizedWriters: title: Users and teams with that can modify this dashboard type: object properties: teams: type: array items: type: string example: - ZZZZ4 - Z2X description: 'List of team IDs that have write access to this dashboard, in the form of a JSON array of strings' users: type: array items: type: string example: - YXXX - XYYY description: 'List of user IDs that have write access to this dashboard, in the form of a JSON array of strings' description: 'If the write permissions feature is available for your organization, you can use these properties to specify the user and team IDs that have write access to the chart of dashboard.' chartDensity: type: string default: DEFAULT enum: - DEFAULT - LOW - HIGH - HIGHEST example: DEFAULT title: DashboardChartDensity description: 'Controls the number of data points displayed in the charts for this dashboard, over the time span specified for the charts: DEFAULT maps to approximately 60 data points LOW maps to approximately 30 data points HIGH maps to approximately 120 data points HIGHEST maps to approximately 240 data points' charts: type: array items: title: Dashboard settings for a chart in a dashboard type: object required: - chartId - column - row - height - width properties: chartId: type: string example: XY1XX5 description: 'ID of an existing chart. Because charts can only belong to one dashboard, you can''t associate this ID with any other dashboard.' column: type: integer minimum: 0 maximum: 11 example: 5 description: '0-based index of the horizontal position of the chart in the dashboard display. The position represents the left-most edge of the chart. If you specify the same column and row value for more than one chart, the system tries to reconfigure the layout. If there''s space, the dashboard retains the column value and spreads out over additional rows. Note: The API doesn''t validate the maximum value. However, if you specify a value greater than 11, the chart displays in the UI as if 11 was specified. If that column is already occupied in the specified row, the system displays the chart in the first free row from the top in the specified column.' height: type: integer minimum: 1 maximum: 3 example: 2 description: 'Number of rows this chart should span. Note: The API doesn''t validate the maximum value. However, if you specify a value greater than 3, the chart displays in the UI as if 3 was specified. If the total height of all specified charts in a column is greater than 100, the system recalculates the layout to fit all the specified charts into the display of the dashboard.' row: type: integer minimum: 0 maximum: 99 example: 10 description: '0-based index of the vertical position of the chart in the dashboard display. The position The value represents the top-most edge of the chart. the system moves charts upwards as needed to fill vertical gaps. If you specify the same column and row value for more than one chart, the system tries to reconfigure the layout. If there''s space, the dashboard retains the column value and spreads out over additional rows. The API doesn''t validate the maximum value. However, if you specify a value greater than 99, the chart displays as if 0 were specified. If that row is already occupied, the system displays the first free row from the top of the specified column.' width: type: integer minimum: 1 maximum: 12 example: 7 description: 'Number of columns this chart should span. The API doesn''t validate the maximum value. However, if you use a value greater than 12, the chart displays as if you specified 12. If the total width of all specified charts in a row is greater than 100, the system recalculates the layout so that all the specified charts fit into the display.' description: 'Dashboard settings for the chart specified in chartId. These settings control how the chart appears in the dashboard.' title: DashboardChartSettings description: 'List of IDs for the charts you want to include in the dashboard, and for each chart the dashboard settings to use, in the form of a JSON array of JSON objects. The dashboard settings for charts control how Splunk Observability Cloud arranges charts in a dashboard when the charts appear in the UI.' created: type: integer format: int64 example: 1641024000000 title: DashboardCreated description: 'The dashboard creation timestamp, in *nix time in milliseconds The system sets this value, and you can''t modify it.' creator: type: string example: XXYYX title: DashboardCreator description: 'ID of the user that created the dashboard. If Splunk Observability Cloud created this dashboard, the value is AAAAAAAAAA. The system sets this value, and you can''t modify it.' customProperties: type: string title: DashboardCustomProperties description: not used description: type: string example: Latency measurements title: DashboardDescription description: 'Description of the dashboard. The system displays the value in the dashboard tab tooltip in the dashboard group in the UI.' discoveryOptions: type: object title: DashboardDiscoveryOptions description: Reserved for system use eventOverlays: type: array items: title: Filter to apply to event overlays type: object required: - property - value properties: eventSignal: title: A search term that selects charts to overlay type: object required: - eventSearchText properties: eventSearchText: type: string example: ValueExceeded description: 'The event name or partial name that the system uses to select events to suggest as overlays on the charts in the dashboard' eventType: type: string enum: - detectorEvents - eventTimeSeries example: detectorEvents description: 'Controls the source of the event. You can specify the following: detectorEvents: Select events that come from a detector eventTimeSeries: Select events that come from a time series The API doesn''t accept other event types.' description: 'A filter that selects charts to overlay with events, based on event names and types' eventColorIndex: type: integer minimum: 0 maximum: 15 example: 5 description: 'Color to use for events, in the form of an integer index into the color table displayed in table 5 Color palette in the section Chart color palettes. Only the first 16 entries (0-15) are allowed for this value. Users may see colors other than those shown in the table, depending on the settings they select for color blindness. To see sample swatches of the alternate colors and the mappings used for color-blind users, see the hexadecimal color codes for the first 16 entries in table 6, Color vision deficiency alternatives in the section Chart color palettes.' eventLine: type: boolean default: false example: true description: 'Controls the display of vertical event lines in the charts that belong to the dashboard. If true, the system displays event lines; otherwise, no event lines appear.' sources: type: array items: properties: NOT: type: boolean default: false example: false description: 'Controls the action of the filter. If set to true, then the system only selects events that don''t match the filter.' property: type: string example: datacenter description: 'The custom property or dimension name that provides the value to test in the filter. If the name you specify isn''t defined in one or more of the events associated with the dashboard, the filter never matches anything. If the NOT property for this filter is set to true and the filter never matches, all event overlays are suppressed.' value: type: array items: type: string example: - Paris - London description: 'An array of values to test against the specified property. If any of the values match, the system includes the event. Note: You must specify at least one element.' title: DashboardEventSources description: 'List of filters to apply to events for this event overlay, in the form of a JSON array.' description: 'Filters to apply to event overlays, in the form of a JSON object containing comparison expression properties. Each term in the expression tries to match the values of a dimension or custom property to criteria you specify. Based on the match results, you can include or exclude an event.' title: DashboardEventOverlays description: 'List of event overlay definitions that you can apply to all of the charts of this dashboard, in the form of a JSON array of JSON objects. When you apply the overlays, the system displays all the active events that match the specified search term and any specified filter on all the charts in the dashboard. The display uses the color you specify for the overlay and, if selected, vertical lines that mark the event. Note: The objects in this array correspond to the suggested event overlays specified in the UI, and they''re not automatically applied as active overlays. To set default active event overlays, use the selectedEventOverlays property instead.' filters: title: Filters to apply to all the charts of a dashboard type: object properties: sources: type: array items: title: Filter to apply to charts in a dashboard type: object required: - property - value properties: NOT: type: boolean default: false example: false description: 'Flag that indicates how the filter should operate. If true, data that matches the criteria is excluded from charts; otherwise, data that matches the criteria is included.' property: type: string example: host description: 'Name of the dimension or custom property to match to the data. Note: If the dimension or custom property doesn''t exist in any of the charts for the dashboard, and ChartsFilter.NOT is true, the system doesn''t display any data in the charts.' value: type: array items: type: string example: - host5 - host6 description: 'A list of values to compare to the value of the dimension or custom property specified in ChartsFilter.property. If the list contains more than one value, the filter becomes a set of queries between the value of property and each element of value. The system joins these queries with an implicit OR.' description: 'A single filter to apply to the charts in the dashboard. The filter specifies a default or user-defined dimension or custom property. You can either include or exclude all the data that matches the dimension or custom property.' description: 'List of filters to apply to the charts in the dashboard, in the form of a JSON array. Each element is a single filter for a default or user-defined dimension or custom property.' time: type: object properties: end: type: string example: 1647943200000 description: 'The end of the time range to show for all charts in the dashboard. If you don''t specify a value for this property, the system defaults to the value of the end property for each chart. Note: The specified type for end is string, but the system also accepts a 64-bit signed integer >= 0 that represents a time in *nix time in milliseconds.' start: type: string example: 1647936000000 description: 'The start of the time range to show for all charts in the dashboard. If you don''t specify a value for this property, the system defaults to the value of the start property for each chart. Note: The specified type for start is string, but the system also accepts a 64-bit signed integer >= 0 that represents a time in *nix time in milliseconds.' description: 'Time range to show in all of the charts in the dashboard, in the form of a JSON object. The specifications in this object override those in each individual chart. If you don''t specify values, the system defaults to using the individual time setting for each chart.' variables: type: array items: title: Filter that appears in the UI type: object required: - property - value properties: alias: type: string example: Europe description: 'A label for the filter. The system displays this label in the area preceding the input textarea for the filter in the UI. Note: A good way to indicate that the string is a label is to append a space and a colon (":") to it.' preferredSuggestions: type: array items: type: string example: - Europe - Asia description: 'List of strings containing values to place at the top of the Suggested Values dropdown in UI for the dashboard, in the form of a JSON array. If ChartsWebUIFilter.restricted is true, the filter must use one of the values in this array; users only have a choice of selecting a value from this array.' property: type: string example: datacenter description: 'Name of a custom property or dimension to filter against. Note: If the dimension or custom property doesn''t exist in any of the charts in the dashboard, the system doesn''t display any data in the charts.' required: type: boolean default: false example: true description: 'Flag that controls the display of chart data. If true, users must use this filter in order to see data; otherwise, users can delete the filter.' restricted: type: boolean default: false example: true description: 'Flag that controls the values allowed in the filter. If true, the only allowable values are those specified in the ChartsWebUIFilter.preferredSuggestions array; otherwise, any value is allowed.' value: type: array items: type: string example: - London - Paris description: 'A list of values to compare to the value of the dimension or custom property specified in ChartsWebUIFilter.property. If the list contains more than one value, the filter becomes a set of queries between the value of property and each element of value. The system joins these queries with an implicit OR.' description: 'The specification for a filter that appears in the UI. The filter compares the value of a dimension or custom property to a value specified in this filter. You can specify the following in the filter: A default value A list of suggested values to display in the UI A flag that controls user input; if set to true, users are limited to the default and suggested values. You can also force users to choose this filter in order to see data in the charts of this dashboard.' description: 'List of UI-oriented filters that appear at the top of the dashboard, in the form of a JSON array of JSON objects. For each filter you can specify a name and a label for the dimension or custom property to filter against, a list of suggested comparison values to display in the UI, and other properties that control the UI display. To see a more detailed description of the options, see the property descriptions for the ChartsWebUIFilter model.' description: 'Specifies the properties of filters to apply to the dashboard. Filters give you fine-grained control over the data displayed in the charts in the dashboard. You can specify ad hoc filters or save them as variables for repeated use of the filter criteria. You can also use filters to apply a custom time window to all of the charts in the dashboard.' groupId: type: string example: YYXXYY title: DashboardGroupId description: 'ID of an existing dashboard group to associate with this dashboard. If you don''t specify a value, the system creates a new dashboard group and assigns its ID to this property during the create process.' id: type: string example: ZZZXXXX title: DashboardId description: 'The ID of the dashboard. This value is read-only for a create request. Splunk Observability Cloud assigns it and returns it to you in the response.' lastUpdated: type: integer format: int64 example: 1647990000000 title: DashboardLastUpdated description: 'The last time the dashboard was updated, in *nix time in milliseconds. The system sets this value, and you can''t modify it.' lastUpdatedBy: type: string example: XXXX888 title: DashboardLastUpdatedBy description: 'ID of the last user who updated the dashboard. If the last update was by Splunk Observability Cloud, the value is AAAAAAAAAA. This value is read-only.' maxDelayOverride: type: integer format: int32 example: 1000 title: DashboardMaxDelayOverride description: 'Milliseconds to wait for late-arriving data points before rejecting them for inclusion in the charts in this dashboard. This value overrides but doesn''t change the max delay setting for individual charts in the dashboard. If you omit this property, the system uses individual chart settings. For individual charts, you can force the system to calculate a sensible value by removing the maxDelayOverride property of the chart. To force the system to do this for all charts in a dashboard, set CreateDashboardBody.maxDelayOverride to 0.' name: type: string example: Latency title: DashboardName description: 'A human-readable label for the dashboard. The UI displays this label in the dashboard group for the dashboard' selectedEventOverlays: type: array items: title: Event overlay for charts in a dashboard type: object required: - eventSignal properties: eventSignal: title: A search term that selects charts to overlay type: object required: - eventSearchText properties: eventSearchText: type: string example: ValueExceeded description: 'The event name or partial name that the system uses to select events to suggest as overlays on the charts in the dashboard' eventType: type: string enum: - detectorEvents - eventTimeSeries example: detectorEvents description: 'Controls the source of the event. You can specify the following: detectorEvents: Select events that come from a detector eventTimeSeries: Select events that come from a time series The API doesn''t accept other event types.' description: 'A filter that selects charts to overlay with events, based on event names and types' overlayId: type: string example: E5 description: 'Unique ID for this event overlay. Use this ID with any element of the selectedEventOverlays property to apply this overlay to a dashboard. Note: The system generates this value if you don''t specify one.' sources: type: array items: properties: NOT: type: boolean default: false example: false description: 'Controls the action of the filter. If set to true, then the system only selects events that don''t match the filter.' property: type: string example: datacenter description: 'The custom property or dimension name that provides the value to test in the filter. If the name you specify isn''t defined in one or more of the events associated with the dashboard, the filter never matches anything. If the NOT property for this filter is set to true and the filter never matches, all event overlays are suppressed.' value: type: array items: type: string example: - Paris - London description: 'An array of values to test against the specified property. If any of the values match, the system includes the event. Note: You must specify at least one element.' title: DashboardEventSources description: 'List of filters to apply to events for this event overlay, in the form of a JSON array.' description: 'Settings for an event overlay applied to each chart in a dashboard. You specify the event overlays for a dashboard with two different properties: CreateDashboardBody.EventOverlays: Inactive event overlays that you want to define for use at a later time. CreateDashboardBody.selectedEventOverlays: Active event overlays that you want to apply immediately to charts in the dashboard.' title: DashboardSelectedEventOverlays description: 'List of event overlays that are currently active for the charts in this dashboard, in the form of a JSON array of JSON objects. For each overlay, the system displays the active events that match the overlay search term and optional feature, using the color and event line settings for the overlay. To set options for inactive overlays so you can apply them at a later time, use the eventOverlays property instead.' tags: type: array items: type: string title: DashboardTags description: not used permissions: title: Permission configuration for the dashboard type: object properties: acl: type: array items: title: An access control layer type: object properties: actions: type: array items: type: string enum: - READ - WRITE description: Action the user, team, or organization can take with the dashboard. principalType: type: string enum: - USER - TEAM - ORG description: Clarify whether this permission configuration is for a user, a team, or an organization. principalId: type: string description: ID of the user, team, or organization for which you're granting permissions. description: A permission configuration for a user, team, or organization. description: 'List of permission configurations. Use this list to specify read and write permissions for your dashboard. The parent property is set to null by default if you do this. Use the parent property instead if you want your dashboard to inherit permissions from an existing dashboard group.' parent: type: string description: 'ID of the dashboard group you want your dashboard to inherit permissions from. Use this property to configure your dashboard to inherit permissions from an existing dashboard group. Use the acl property instead if you want to specify various read and write permission configurations.' description: Read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard. description: 'List of dashboard objects that the system returns as the result of the request. These objects represent dashboards that match the search query. The number and location of the objects within the result set depend on the query parameters you specify in the request. To learn more, see the top-level description of the API and the description of the count response property' description: 'Response body containing the query results, in the form of a JSON object' examples: example: value: count: 0 results: - authorizedWriters: teams: - ZZZZ4 - Z2X users: - YXXX - XYYY chartDensity: DEFAULT charts: - chartId: XY1XX5 column: 5 height: 2 row: 10 width: 7 created: 1641024000000 creator: XXYYX customProperties: string description: Latency measurements eventOverlays: - eventColorIndex: 5 eventLine: true eventSignal: eventSearchText: ValueExceeded eventType: detectorEvents sources: - NOT: false property: datacenter value: - Paris - London filters: sources: - NOT: false property: host value: - host5 - host6 time: end: 1647943200000 start: 1647936000000 variables: - alias: Europe preferredSuggestions: - Europe - Asia property: datacenter required: true restricted: true value: - London - Paris groupId: YYXXYY id: ZZZXXXX lastUpdated: 1647990000000 lastUpdatedBy: XXXX888 maxDelayOverride: 1000 name: Latency permissions: acl: - actions: - READ principalId: string principalType: USER parent: string selectedEventOverlays: - eventSignal: eventSearchText: ValueExceeded eventType: detectorEvents overlayId: E5 sources: - NOT: false property: datacenter value: - Paris - London tags: - string security: - SessionToken: [] tags: - Dashboards post: summary: Create Single Dashboard description: 'Creates a dashboard using the properties specified in the request body. If the write permissions feature is available in your organization, you can specify the users and teams that who have permission to edit or delete the dashboard or its charts.' parameters: - name: Content-Type in: header description: Format of the request body. Always application/json. required: true schema: type: string - name: X-SF-TOKEN in: header description: Authentication token required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: authorizedWriters: title: Users and teams with that can modify this dashboard type: object properties: teams: type: array items: type: string example: - ZZZZ4 - Z2X description: 'List of team IDs that have write access to this dashboard, in the form of a JSON array of strings' users: type: array items: type: string example: - YXXX - XYYY description: 'List of user IDs that have write access to this dashboard, in the form of a JSON array of strings' description: 'If the write permissions feature is available for your organization, you can use these properties to specify the user and team IDs that have write access to the chart of dashboard.' chartDensity: type: string default: DEFAULT enum: - DEFAULT - LOW - HIGH - HIGHEST example: DEFAULT title: DashboardChartDensity description: 'Controls the number of data points displayed in the charts for this dashboard, over the time span specified for the charts: DEFAULT maps to approximately 60 data points LOW maps to approximately 30 data points HIGH maps to approximately 120 data points HIGHEST maps to approximately 240 data points' charts: type: array items: title: Dashboard settings for a chart in a dashboard type: object required: - chartId - column - row - height - width properties: chartId: type: string example: XY1XX5 description: 'ID of an existing chart. Because charts can only belong to one dashboard, you can''t associate this ID with any other dashboard.' column: type: integer minimum: 0 maximum: 11 example: 5 description: '0-based index of the horizontal position of the chart in the dashboard display. The position represents the left-most edge of the chart. If you specify the same column and row value for more than one chart, the system tries to reconfigure the layout. If there''s space, the dashboard retains the column value and spreads out over additional rows. Note: The API doesn''t validate the maximum value. However, if you specify a value greater than 11, the chart displays in the UI as if 11 was specified. If that column is already occupied in the specified row, the system displays the chart in the first free row from the top in the specified column.' height: type: integer minimum: 1 maximum: 3 example: 2 description: 'Number of rows this chart should span. Note: The API doesn''t validate the maximum value. However, if you specify a value greater than 3, the chart displays in the UI as if 3 was specified. If the total height of all specified charts in a column is greater than 100, the system recalculates the layout to fit all the specified charts into the display of the dashboard.' row: type: integer minimum: 0 maximum: 99 example: 10 description: '0-based index of the vertical position of the chart in the dashboard display. The position The value represents the top-most edge of the chart. the system moves charts upwards as needed to fill vertical gaps. If you specify the same column and row value for more than one chart, the system tries to reconfigure the layout. If there''s space, the dashboard retains the column value and spreads out over additional rows. The API doesn''t validate the maximum value. However, if you specify a value greater than 99, the chart displays as if 0 were specified. If that row is already occupied, the system displays the first free row from the top of the specified column.' width: type: integer minimum: 1 maximum: 12 example: 7 description: 'Number of columns this chart should span. The API doesn''t validate the maximum value. However, if you use a value greater than 12, the chart displays as if you specified 12. If the total width of all specified charts in a row is greater than 100, the system recalculates the layout so that all the specified charts fit into the display.' description: 'Dashboard settings for the chart specified in chartId. These settings control how the chart appears in the dashboard.' title: DashboardChartSettings description: 'List of IDs for the charts you want to include in the dashboard, and for each chart the dashboard settings to use, in the form of a JSON array of JSON objects. The dashboard settings for charts control how Splunk Observability Cloud arranges charts in a dashboard when the charts appear in the UI.' description: type: string example: Latency measurements title: DashboardDescription description: 'Description of the dashboard. The system displays the value in the dashboard tab tooltip in the dashboard group in the UI.' eventOverlays: type: array items: title: Filter to apply to event overlays type: object required: - property - value properties: eventSignal: title: A search term that selects charts to overlay type: object required: - eventSearchText properties: eventSearchText: type: string example: ValueExceeded description: 'The event name or partial name that the system uses to select events to suggest as overlays on the charts in the dashboard' eventType: type: string enum: - detectorEvents - eventTimeSeries example: detectorEvents description: 'Controls the source of the event. You can specify the following: detectorEvents: Select events that come from a detector eventTimeSeries: Select events that come from a time series The API doesn''t accept other event types.' description: 'A filter that selects charts to overlay with events, based on event names and types' eventColorIndex: type: integer minimum: 0 maximum: 15 example: 5 description: 'Color to use for events, in the form of an integer index into the color table displayed in table 5 Color palette in the section Chart color palettes. Only the first 16 entries (0-15) are allowed for this value. Users may see colors other than those shown in the table, depending on the settings they select for color blindness. To see sample swatches of the alternate colors and the mappings used for color-blind users, see the hexadecimal color codes for the first 16 entries in table 6, Color vision deficiency alternatives in the section Chart color palettes.' eventLine: type: boolean default: false example: true description: 'Controls the display of vertical event lines in the charts that belong to the dashboard. If true, the system displays event lines; otherwise, no event lines appear.' sources: type: array items: properties: NOT: type: boolean default: false example: false description: 'Controls the action of the filter. If set to true, then the system only selects events that don''t match the filter.' property: type: string example: datacenter description: 'The custom property or dimension name that provides the value to test in the filter. If the name you specify isn''t defined in one or more of the events associated with the dashboard, the filter never matches anything. If the NOT property for this filter is set to true and the filter never matches, all event overlays are suppressed.' value: type: array items: type: string example: - Paris - London description: 'An array of values to test against the specified property. If any of the values match, the system includes the event. Note: You must specify at least one element.' title: DashboardEventSources description: 'List of filters to apply to events for this event overlay, in the form of a JSON array.' description: 'Filters to apply to event overlays, in the form of a JSON object containing comparison expression properties. Each term in the expression tries to match the values of a dimension or custom property to criteria you specify. Based on the match results, you can include or exclude an event.' title: DashboardEventOverlays description: 'List of event overlay definitions that you can apply to all of the charts of this dashboard, in the form of a JSON array of JSON objects. When you apply the overlays, the system displays all the active events that match the specified search term and any specified filter on all the charts in the dashboard. The display uses the color you specify for the overlay and, if selected, vertical lines that mark the event. Note: The objects in this array correspond to the suggested event overlays specified in the UI, and they''re not automatically applied as active overlays. To set default active event overlays, use the selectedEventOverlays property instead.' filters: title: Filters to apply to all the charts of a dashboard type: object properties: sources: type: array items: title: Filter to apply to charts in a dashboard type: object required: - property - value properties: NOT: type: boolean default: false example: false description: 'Flag that indicates how the filter should operate. If true, data that matches the criteria is excluded from charts; otherwise, data that matches the criteria is included.' property: type: string example: host description: 'Name of the dimension or custom property to match to the data. Note: If the dimension or custom property doesn''t exist in any of the charts for the dashboard, and ChartsFilter.NOT is true, the system doesn''t display any data in the charts.' value: type: array items: type: string example: - host5 - host6 description: 'A list of values to compare to the value of the dimension or custom property specified in ChartsFilter.property. If the list contains more than one value, the filter becomes a set of queries between the value of property and each element of value. The system joins these queries with an implicit OR.' description: 'A single filter to apply to the charts in the dashboard. The filter specifies a default or user-defined dimension or custom property. You can either include or exclude all the data that matches the dimension or custom property.' description: 'List of filters to apply to the charts in the dashboard, in the form of a JSON array. Each element is a single filter for a default or user-defined dimension or custom property.' time: type: object properties: end: type: string example: 1647943200000 description: 'The end of the time range to show for all charts in the dashboard. If you don''t specify a value for this property, the system defaults to the value of the end property for each chart. Note: The specified type for end is string, but the system also accepts a 64-bit signed integer >= 0 that represents a time in *nix time in milliseconds.' start: type: string example: 1647936000000 description: 'The start of the time range to show for all charts in the dashboard. If you don''t specify a value for this property, the system defaults to the value of the start property for each chart. Note: The specified type for start is string, but the system also accepts a 64-bit signed integer >= 0 that represents a time in *nix time in milliseconds.' description: 'Time range to show in all of the charts in the dashboard, in the form of a JSON object. The specifications in this object override those in each individual chart. If you don''t specify values, the system defaults to using the individual time setting for each chart.' variables: type: array items: title: Filter that appears in the UI type: object required: - property - value properties: alias: type: string example: Europe description: 'A label for the filter. The system displays this label in the area preceding the input textarea for the filter in the UI. Note: A good way to indicate that the string is a label is to append a space and a colon (":") to it.' preferredSuggestions: type: array items: type: string example: - Europe - Asia description: 'List of strings containing values to place at the top of the Suggested Values dropdown in UI for the dashboard, in the form of a JSON array. If ChartsWebUIFilter.restricted is true, the filter must use one of the values in this array; users only have a choice of selecting a value from this array.' property: type: string example: datacenter description: 'Name of a custom property or dimension to filter against. Note: If the dimension or custom property doesn''t exist in any of the charts in the dashboard, the system doesn''t display any data in the charts.' required: type: boolean default: false example: true description: 'Flag that controls the display of chart data. If true, users must use this filter in order to see data; otherwise, users can delete the filter.' restricted: type: boolean default: false example: true description: 'Flag that controls the values allowed in the filter. If true, the only allowable values are those specified in the ChartsWebUIFilter.preferredSuggestions array; otherwise, any value is allowed.' value: type: array items: type: string example: - London - Paris description: 'A list of values to compare to the value of the dimension or custom property specified in ChartsWebUIFilter.property. If the list contains more than one value, the filter becomes a set of queries between the value of property and each element of value. The system joins these queries with an implicit OR.' description: 'The specification for a filter that appears in the UI. The filter compares the value of a dimension or custom property to a value specified in this filter. You can specify the following in the filter: A default value A list of suggested values to display in the UI A flag that controls user input; if set to true, users are limited to the default and suggested values. You can also force users to choose this filter in order to see data in the charts of this dashboard.' description: 'List of UI-oriented filters that appear at the top of the dashboard, in the form of a JSON array of JSON objects. For each filter you can specify a name and a label for the dimension or custom property to filter against, a list of suggested comparison values to display in the UI, and other properties that control the UI display. To see a more detailed description of the options, see the property descriptions for the ChartsWebUIFilter model.' description: 'Specifies the properties of filters to apply to the dashboard. Filters give you fine-grained control over the data displayed in the charts in the dashboard. You can specify ad hoc filters or save them as variables for repeated use of the filter criteria. You can also use filters to apply a custom time window to all of the charts in the dashboard.' groupId: type: string example: YYXXYY title: DashboardGroupId description: 'ID of an existing dashboard group to associate with this dashboard. If you don''t specify a value, the system creates a new dashboard group and assigns its ID to this property during the create process.' maxDelayOverride: type: integer format: int32 example: 1000 title: DashboardMaxDelayOverride description: 'Milliseconds to wait for late-arriving data points before rejecting them for inclusion in the charts in this dashboard. This value overrides but doesn''t change the max delay setting for individual charts in the dashboard. If you omit this property, the system uses individual chart settings. For individual charts, you can force the system to calculate a sensible value by removing the maxDelayOverride property of the chart. To force the system to do this for all charts in a dashboard, set CreateDashboardBody.maxDelayOverride to 0.' name: type: string example: Latency title: DashboardName description: 'A human-readable label for the dashboard. The UI displays this label in the dashboard group for the dashboard' selectedEventOverlays: type: array items: title: Event overlay for charts in a dashboard type: object required: - eventSignal properties: eventSignal: title: A search term that selects charts to overlay type: object required: - eventSearchText properties: eventSearchText: type: string example: ValueExceeded description: 'The event name or partial name that the system uses to select events to suggest as overlays on the charts in the dashboard' eventType: type: string enum: - detectorEvents - eventTimeSeries example: detectorEvents description: 'Controls the source of the event. You can specify the following: detectorEvents: Select events that come from a detector eventTimeSeries: Select events that come from a time series The API doesn''t accept other event types.' description: 'A filter that selects charts to overlay with events, based on event names and types' overlayId: type: string example: E5 description: 'Unique ID for this event overlay. Use this ID with any element of the selectedEventOverlays property to apply this overlay to a dashboard. Note: The system generates this value if you don''t specify one.' sources: type: array items: properties: NOT: type: boolean default: false example: false description: 'Controls the action of the filter. If set to true, then the system only selects events that don''t match the filter.' property: type: string example: datacenter description: 'The custom property or dimension name that provides the value to test in the filter. If the name you specify isn''t defined in one or more of the events associated with the dashboard, the filter never matches anything. If the NOT property for this filter is set to true and the filter never matches, all event overlays are suppressed.' value: type: array items: type: string example: - Paris - London description: 'An array of values to test against the specified property. If any of the values match, the system includes the event. Note: You must specify at least one element.' title: DashboardEventSources description: 'List of filters to apply to events for this event overlay, in the form of a JSON array.' description: 'Settings for an event overlay applied to each chart in a dashboard. You specify the event overlays for a dashboard with two different properties: CreateDashboardBody.EventOverlays: Inactive event overlays that you want to define for use at a later time. CreateDashboardBody.selectedEventOverlays: Active event overlays that you want to apply immediately to charts in the dashboard.' title: DashboardSelectedEventOverlays description: 'List of event overlays that are currently active for the charts in this dashboard, in the form of a JSON array of JSON objects. For each overlay, the system displays the active events that match the overlay search term and optional feature, using the color and event line settings for the overlay. To set options for inactive overlays so you can apply them at a later time, use the eventOverlays property instead.' permissions: title: Permission configuration for the dashboard type: object properties: acl: type: array items: title: An access control layer type: object properties: actions: type: array items: type: string enum: - READ - WRITE description: Action the user, team, or organization can take with the dashboard. principalType: type: string enum: - USER - TEAM - ORG description: Clarify whether this permission configuration is for a user, a team, or an organization. principalId: type: string description: ID of the user, team, or organization for which you're granting permissions. description: A permission configuration for a user, team, or organization. description: 'List of permission configurations. Use this list to specify read and write permissions for your dashboard. The parent property is set to null by default if you do this. Use the parent property instead if you want your dashboard to inherit permissions from an existing dashboard group.' parent: type: string description: 'ID of the dashboard group you want your dashboard to inherit permissions from. Use this property to configure your dashboard to inherit permissions from an existing dashboard group. Use the acl property instead if you want to specify various read and write permission configurations.' description: Read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard. examples: example: value: authorizedWriters: teams: - ZZZZ4 - Z2X users: - YXXX - XYYY chartDensity: DEFAULT charts: - chartId: XY1XX5 column: 5 height: 2 row: 10 width: 7 description: Latency measurements eventOverlays: - eventColorIndex: 5 eventLine: true eventSignal: eventSearchText: ValueExceeded eventType: detectorEvents sources: - NOT: false property: datacenter value: - Paris - London filters: sources: - NOT: false property: host value: - host5 - host6 time: end: 1647943200000 start: 1647936000000 variables: - alias: Europe preferredSuggestions: - Europe - Asia property: datacenter required: true restricted: true value: - London - Paris groupId: YYXXYY maxDelayOverride: 1000 name: Latency permissions: acl: - actions: - READ principalId: string principalType: USER parent: string selectedEventOverlays: - eventSignal: eventSearchText: ValueExceeded eventType: detectorEvents overlayId: E5 sources: - NOT: false property: datacenter value: - Paris - London responses: '200': description: HTTP 200 response content: application/json: schema: type: object properties: authorizedWriters: title: Users and teams with that can modify this dashboard type: object properties: teams: type: array items: type: string example: - ZZZZ4 - Z2X description: 'List of team IDs that have write access to this dashboard, in the form of a JSON array of strings' users: type: array items: type: string example: - YXXX - XYYY description: 'List of user IDs that have write access to this dashboard, in the form of a JSON array of strings' description: 'If the write permissions feature is available for your organization, you can use these properties to specify the user and team IDs that have write access to the chart of dashboard.' chartDensity: type: string default: DEFAULT enum: - DEFAULT - LOW - HIGH - HIGHEST example: DEFAULT title: DashboardChartDensity description: 'Controls the number of data points displayed in the charts for this dashboard, over the time span specified for the charts: DEFAULT maps to approximately 60 data points LOW maps to approximately 30 data points HIGH maps to approximately 120 data points HIGHEST maps to approximately 240 data points' charts: type: array items: title: Dashboard settings for a chart in a dashboard type: object required: - chartId - column - row - height - width properties: chartId: type: string example: XY1XX5 description: 'ID of an existing chart. Because charts can only belong to one dashboard, you can''t associate this ID with any other dashboard.' column: type: integer minimum: 0 maximum: 11 example: 5 description: '0-based index of the horizontal position of the chart in the dashboard display. The position represents the left-most edge of the chart. If you specify the same column and row value for more than one chart, the system tries to reconfigure the layout. If there''s space, the dashboard retains the column value and spreads out over additional rows. Note: The API doesn''t validate the maximum value. However, if you specify a value greater than 11, the chart displays in the UI as if 11 was specified. If that column is already occupied in the specified row, the system displays the chart in the first free row from the top in the specified column.' height: type: integer minimum: 1 maximum: 3 example: 2 description: 'Number of rows this chart should span. Note: The API doesn''t validate the maximum value. However, if you specify a value greater than 3, the chart displays in the UI as if 3 was specified. If the total height of all specified charts in a column is greater than 100, the system recalculates the layout to fit all the specified charts into the display of the dashboard.' row: type: integer minimum: 0 maximum: 99 example: 10 description: '0-based index of the vertical position of the chart in the dashboard display. The position The value represents the top-most edge of the chart. the system moves charts upwards as needed to fill vertical gaps. If you specify the same column and row value for more than one chart, the system tries to reconfigure the layout. If there''s space, the dashboard retains the column value and spreads out over additional rows. The API doesn''t validate the maximum value. However, if you specify a value greater than 99, the chart displays as if 0 were specified. If that row is already occupied, the system displays the first free row from the top of the specified column.' width: type: integer minimum: 1 maximum: 12 example: 7 description: 'Number of columns this chart should span. The API doesn''t validate the maximum value. However, if you use a value greater than 12, the chart displays as if you specified 12. If the total width of all specified charts in a row is greater than 100, the system recalculates the layout so that all the specified charts fit into the display.' description: 'Dashboard settings for the chart specified in chartId. These settings control how the chart appears in the dashboard.' title: DashboardChartSettings description: 'List of IDs for the charts you want to include in the dashboard, and for each chart the dashboard settings to use, in the form of a JSON array of JSON objects. The dashboard settings for charts control how Splunk Observability Cloud arranges charts in a dashboard when the charts appear in the UI.' created: type: integer format: int64 example: 1641024000000 title: DashboardCreated description: 'The dashboard creation timestamp, in *nix time in milliseconds The system sets this value, and you can''t modify it.' creator: type: string example: XXYYX title: DashboardCreator description: 'ID of the user that created the dashboard. If Splunk Observability Cloud created this dashboard, the value is AAAAAAAAAA. The system sets this value, and you can''t modify it.' customProperties: type: string title: DashboardCustomProperties description: not used description: type: string example: Latency measurements title: DashboardDescription description: 'Description of the dashboard. The system displays the value in the dashboard tab tooltip in the dashboard group in the UI.' discoveryOptions: type: object title: DashboardDiscoveryOptions description: Reserved for system use eventOverlays: type: array items: title: Filter to apply to event overlays type: object required: - property - value properties: eventSignal: title: A search term that selects charts to overlay type: object required: - eventSearchText properties: eventSearchText: type: string example: ValueExceeded description: 'The event name or partial name that the system uses to select events to suggest as overlays on the charts in the dashboard' eventType: type: string enum: - detectorEvents - eventTimeSeries example: detectorEvents description: 'Controls the source of the event. You can specify the following: detectorEvents: Select events that come from a detector eventTimeSeries: Select events that come from a time series The API doesn''t accept other event types.' description: 'A filter that selects charts to overlay with events, based on event names and types' eventColorIndex: type: integer minimum: 0 maximum: 15 example: 5 description: 'Color to use for events, in the form of an integer index into the color table displayed in table 5 Color palette in the section Chart color palettes. Only the first 16 entries (0-15) are allowed for this value. Users may see colors other than those shown in the table, depending on the settings they select for color blindness. To see sample swatches of the alternate colors and the mappings used for color-blind users, see the hexadecimal color codes for the first 16 entries in table 6, Color vision deficiency alternatives in the section Chart color palettes.' eventLine: type: boolean default: false example: true description: 'Controls the display of vertical event lines in the charts that belong to the dashboard. If true, the system displays event lines; otherwise, no event lines appear.' sources: type: array items: properties: NOT: type: boolean default: false example: false description: 'Controls the action of the filter. If set to true, then the system only selects events that don''t match the filter.' property: type: string example: datacenter description: 'The custom property or dimension name that provides the value to test in the filter. If the name you specify isn''t defined in one or more of the events associated with the dashboard, the filter never matches anything. If the NOT property for this filter is set to true and the filter never matches, all event overlays are suppressed.' value: type: array items: type: string example: - Paris - London description: 'An array of values to test against the specified property. If any of the values match, the system includes the event. Note: You must specify at least one element.' title: DashboardEventSources description: 'List of filters to apply to events for this event overlay, in the form of a JSON array.' description: 'Filters to apply to event overlays, in the form of a JSON object containing comparison expression properties. Each term in the expression tries to match the values of a dimension or custom property to criteria you specify. Based on the match results, you can include or exclude an event.' title: DashboardEventOverlays description: 'List of event overlay definitions that you can apply to all of the charts of this dashboard, in the form of a JSON array of JSON objects. When you apply the overlays, the system displays all the active events that match the specified search term and any specified filter on all the charts in the dashboard. The display uses the color you specify for the overlay and, if selected, vertical lines that mark the event. Note: The objects in this array correspond to the suggested event overlays specified in the UI, and they''re not automatically applied as active overlays. To set default active event overlays, use the selectedEventOverlays property instead.' filters: title: Filters to apply to all the charts of a dashboard type: object properties: sources: type: array items: title: Filter to apply to charts in a dashboard type: object required: - property - value properties: NOT: type: boolean default: false example: false description: 'Flag that indicates how the filter should operate. If true, data that matches the criteria is excluded from charts; otherwise, data that matches the criteria is included.' property: type: string example: host description: 'Name of the dimension or custom property to match to the data. Note: If the dimension or custom property doesn''t exist in any of the charts for the dashboard, and ChartsFilter.NOT is true, the system doesn''t display any data in the charts.' value: type: array items: type: string example: - host5 - host6 description: 'A list of values to compare to the value of the dimension or custom property specified in ChartsFilter.property. If the list contains more than one value, the filter becomes a set of queries between the value of property and each element of value. The system joins these queries with an implicit OR.' description: 'A single filter to apply to the charts in the dashboard. The filter specifies a default or user-defined dimension or custom property. You can either include or exclude all the data that matches the dimension or custom property.' description: 'List of filters to apply to the charts in the dashboard, in the form of a JSON array. Each element is a single filter for a default or user-defined dimension or custom property.' time: type: object properties: end: type: string example: 1647943200000 description: 'The end of the time range to show for all charts in the dashboard. If you don''t specify a value for this property, the system defaults to the value of the end property for each chart. Note: The specified type for end is string, but the system also accepts a 64-bit signed integer >= 0 that represents a time in *nix time in milliseconds.' start: type: string example: 1647936000000 description: 'The start of the time range to show for all charts in the dashboard. If you don''t specify a value for this property, the system defaults to the value of the start property for each chart. Note: The specified type for start is string, but the system also accepts a 64-bit signed integer >= 0 that represents a time in *nix time in milliseconds.' description: 'Time range to show in all of the charts in the dashboard, in the form of a JSON object. The specifications in this object override those in each individual chart. If you don''t specify values, the system defaults to using the individual time setting for each chart.' variables: type: array items: title: Filter that appears in the UI type: object required: - property - value properties: alias: type: string example: Europe description: 'A label for the filter. The system displays this label in the area preceding the input textarea for the filter in the UI. Note: A good way to indicate that the string is a label is to append a space and a colon (":") to it.' preferredSuggestions: type: array items: type: string example: - Europe - Asia description: 'List of strings containing values to place at the top of the Suggested Values dropdown in UI for the dashboard, in the form of a JSON array. If ChartsWebUIFilter.restricted is true, the filter must use one of the values in this array; users only have a choice of selecting a value from this array.' property: type: string example: datacenter description: 'Name of a custom property or dimension to filter against. Note: If the dimension or custom property doesn''t exist in any of the charts in the dashboard, the system doesn''t display any data in the charts.' required: type: boolean default: false example: true description: 'Flag that controls the display of chart data. If true, users must use this filter in order to see data; otherwise, users can delete the filter.' restricted: type: boolean default: false example: true description: 'Flag that controls the values allowed in the filter. If true, the only allowable values are those specified in the ChartsWebUIFilter.preferredSuggestions array; otherwise, any value is allowed.' value: type: array items: type: string example: - London - Paris description: 'A list of values to compare to the value of the dimension or custom property specified in ChartsWebUIFilter.property. If the list contains more than one value, the filter becomes a set of queries between the value of property and each element of value. The system joins these queries with an implicit OR.' description: 'The specification for a filter that appears in the UI. The filter compares the value of a dimension or custom property to a value specified in this filter. You can specify the following in the filter: A default value A list of suggested values to display in the UI A flag that controls user input; if set to true, users are limited to the default and suggested values. You can also force users to choose this filter in order to see data in the charts of this dashboard.' description: 'List of UI-oriented filters that appear at the top of the dashboard, in the form of a JSON array of JSON objects. For each filter you can specify a name and a label for the dimension or custom property to filter against, a list of suggested comparison values to display in the UI, and other properties that control the UI display. To see a more detailed description of the options, see the property descriptions for the ChartsWebUIFilter model.' description: 'Specifies the properties of filters to apply to the dashboard. Filters give you fine-grained control over the data displayed in the charts in the dashboard. You can specify ad hoc filters or save them as variables for repeated use of the filter criteria. You can also use filters to apply a custom time window to all of the charts in the dashboard.' groupId: type: string example: YYXXYY title: DashboardGroupId description: 'ID of an existing dashboard group to associate with this dashboard. If you don''t specify a value, the system creates a new dashboard group and assigns its ID to this property during the create process.' id: type: string example: ZZZXXXX title: DashboardId description: 'The ID of the dashboard. This value is read-only for a create request. Splunk Observability Cloud assigns it and returns it to you in the response.' lastUpdated: type: integer format: int64 example: 1647990000000 title: DashboardLastUpdated description: 'The last time the dashboard was updated, in *nix time in milliseconds. The system sets this value, and you can''t modify it.' lastUpdatedBy: type: string example: XXXX888 title: DashboardLastUpdatedBy description: 'ID of the last user who updated the dashboard. If the last update was by Splunk Observability Cloud, the value is AAAAAAAAAA. This value is read-only.' maxDelayOverride: type: integer format: int32 example: 1000 title: DashboardMaxDelayOverride description: 'Milliseconds to wait for late-arriving data points before rejecting them for inclusion in the charts in this dashboard. This value overrides but doesn''t change the max delay setting for individual charts in the dashboard. If you omit this property, the system uses individual chart settings. For individual charts, you can force the system to calculate a sensible value by removing the maxDelayOverride property of the chart. To force the system to do this for all charts in a dashboard, set CreateDashboardBody.maxDelayOverride to 0.' name: type: string example: Latency title: DashboardName description: 'A human-readable label for the dashboard. The UI displays this label in the dashboard group for the dashboard' selectedEventOverlays: type: array items: title: Event overlay for charts in a dashboard type: object required: - eventSignal properties: eventSignal: title: A search term that selects charts to overlay type: object required: - eventSearchText properties: eventSearchText: type: string example: ValueExceeded description: 'The event name or partial name that the system uses to select events to suggest as overlays on the charts in the dashboard' eventType: type: string enum: - detectorEvents - eventTimeSeries example: detectorEvents description: 'Controls the source of the event. You can specify the following: detectorEvents: Select events that come from a detector eventTimeSeries: Select events that come from a time series The API doesn''t accept other event types.' description: 'A filter that selects charts to overlay with events, based on event names and types' overlayId: type: string example: E5 description: 'Unique ID for this event overlay. Use this ID with any element of the selectedEventOverlays property to apply this overlay to a dashboard. Note: The system generates this value if you don''t specify one.' sources: type: array items: properties: NOT: type: boolean default: false example: false description: 'Controls the action of the filter. If set to true, then the system only selects events that don''t match the filter.' property: type: string example: datacenter description: 'The custom property or dimension name that provides the value to test in the filter. If the name you specify isn''t defined in one or more of the events associated with the dashboard, the filter never matches anything. If the NOT property for this filter is set to true and the filter never matches, all event overlays are suppressed.' value: type: array items: type: string example: - Paris - London description: 'An array of values to test against the specified property. If any of the values match, the system includes the event. Note: You must specify at least one element.' title: DashboardEventSources description: 'List of filters to apply to events for this event overlay, in the form of a JSON array.' description: 'Settings for an event overlay applied to each chart in a dashboard. You specify the event overlays for a dashboard with two different properties: CreateDashboardBody.EventOverlays: Inactive event overlays that you want to define for use at a later time. CreateDashboardBody.selectedEventOverlays: Active event overlays that you want to apply immediately to charts in the dashboard.' title: DashboardSelectedEventOverlays description: 'List of event overlays that are currently active for the charts in this dashboard, in the form of a JSON array of JSON objects. For each overlay, the system displays the active events that match the overlay search term and optional feature, using the color and event line settings for the overlay. To set options for inactive overlays so you can apply them at a later time, use the eventOverlays property instead.' tags: type: array items: type: string title: DashboardTags description: not used permissions: title: Permission configuration for the dashboard type: object properties: acl: type: array items: title: An access control layer type: object properties: actions: type: array items: type: string enum: - READ - WRITE description: Action the user, team, or organization can take with the dashboard. principalType: type: string enum: - USER - TEAM - ORG description: Clarify whether this permission configuration is for a user, a team, or an organization. principalId: type: string description: ID of the user, team, or organization for which you're granting permissions. description: A permission configuration for a user, team, or organization. description: 'List of permission configurations. Use this list to specify read and write permissions for your dashboard. The parent property is set to null by default if you do this. Use the parent property instead if you want your dashboard to inherit permissions from an existing dashboard group.' parent: type: string description: 'ID of the dashboard group you want your dashboard to inherit permissions from. Use this property to configure your dashboard to inherit permissions from an existing dashboard group. Use the acl property instead if you want to specify various read and write permission configurations.' description: Read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard. examples: example: value: authorizedWriters: teams: - ZZZZ4 - Z2X users: - YXXX - XYYY chartDensity: DEFAULT charts: - chartId: XY1XX5 column: 5 height: 2 row: 10 width: 7 created: 1641024000000 creator: XXYYX customProperties: string description: Latency measurements eventOverlays: - eventColorIndex: 5 eventLine: true eventSignal: eventSearchText: ValueExceeded eventType: detectorEvents sources: - NOT: false property: datacenter value: - Paris - London filters: sources: - NOT: false property: host value: - host5 - host6 time: end: 1647943200000 start: 1647936000000 variables: - alias: Europe preferredSuggestions: - Europe - Asia property: datacenter required: true restricted: true value: - London - Paris groupId: YYXXYY id: ZZZXXXX lastUpdated: 1647990000000 lastUpdatedBy: XXXX888 maxDelayOverride: 1000 name: Latency permissions: acl: - actions: - READ principalId: string principalType: USER parent: string selectedEventOverlays: - eventSignal: eventSearchText: ValueExceeded eventType: detectorEvents overlayId: E5 sources: - NOT: false property: datacenter value: - Paris - London tags: - string '400': description: HTTP 400 response content: application/json: schema: type: object properties: code: type: integer format: int32 description: HTTP response code. Always '400' message: type: string description: Error explanation examples: example: value: code: 0 message: string security: - SessionToken: [] tags: - Dashboards /dashboard/{id}: get: summary: Retrieve Single Dashboard Using ID description: 'Retrieves a dashboard specified by the dashboard ID in the {id} path parameter.' parameters: - name: id in: path description: ID of an existing dashboard required: true schema: type: string - name: Content-Type in: header description: Format of the request body. Always application/json. required: true schema: type: string - name: X-SF-TOKEN in: header description: Authentication token required: true schema: type: string responses: '200': description: HTTP 200 response content: application/json: schema: type: object properties: authorizedWriters: title: Users and teams with that can modify this dashboard type: object properties: teams: type: array items: type: string example: - ZZZZ4 - Z2X description: 'List of team IDs that have write access to this dashboard, in the form of a JSON array of strings' users: type: array items: type: string example: - YXXX - XYYY description: 'List of user IDs that have write access to this dashboard, in the form of a JSON array of strings' description: 'If the write permissions feature is available for your organization, you can use these properties to specify the user and team IDs that have write access to the chart of dashboard.' chartDensity: type: string default: DEFAULT enum: - DEFAULT - LOW - HIGH - HIGHEST example: DEFAULT title: DashboardChartDensity description: 'Controls the number of data points displayed in the charts for this dashboard, over the time span specified for the charts: DEFAULT maps to approximately 60 data points LOW maps to approximately 30 data points HIGH maps to approximately 120 data points HIGHEST maps to approximately 240 data points' charts: type: array items: title: Dashboard settings for a chart in a dashboard type: object required: - chartId - column - row - height - width properties: chartId: type: string example: XY1XX5 description: 'ID of an existing chart. Because charts can only belong to one dashboard, you can''t associate this ID with any other dashboard.' column: type: integer minimum: 0 maximum: 11 example: 5 description: '0-based index of the horizontal position of the chart in the dashboard display. The position represents the left-most edge of the chart. If you specify the same column and row value for more than one chart, the system tries to reconfigure the layout. If there''s space, the dashboard retains the column value and spreads out over additional rows. Note: The API doesn''t validate the maximum value. However, if you specify a value greater than 11, the chart displays in the UI as if 11 was specified. If that column is already occupied in the specified row, the system displays the chart in the first free row from the top in the specified column.' height: type: integer minimum: 1 maximum: 3 example: 2 description: 'Number of rows this chart should span. Note: The API doesn''t validate the maximum value. However, if you specify a value greater than 3, the chart displays in the UI as if 3 was specified. If the total height of all specified charts in a column is greater than 100, the system recalculates the layout to fit all the specified charts into the display of the dashboard.' row: type: integer minimum: 0 maximum: 99 example: 10 description: '0-based index of the vertical position of the chart in the dashboard display. The position The value represents the top-most edge of the chart. the system moves charts upwards as needed to fill vertical gaps. If you specify the same column and row value for more than one chart, the system tries to reconfigure the layout. If there''s space, the dashboard retains the column value and spreads out over additional rows. The API doesn''t validate the maximum value. However, if you specify a value greater than 99, the chart displays as if 0 were specified. If that row is already occupied, the system displays the first free row from the top of the specified column.' width: type: integer minimum: 1 maximum: 12 example: 7 description: 'Number of columns this chart should span. The API doesn''t validate the maximum value. However, if you use a value greater than 12, the chart displays as if you specified 12. If the total width of all specified charts in a row is greater than 100, the system recalculates the layout so that all the specified charts fit into the display.' description: 'Dashboard settings for the chart specified in chartId. These settings control how the chart appears in the dashboard.' title: DashboardChartSettings description: 'List of IDs for the charts you want to include in the dashboard, and for each chart the dashboard settings to use, in the form of a JSON array of JSON objects. The dashboard settings for charts control how Splunk Observability Cloud arranges charts in a dashboard when the charts appear in the UI.' created: type: integer format: int64 example: 1641024000000 title: DashboardCreated description: 'The dashboard creation timestamp, in *nix time in milliseconds The system sets this value, and you can''t modify it.' creator: type: string example: XXYYX title: DashboardCreator description: 'ID of the user that created the dashboard. If Splunk Observability Cloud created this dashboard, the value is AAAAAAAAAA. The system sets this value, and you can''t modify it.' customProperties: type: string title: DashboardCustomProperties description: not used description: type: string example: Latency measurements title: DashboardDescription description: 'Description of the dashboard. The system displays the value in the dashboard tab tooltip in the dashboard group in the UI.' discoveryOptions: type: object title: DashboardDiscoveryOptions description: Reserved for system use eventOverlays: type: array items: title: Filter to apply to event overlays type: object required: - property - value properties: eventSignal: title: A search term that selects charts to overlay type: object required: - eventSearchText properties: eventSearchText: type: string example: ValueExceeded description: 'The event name or partial name that the system uses to select events to suggest as overlays on the charts in the dashboard' eventType: type: string enum: - detectorEvents - eventTimeSeries example: detectorEvents description: 'Controls the source of the event. You can specify the following: detectorEvents: Select events that come from a detector eventTimeSeries: Select events that come from a time series The API doesn''t accept other event types.' description: 'A filter that selects charts to overlay with events, based on event names and types' eventColorIndex: type: integer minimum: 0 maximum: 15 example: 5 description: 'Color to use for events, in the form of an integer index into the color table displayed in table 5 Color palette in the section Chart color palettes. Only the first 16 entries (0-15) are allowed for this value. Users may see colors other than those shown in the table, depending on the settings they select for color blindness. To see sample swatches of the alternate colors and the mappings used for color-blind users, see the hexadecimal color codes for the first 16 entries in table 6, Color vision deficiency alternatives in the section Chart color palettes.' eventLine: type: boolean default: false example: true description: 'Controls the display of vertical event lines in the charts that belong to the dashboard. If true, the system displays event lines; otherwise, no event lines appear.' sources: type: array items: properties: NOT: type: boolean default: false example: false description: 'Controls the action of the filter. If set to true, then the system only selects events that don''t match the filter.' property: type: string example: datacenter description: 'The custom property or dimension name that provides the value to test in the filter. If the name you specify isn''t defined in one or more of the events associated with the dashboard, the filter never matches anything. If the NOT property for this filter is set to true and the filter never matches, all event overlays are suppressed.' value: type: array items: type: string example: - Paris - London description: 'An array of values to test against the specified property. If any of the values match, the system includes the event. Note: You must specify at least one element.' title: DashboardEventSources description: 'List of filters to apply to events for this event overlay, in the form of a JSON array.' description: 'Filters to apply to event overlays, in the form of a JSON object containing comparison expression properties. Each term in the expression tries to match the values of a dimension or custom property to criteria you specify. Based on the match results, you can include or exclude an event.' title: DashboardEventOverlays description: 'List of event overlay definitions that you can apply to all of the charts of this dashboard, in the form of a JSON array of JSON objects. When you apply the overlays, the system displays all the active events that match the specified search term and any specified filter on all the charts in the dashboard. The display uses the color you specify for the overlay and, if selected, vertical lines that mark the event. Note: The objects in this array correspond to the suggested event overlays specified in the UI, and they''re not automatically applied as active overlays. To set default active event overlays, use the selectedEventOverlays property instead.' filters: title: Filters to apply to all the charts of a dashboard type: object properties: sources: type: array items: title: Filter to apply to charts in a dashboard type: object required: - property - value properties: NOT: type: boolean default: false example: false description: 'Flag that indicates how the filter should operate. If true, data that matches the criteria is excluded from charts; otherwise, data that matches the criteria is included.' property: type: string example: host description: 'Name of the dimension or custom property to match to the data. Note: If the dimension or custom property doesn''t exist in any of the charts for the dashboard, and ChartsFilter.NOT is true, the system doesn''t display any data in the charts.' value: type: array items: type: string example: - host5 - host6 description: 'A list of values to compare to the value of the dimension or custom property specified in ChartsFilter.property. If the list contains more than one value, the filter becomes a set of queries between the value of property and each element of value. The system joins these queries with an implicit OR.' description: 'A single filter to apply to the charts in the dashboard. The filter specifies a default or user-defined dimension or custom property. You can either include or exclude all the data that matches the dimension or custom property.' description: 'List of filters to apply to the charts in the dashboard, in the form of a JSON array. Each element is a single filter for a default or user-defined dimension or custom property.' time: type: object properties: end: type: string example: 1647943200000 description: 'The end of the time range to show for all charts in the dashboard. If you don''t specify a value for this property, the system defaults to the value of the end property for each chart. Note: The specified type for end is string, but the system also accepts a 64-bit signed integer >= 0 that represents a time in *nix time in milliseconds.' start: type: string example: 1647936000000 description: 'The start of the time range to show for all charts in the dashboard. If you don''t specify a value for this property, the system defaults to the value of the start property for each chart. Note: The specified type for start is string, but the system also accepts a 64-bit signed integer >= 0 that represents a time in *nix time in milliseconds.' description: 'Time range to show in all of the charts in the dashboard, in the form of a JSON object. The specifications in this object override those in each individual chart. If you don''t specify values, the system defaults to using the individual time setting for each chart.' variables: type: array items: title: Filter that appears in the UI type: object required: - property - value properties: alias: type: string example: Europe description: 'A label for the filter. The system displays this label in the area preceding the input textarea for the filter in the UI. Note: A good way to indicate that the string is a label is to append a space and a colon (":") to it.' preferredSuggestions: type: array items: type: string example: - Europe - Asia description: 'List of strings containing values to place at the top of the Suggested Values dropdown in UI for the dashboard, in the form of a JSON array. If ChartsWebUIFilter.restricted is true, the filter must use one of the values in this array; users only have a choice of selecting a value from this array.' property: type: string example: datacenter description: 'Name of a custom property or dimension to filter against. Note: If the dimension or custom property doesn''t exist in any of the charts in the dashboard, the system doesn''t display any data in the charts.' required: type: boolean default: false example: true description: 'Flag that controls the display of chart data. If true, users must use this filter in order to see data; otherwise, users can delete the filter.' restricted: type: boolean default: false example: true description: 'Flag that controls the values allowed in the filter. If true, the only allowable values are those specified in the ChartsWebUIFilter.preferredSuggestions array; otherwise, any value is allowed.' value: type: array items: type: string example: - London - Paris description: 'A list of values to compare to the value of the dimension or custom property specified in ChartsWebUIFilter.property. If the list contains more than one value, the filter becomes a set of queries between the value of property and each element of value. The system joins these queries with an implicit OR.' description: 'The specification for a filter that appears in the UI. The filter compares the value of a dimension or custom property to a value specified in this filter. You can specify the following in the filter: A default value A list of suggested values to display in the UI A flag that controls user input; if set to true, users are limited to the default and suggested values. You can also force users to choose this filter in order to see data in the charts of this dashboard.' description: 'List of UI-oriented filters that appear at the top of the dashboard, in the form of a JSON array of JSON objects. For each filter you can specify a name and a label for the dimension or custom property to filter against, a list of suggested comparison values to display in the UI, and other properties that control the UI display. To see a more detailed description of the options, see the property descriptions for the ChartsWebUIFilter model.' description: 'Specifies the properties of filters to apply to the dashboard. Filters give you fine-grained control over the data displayed in the charts in the dashboard. You can specify ad hoc filters or save them as variables for repeated use of the filter criteria. You can also use filters to apply a custom time window to all of the charts in the dashboard.' groupId: type: string example: YYXXYY title: DashboardGroupId description: 'ID of an existing dashboard group to associate with this dashboard. If you don''t specify a value, the system creates a new dashboard group and assigns its ID to this property during the create process.' id: type: string example: ZZZXXXX title: DashboardId description: 'The ID of the dashboard. This value is read-only for a create request. Splunk Observability Cloud assigns it and returns it to you in the response.' lastUpdated: type: integer format: int64 example: 1647990000000 title: DashboardLastUpdated description: 'The last time the dashboard was updated, in *nix time in milliseconds. The system sets this value, and you can''t modify it.' lastUpdatedBy: type: string example: XXXX888 title: DashboardLastUpdatedBy description: 'ID of the last user who updated the dashboard. If the last update was by Splunk Observability Cloud, the value is AAAAAAAAAA. This value is read-only.' maxDelayOverride: type: integer format: int32 example: 1000 title: DashboardMaxDelayOverride description: 'Milliseconds to wait for late-arriving data points before rejecting them for inclusion in the charts in this dashboard. This value overrides but doesn''t change the max delay setting for individual charts in the dashboard. If you omit this property, the system uses individual chart settings. For individual charts, you can force the system to calculate a sensible value by removing the maxDelayOverride property of the chart. To force the system to do this for all charts in a dashboard, set CreateDashboardBody.maxDelayOverride to 0.' name: type: string example: Latency title: DashboardName description: 'A human-readable label for the dashboard. The UI displays this label in the dashboard group for the dashboard' selectedEventOverlays: type: array items: title: Event overlay for charts in a dashboard type: object required: - eventSignal properties: eventSignal: title: A search term that selects charts to overlay type: object required: - eventSearchText properties: eventSearchText: type: string example: ValueExceeded description: 'The event name or partial name that the system uses to select events to suggest as overlays on the charts in the dashboard' eventType: type: string enum: - detectorEvents - eventTimeSeries example: detectorEvents description: 'Controls the source of the event. You can specify the following: detectorEvents: Select events that come from a detector eventTimeSeries: Select events that come from a time series The API doesn''t accept other event types.' description: 'A filter that selects charts to overlay with events, based on event names and types' overlayId: type: string example: E5 description: 'Unique ID for this event overlay. Use this ID with any element of the selectedEventOverlays property to apply this overlay to a dashboard. Note: The system generates this value if you don''t specify one.' sources: type: array items: properties: NOT: type: boolean default: false example: false description: 'Controls the action of the filter. If set to true, then the system only selects events that don''t match the filter.' property: type: string example: datacenter description: 'The custom property or dimension name that provides the value to test in the filter. If the name you specify isn''t defined in one or more of the events associated with the dashboard, the filter never matches anything. If the NOT property for this filter is set to true and the filter never matches, all event overlays are suppressed.' value: type: array items: type: string example: - Paris - London description: 'An array of values to test against the specified property. If any of the values match, the system includes the event. Note: You must specify at least one element.' title: DashboardEventSources description: 'List of filters to apply to events for this event overlay, in the form of a JSON array.' description: 'Settings for an event overlay applied to each chart in a dashboard. You specify the event overlays for a dashboard with two different properties: CreateDashboardBody.EventOverlays: Inactive event overlays that you want to define for use at a later time. CreateDashboardBody.selectedEventOverlays: Active event overlays that you want to apply immediately to charts in the dashboard.' title: DashboardSelectedEventOverlays description: 'List of event overlays that are currently active for the charts in this dashboard, in the form of a JSON array of JSON objects. For each overlay, the system displays the active events that match the overlay search term and optional feature, using the color and event line settings for the overlay. To set options for inactive overlays so you can apply them at a later time, use the eventOverlays property instead.' tags: type: array items: type: string title: DashboardTags description: not used permissions: title: Permission configuration for the dashboard type: object properties: acl: type: array items: title: An access control layer type: object properties: actions: type: array items: type: string enum: - READ - WRITE description: Action the user, team, or organization can take with the dashboard. principalType: type: string enum: - USER - TEAM - ORG description: Clarify whether this permission configuration is for a user, a team, or an organization. principalId: type: string description: ID of the user, team, or organization for which you're granting permissions. description: A permission configuration for a user, team, or organization. description: 'List of permission configurations. Use this list to specify read and write permissions for your dashboard. The parent property is set to null by default if you do this. Use the parent property instead if you want your dashboard to inherit permissions from an existing dashboard group.' parent: type: string description: 'ID of the dashboard group you want your dashboard to inherit permissions from. Use this property to configure your dashboard to inherit permissions from an existing dashboard group. Use the acl property instead if you want to specify various read and write permission configurations.' description: Read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard. examples: example: value: authorizedWriters: teams: - ZZZZ4 - Z2X users: - YXXX - XYYY chartDensity: DEFAULT charts: - chartId: XY1XX5 column: 5 height: 2 row: 10 width: 7 created: 1641024000000 creator: XXYYX customProperties: string description: Latency measurements eventOverlays: - eventColorIndex: 5 eventLine: true eventSignal: eventSearchText: ValueExceeded eventType: detectorEvents sources: - NOT: false property: datacenter value: - Paris - London filters: sources: - NOT: false property: host value: - host5 - host6 time: end: 1647943200000 start: 1647936000000 variables: - alias: Europe preferredSuggestions: - Europe - Asia property: datacenter required: true restricted: true value: - London - Paris groupId: YYXXYY id: ZZZXXXX lastUpdated: 1647990000000 lastUpdatedBy: XXXX888 maxDelayOverride: 1000 name: Latency permissions: acl: - actions: - READ principalId: string principalType: USER parent: string selectedEventOverlays: - eventSignal: eventSearchText: ValueExceeded eventType: detectorEvents overlayId: E5 sources: - NOT: false property: datacenter value: - Paris - London tags: - string security: - SessionToken: [] tags: - Dashboards put: summary: Update Single Dashboard description: 'Updates the properties of the dashboard specified by the ID in the {id} path parameter' parameters: - name: id in: path description: ID of an existing dashboard required: true schema: type: string - name: Content-Type in: header description: Format of the request body. Always application/json. required: true schema: type: string - name: X-SF-TOKEN in: header description: 'Authentication token Note: If you''re updating the authorizedWriters property, and your user ID isn''t in authorizedWriters already, then you need to use a session token (User API access token) associated with an administrator.' required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: authorizedWriters: title: Users and teams with that can modify this dashboard type: object properties: teams: type: array items: type: string example: - ZZZZ4 - Z2X description: 'List of team IDs that have write access to this dashboard, in the form of a JSON array of strings' users: type: array items: type: string example: - YXXX - XYYY description: 'List of user IDs that have write access to this dashboard, in the form of a JSON array of strings' description: 'If the write permissions feature is available for your organization, you can use these properties to specify the user and team IDs that have write access to the chart of dashboard.' chartDensity: type: string default: DEFAULT enum: - DEFAULT - LOW - HIGH - HIGHEST example: DEFAULT title: DashboardChartDensity description: 'Controls the number of data points displayed in the charts for this dashboard, over the time span specified for the charts: DEFAULT maps to approximately 60 data points LOW maps to approximately 30 data points HIGH maps to approximately 120 data points HIGHEST maps to approximately 240 data points' charts: type: array items: title: Dashboard settings for a chart in a dashboard type: object required: - chartId - column - row - height - width properties: chartId: type: string example: XY1XX5 description: 'ID of an existing chart. Because charts can only belong to one dashboard, you can''t associate this ID with any other dashboard.' column: type: integer minimum: 0 maximum: 11 example: 5 description: '0-based index of the horizontal position of the chart in the dashboard display. The position represents the left-most edge of the chart. If you specify the same column and row value for more than one chart, the system tries to reconfigure the layout. If there''s space, the dashboard retains the column value and spreads out over additional rows. Note: The API doesn''t validate the maximum value. However, if you specify a value greater than 11, the chart displays in the UI as if 11 was specified. If that column is already occupied in the specified row, the system displays the chart in the first free row from the top in the specified column.' height: type: integer minimum: 1 maximum: 3 example: 2 description: 'Number of rows this chart should span. Note: The API doesn''t validate the maximum value. However, if you specify a value greater than 3, the chart displays in the UI as if 3 was specified. If the total height of all specified charts in a column is greater than 100, the system recalculates the layout to fit all the specified charts into the display of the dashboard.' row: type: integer minimum: 0 maximum: 99 example: 10 description: '0-based index of the vertical position of the chart in the dashboard display. The position The value represents the top-most edge of the chart. the system moves charts upwards as needed to fill vertical gaps. If you specify the same column and row value for more than one chart, the system tries to reconfigure the layout. If there''s space, the dashboard retains the column value and spreads out over additional rows. The API doesn''t validate the maximum value. However, if you specify a value greater than 99, the chart displays as if 0 were specified. If that row is already occupied, the system displays the first free row from the top of the specified column.' width: type: integer minimum: 1 maximum: 12 example: 7 description: 'Number of columns this chart should span. The API doesn''t validate the maximum value. However, if you use a value greater than 12, the chart displays as if you specified 12. If the total width of all specified charts in a row is greater than 100, the system recalculates the layout so that all the specified charts fit into the display.' description: 'Dashboard settings for the chart specified in chartId. These settings control how the chart appears in the dashboard.' title: DashboardChartSettings description: 'List of IDs for the charts you want to include in the dashboard, and for each chart the dashboard settings to use, in the form of a JSON array of JSON objects. The dashboard settings for charts control how Splunk Observability Cloud arranges charts in a dashboard when the charts appear in the UI.' customProperties: type: string title: DashboardCustomProperties description: not used description: type: string example: Latency measurements title: DashboardDescription description: 'Description of the dashboard. The system displays the value in the dashboard tab tooltip in the dashboard group in the UI.' eventOverlays: type: array items: title: Filter to apply to event overlays type: object required: - property - value properties: eventSignal: title: A search term that selects charts to overlay type: object required: - eventSearchText properties: eventSearchText: type: string example: ValueExceeded description: 'The event name or partial name that the system uses to select events to suggest as overlays on the charts in the dashboard' eventType: type: string enum: - detectorEvents - eventTimeSeries example: detectorEvents description: 'Controls the source of the event. You can specify the following: detectorEvents: Select events that come from a detector eventTimeSeries: Select events that come from a time series The API doesn''t accept other event types.' description: 'A filter that selects charts to overlay with events, based on event names and types' eventColorIndex: type: integer minimum: 0 maximum: 15 example: 5 description: 'Color to use for events, in the form of an integer index into the color table displayed in table 5 Color palette in the section Chart color palettes. Only the first 16 entries (0-15) are allowed for this value. Users may see colors other than those shown in the table, depending on the settings they select for color blindness. To see sample swatches of the alternate colors and the mappings used for color-blind users, see the hexadecimal color codes for the first 16 entries in table 6, Color vision deficiency alternatives in the section Chart color palettes.' eventLine: type: boolean default: false example: true description: 'Controls the display of vertical event lines in the charts that belong to the dashboard. If true, the system displays event lines; otherwise, no event lines appear.' sources: type: array items: properties: NOT: type: boolean default: false example: false description: 'Controls the action of the filter. If set to true, then the system only selects events that don''t match the filter.' property: type: string example: datacenter description: 'The custom property or dimension name that provides the value to test in the filter. If the name you specify isn''t defined in one or more of the events associated with the dashboard, the filter never matches anything. If the NOT property for this filter is set to true and the filter never matches, all event overlays are suppressed.' value: type: array items: type: string example: - Paris - London description: 'An array of values to test against the specified property. If any of the values match, the system includes the event. Note: You must specify at least one element.' title: DashboardEventSources description: 'List of filters to apply to events for this event overlay, in the form of a JSON array.' description: 'Filters to apply to event overlays, in the form of a JSON object containing comparison expression properties. Each term in the expression tries to match the values of a dimension or custom property to criteria you specify. Based on the match results, you can include or exclude an event.' title: DashboardEventOverlays description: 'List of event overlay definitions that you can apply to all of the charts of this dashboard, in the form of a JSON array of JSON objects. When you apply the overlays, the system displays all the active events that match the specified search term and any specified filter on all the charts in the dashboard. The display uses the color you specify for the overlay and, if selected, vertical lines that mark the event. Note: The objects in this array correspond to the suggested event overlays specified in the UI, and they''re not automatically applied as active overlays. To set default active event overlays, use the selectedEventOverlays property instead.' filters: title: Filters to apply to all the charts of a dashboard type: object properties: sources: type: array items: title: Filter to apply to charts in a dashboard type: object required: - property - value properties: NOT: type: boolean default: false example: false description: 'Flag that indicates how the filter should operate. If true, data that matches the criteria is excluded from charts; otherwise, data that matches the criteria is included.' property: type: string example: host description: 'Name of the dimension or custom property to match to the data. Note: If the dimension or custom property doesn''t exist in any of the charts for the dashboard, and ChartsFilter.NOT is true, the system doesn''t display any data in the charts.' value: type: array items: type: string example: - host5 - host6 description: 'A list of values to compare to the value of the dimension or custom property specified in ChartsFilter.property. If the list contains more than one value, the filter becomes a set of queries between the value of property and each element of value. The system joins these queries with an implicit OR.' description: 'A single filter to apply to the charts in the dashboard. The filter specifies a default or user-defined dimension or custom property. You can either include or exclude all the data that matches the dimension or custom property.' description: 'List of filters to apply to the charts in the dashboard, in the form of a JSON array. Each element is a single filter for a default or user-defined dimension or custom property.' time: type: object properties: end: type: string example: 1647943200000 description: 'The end of the time range to show for all charts in the dashboard. If you don''t specify a value for this property, the system defaults to the value of the end property for each chart. Note: The specified type for end is string, but the system also accepts a 64-bit signed integer >= 0 that represents a time in *nix time in milliseconds.' start: type: string example: 1647936000000 description: 'The start of the time range to show for all charts in the dashboard. If you don''t specify a value for this property, the system defaults to the value of the start property for each chart. Note: The specified type for start is string, but the system also accepts a 64-bit signed integer >= 0 that represents a time in *nix time in milliseconds.' description: 'Time range to show in all of the charts in the dashboard, in the form of a JSON object. The specifications in this object override those in each individual chart. If you don''t specify values, the system defaults to using the individual time setting for each chart.' variables: type: array items: title: Filter that appears in the UI type: object required: - property - value properties: alias: type: string example: Europe description: 'A label for the filter. The system displays this label in the area preceding the input textarea for the filter in the UI. Note: A good way to indicate that the string is a label is to append a space and a colon (":") to it.' preferredSuggestions: type: array items: type: string example: - Europe - Asia description: 'List of strings containing values to place at the top of the Suggested Values dropdown in UI for the dashboard, in the form of a JSON array. If ChartsWebUIFilter.restricted is true, the filter must use one of the values in this array; users only have a choice of selecting a value from this array.' property: type: string example: datacenter description: 'Name of a custom property or dimension to filter against. Note: If the dimension or custom property doesn''t exist in any of the charts in the dashboard, the system doesn''t display any data in the charts.' required: type: boolean default: false example: true description: 'Flag that controls the display of chart data. If true, users must use this filter in order to see data; otherwise, users can delete the filter.' restricted: type: boolean default: false example: true description: 'Flag that controls the values allowed in the filter. If true, the only allowable values are those specified in the ChartsWebUIFilter.preferredSuggestions array; otherwise, any value is allowed.' value: type: array items: type: string example: - London - Paris description: 'A list of values to compare to the value of the dimension or custom property specified in ChartsWebUIFilter.property. If the list contains more than one value, the filter becomes a set of queries between the value of property and each element of value. The system joins these queries with an implicit OR.' description: 'The specification for a filter that appears in the UI. The filter compares the value of a dimension or custom property to a value specified in this filter. You can specify the following in the filter: A default value A list of suggested values to display in the UI A flag that controls user input; if set to true, users are limited to the default and suggested values. You can also force users to choose this filter in order to see data in the charts of this dashboard.' description: 'List of UI-oriented filters that appear at the top of the dashboard, in the form of a JSON array of JSON objects. For each filter you can specify a name and a label for the dimension or custom property to filter against, a list of suggested comparison values to display in the UI, and other properties that control the UI display. To see a more detailed description of the options, see the property descriptions for the ChartsWebUIFilter model.' description: 'Specifies the properties of filters to apply to the dashboard. Filters give you fine-grained control over the data displayed in the charts in the dashboard. You can specify ad hoc filters or save them as variables for repeated use of the filter criteria. You can also use filters to apply a custom time window to all of the charts in the dashboard.' groupId: type: string example: YYXXYY title: DashboardGroupId description: 'ID of an existing dashboard group to associate with this dashboard. If you don''t specify a value, the system creates a new dashboard group and assigns its ID to this property during the create process.' maxDelayOverride: type: integer format: int32 example: 1000 title: DashboardMaxDelayOverride description: 'Milliseconds to wait for late-arriving data points before rejecting them for inclusion in the charts in this dashboard. This value overrides but doesn''t change the max delay setting for individual charts in the dashboard. If you omit this property, the system uses individual chart settings. For individual charts, you can force the system to calculate a sensible value by removing the maxDelayOverride property of the chart. To force the system to do this for all charts in a dashboard, set CreateDashboardBody.maxDelayOverride to 0.' name: type: string example: Latency title: DashboardName description: 'A human-readable label for the dashboard. The UI displays this label in the dashboard group for the dashboard' selectedEventOverlays: type: array items: title: Event overlay for charts in a dashboard type: object required: - eventSignal properties: eventSignal: title: A search term that selects charts to overlay type: object required: - eventSearchText properties: eventSearchText: type: string example: ValueExceeded description: 'The event name or partial name that the system uses to select events to suggest as overlays on the charts in the dashboard' eventType: type: string enum: - detectorEvents - eventTimeSeries example: detectorEvents description: 'Controls the source of the event. You can specify the following: detectorEvents: Select events that come from a detector eventTimeSeries: Select events that come from a time series The API doesn''t accept other event types.' description: 'A filter that selects charts to overlay with events, based on event names and types' overlayId: type: string example: E5 description: 'Unique ID for this event overlay. Use this ID with any element of the selectedEventOverlays property to apply this overlay to a dashboard. Note: The system generates this value if you don''t specify one.' sources: type: array items: properties: NOT: type: boolean default: false example: false description: 'Controls the action of the filter. If set to true, then the system only selects events that don''t match the filter.' property: type: string example: datacenter description: 'The custom property or dimension name that provides the value to test in the filter. If the name you specify isn''t defined in one or more of the events associated with the dashboard, the filter never matches anything. If the NOT property for this filter is set to true and the filter never matches, all event overlays are suppressed.' value: type: array items: type: string example: - Paris - London description: 'An array of values to test against the specified property. If any of the values match, the system includes the event. Note: You must specify at least one element.' title: DashboardEventSources description: 'List of filters to apply to events for this event overlay, in the form of a JSON array.' description: 'Settings for an event overlay applied to each chart in a dashboard. You specify the event overlays for a dashboard with two different properties: CreateDashboardBody.EventOverlays: Inactive event overlays that you want to define for use at a later time. CreateDashboardBody.selectedEventOverlays: Active event overlays that you want to apply immediately to charts in the dashboard.' title: DashboardSelectedEventOverlays description: 'List of event overlays that are currently active for the charts in this dashboard, in the form of a JSON array of JSON objects. For each overlay, the system displays the active events that match the overlay search term and optional feature, using the color and event line settings for the overlay. To set options for inactive overlays so you can apply them at a later time, use the eventOverlays property instead.' permissions: title: Permission configuration for the dashboard type: object properties: acl: type: array items: title: An access control layer type: object properties: actions: type: array items: type: string enum: - READ - WRITE description: Action the user, team, or organization can take with the dashboard. principalType: type: string enum: - USER - TEAM - ORG description: Clarify whether this permission configuration is for a user, a team, or an organization. principalId: type: string description: ID of the user, team, or organization for which you're granting permissions. description: A permission configuration for a user, team, or organization. description: 'List of permission configurations. Use this list to specify read and write permissions for your dashboard. The parent property is set to null by default if you do this. Use the parent property instead if you want your dashboard to inherit permissions from an existing dashboard group.' parent: type: string description: 'ID of the dashboard group you want your dashboard to inherit permissions from. Use this property to configure your dashboard to inherit permissions from an existing dashboard group. Use the acl property instead if you want to specify various read and write permission configurations.' description: Read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard. examples: example: value: authorizedWriters: teams: - ZZZZ4 - Z2X users: - YXXX - XYYY chartDensity: DEFAULT charts: - chartId: XY1XX5 column: 5 height: 2 row: 10 width: 7 customProperties: string description: Latency measurements eventOverlays: - eventColorIndex: 5 eventLine: true eventSignal: eventSearchText: ValueExceeded eventType: detectorEvents sources: - NOT: false property: datacenter value: - Paris - London filters: sources: - NOT: false property: host value: - host5 - host6 time: end: 1647943200000 start: 1647936000000 variables: - alias: Europe preferredSuggestions: - Europe - Asia property: datacenter required: true restricted: true value: - London - Paris groupId: YYXXYY maxDelayOverride: 1000 name: Latency permissions: acl: - actions: - READ principalId: string principalType: USER parent: string selectedEventOverlays: - eventSignal: eventSearchText: ValueExceeded eventType: detectorEvents overlayId: E5 sources: - NOT: false property: datacenter value: - Paris - London responses: '200': description: HTTP 200 response content: application/json: schema: type: object properties: authorizedWriters: title: Users and teams with that can modify this dashboard type: object properties: teams: type: array items: type: string example: - ZZZZ4 - Z2X description: 'List of team IDs that have write access to this dashboard, in the form of a JSON array of strings' users: type: array items: type: string example: - YXXX - XYYY description: 'List of user IDs that have write access to this dashboard, in the form of a JSON array of strings' description: 'If the write permissions feature is available for your organization, you can use these properties to specify the user and team IDs that have write access to the chart of dashboard.' chartDensity: type: string default: DEFAULT enum: - DEFAULT - LOW - HIGH - HIGHEST example: DEFAULT title: DashboardChartDensity description: 'Controls the number of data points displayed in the charts for this dashboard, over the time span specified for the charts: DEFAULT maps to approximately 60 data points LOW maps to approximately 30 data points HIGH maps to approximately 120 data points HIGHEST maps to approximately 240 data points' charts: type: array items: title: Dashboard settings for a chart in a dashboard type: object required: - chartId - column - row - height - width properties: chartId: type: string example: XY1XX5 description: 'ID of an existing chart. Because charts can only belong to one dashboard, you can''t associate this ID with any other dashboard.' column: type: integer minimum: 0 maximum: 11 example: 5 description: '0-based index of the horizontal position of the chart in the dashboard display. The position represents the left-most edge of the chart. If you specify the same column and row value for more than one chart, the system tries to reconfigure the layout. If there''s space, the dashboard retains the column value and spreads out over additional rows. Note: The API doesn''t validate the maximum value. However, if you specify a value greater than 11, the chart displays in the UI as if 11 was specified. If that column is already occupied in the specified row, the system displays the chart in the first free row from the top in the specified column.' height: type: integer minimum: 1 maximum: 3 example: 2 description: 'Number of rows this chart should span. Note: The API doesn''t validate the maximum value. However, if you specify a value greater than 3, the chart displays in the UI as if 3 was specified. If the total height of all specified charts in a column is greater than 100, the system recalculates the layout to fit all the specified charts into the display of the dashboard.' row: type: integer minimum: 0 maximum: 99 example: 10 description: '0-based index of the vertical position of the chart in the dashboard display. The position The value represents the top-most edge of the chart. the system moves charts upwards as needed to fill vertical gaps. If you specify the same column and row value for more than one chart, the system tries to reconfigure the layout. If there''s space, the dashboard retains the column value and spreads out over additional rows. The API doesn''t validate the maximum value. However, if you specify a value greater than 99, the chart displays as if 0 were specified. If that row is already occupied, the system displays the first free row from the top of the specified column.' width: type: integer minimum: 1 maximum: 12 example: 7 description: 'Number of columns this chart should span. The API doesn''t validate the maximum value. However, if you use a value greater than 12, the chart displays as if you specified 12. If the total width of all specified charts in a row is greater than 100, the system recalculates the layout so that all the specified charts fit into the display.' description: 'Dashboard settings for the chart specified in chartId. These settings control how the chart appears in the dashboard.' title: DashboardChartSettings description: 'List of IDs for the charts you want to include in the dashboard, and for each chart the dashboard settings to use, in the form of a JSON array of JSON objects. The dashboard settings for charts control how Splunk Observability Cloud arranges charts in a dashboard when the charts appear in the UI.' created: type: integer format: int64 example: 1641024000000 title: DashboardCreated description: 'The dashboard creation timestamp, in *nix time in milliseconds The system sets this value, and you can''t modify it.' creator: type: string example: XXYYX title: DashboardCreator description: 'ID of the user that created the dashboard. If Splunk Observability Cloud created this dashboard, the value is AAAAAAAAAA. The system sets this value, and you can''t modify it.' customProperties: type: string title: DashboardCustomProperties description: not used description: type: string example: Latency measurements title: DashboardDescription description: 'Description of the dashboard. The system displays the value in the dashboard tab tooltip in the dashboard group in the UI.' discoveryOptions: type: object title: DashboardDiscoveryOptions description: Reserved for system use eventOverlays: type: array items: title: Filter to apply to event overlays type: object required: - property - value properties: eventSignal: title: A search term that selects charts to overlay type: object required: - eventSearchText properties: eventSearchText: type: string example: ValueExceeded description: 'The event name or partial name that the system uses to select events to suggest as overlays on the charts in the dashboard' eventType: type: string enum: - detectorEvents - eventTimeSeries example: detectorEvents description: 'Controls the source of the event. You can specify the following: detectorEvents: Select events that come from a detector eventTimeSeries: Select events that come from a time series The API doesn''t accept other event types.' description: 'A filter that selects charts to overlay with events, based on event names and types' eventColorIndex: type: integer minimum: 0 maximum: 15 example: 5 description: 'Color to use for events, in the form of an integer index into the color table displayed in table 5 Color palette in the section Chart color palettes. Only the first 16 entries (0-15) are allowed for this value. Users may see colors other than those shown in the table, depending on the settings they select for color blindness. To see sample swatches of the alternate colors and the mappings used for color-blind users, see the hexadecimal color codes for the first 16 entries in table 6, Color vision deficiency alternatives in the section Chart color palettes.' eventLine: type: boolean default: false example: true description: 'Controls the display of vertical event lines in the charts that belong to the dashboard. If true, the system displays event lines; otherwise, no event lines appear.' sources: type: array items: properties: NOT: type: boolean default: false example: false description: 'Controls the action of the filter. If set to true, then the system only selects events that don''t match the filter.' property: type: string example: datacenter description: 'The custom property or dimension name that provides the value to test in the filter. If the name you specify isn''t defined in one or more of the events associated with the dashboard, the filter never matches anything. If the NOT property for this filter is set to true and the filter never matches, all event overlays are suppressed.' value: type: array items: type: string example: - Paris - London description: 'An array of values to test against the specified property. If any of the values match, the system includes the event. Note: You must specify at least one element.' title: DashboardEventSources description: 'List of filters to apply to events for this event overlay, in the form of a JSON array.' description: 'Filters to apply to event overlays, in the form of a JSON object containing comparison expression properties. Each term in the expression tries to match the values of a dimension or custom property to criteria you specify. Based on the match results, you can include or exclude an event.' title: DashboardEventOverlays description: 'List of event overlay definitions that you can apply to all of the charts of this dashboard, in the form of a JSON array of JSON objects. When you apply the overlays, the system displays all the active events that match the specified search term and any specified filter on all the charts in the dashboard. The display uses the color you specify for the overlay and, if selected, vertical lines that mark the event. Note: The objects in this array correspond to the suggested event overlays specified in the UI, and they''re not automatically applied as active overlays. To set default active event overlays, use the selectedEventOverlays property instead.' filters: title: Filters to apply to all the charts of a dashboard type: object properties: sources: type: array items: title: Filter to apply to charts in a dashboard type: object required: - property - value properties: NOT: type: boolean default: false example: false description: 'Flag that indicates how the filter should operate. If true, data that matches the criteria is excluded from charts; otherwise, data that matches the criteria is included.' property: type: string example: host description: 'Name of the dimension or custom property to match to the data. Note: If the dimension or custom property doesn''t exist in any of the charts for the dashboard, and ChartsFilter.NOT is true, the system doesn''t display any data in the charts.' value: type: array items: type: string example: - host5 - host6 description: 'A list of values to compare to the value of the dimension or custom property specified in ChartsFilter.property. If the list contains more than one value, the filter becomes a set of queries between the value of property and each element of value. The system joins these queries with an implicit OR.' description: 'A single filter to apply to the charts in the dashboard. The filter specifies a default or user-defined dimension or custom property. You can either include or exclude all the data that matches the dimension or custom property.' description: 'List of filters to apply to the charts in the dashboard, in the form of a JSON array. Each element is a single filter for a default or user-defined dimension or custom property.' time: type: object properties: end: type: string example: 1647943200000 description: 'The end of the time range to show for all charts in the dashboard. If you don''t specify a value for this property, the system defaults to the value of the end property for each chart. Note: The specified type for end is string, but the system also accepts a 64-bit signed integer >= 0 that represents a time in *nix time in milliseconds.' start: type: string example: 1647936000000 description: 'The start of the time range to show for all charts in the dashboard. If you don''t specify a value for this property, the system defaults to the value of the start property for each chart. Note: The specified type for start is string, but the system also accepts a 64-bit signed integer >= 0 that represents a time in *nix time in milliseconds.' description: 'Time range to show in all of the charts in the dashboard, in the form of a JSON object. The specifications in this object override those in each individual chart. If you don''t specify values, the system defaults to using the individual time setting for each chart.' variables: type: array items: title: Filter that appears in the UI type: object required: - property - value properties: alias: type: string example: Europe description: 'A label for the filter. The system displays this label in the area preceding the input textarea for the filter in the UI. Note: A good way to indicate that the string is a label is to append a space and a colon (":") to it.' preferredSuggestions: type: array items: type: string example: - Europe - Asia description: 'List of strings containing values to place at the top of the Suggested Values dropdown in UI for the dashboard, in the form of a JSON array. If ChartsWebUIFilter.restricted is true, the filter must use one of the values in this array; users only have a choice of selecting a value from this array.' property: type: string example: datacenter description: 'Name of a custom property or dimension to filter against. Note: If the dimension or custom property doesn''t exist in any of the charts in the dashboard, the system doesn''t display any data in the charts.' required: type: boolean default: false example: true description: 'Flag that controls the display of chart data. If true, users must use this filter in order to see data; otherwise, users can delete the filter.' restricted: type: boolean default: false example: true description: 'Flag that controls the values allowed in the filter. If true, the only allowable values are those specified in the ChartsWebUIFilter.preferredSuggestions array; otherwise, any value is allowed.' value: type: array items: type: string example: - London - Paris description: 'A list of values to compare to the value of the dimension or custom property specified in ChartsWebUIFilter.property. If the list contains more than one value, the filter becomes a set of queries between the value of property and each element of value. The system joins these queries with an implicit OR.' description: 'The specification for a filter that appears in the UI. The filter compares the value of a dimension or custom property to a value specified in this filter. You can specify the following in the filter: A default value A list of suggested values to display in the UI A flag that controls user input; if set to true, users are limited to the default and suggested values. You can also force users to choose this filter in order to see data in the charts of this dashboard.' description: 'List of UI-oriented filters that appear at the top of the dashboard, in the form of a JSON array of JSON objects. For each filter you can specify a name and a label for the dimension or custom property to filter against, a list of suggested comparison values to display in the UI, and other properties that control the UI display. To see a more detailed description of the options, see the property descriptions for the ChartsWebUIFilter model.' description: 'Specifies the properties of filters to apply to the dashboard. Filters give you fine-grained control over the data displayed in the charts in the dashboard. You can specify ad hoc filters or save them as variables for repeated use of the filter criteria. You can also use filters to apply a custom time window to all of the charts in the dashboard.' groupId: type: string example: YYXXYY title: DashboardGroupId description: 'ID of an existing dashboard group to associate with this dashboard. If you don''t specify a value, the system creates a new dashboard group and assigns its ID to this property during the create process.' id: type: string example: ZZZXXXX title: DashboardId description: 'The ID of the dashboard. This value is read-only for a create request. Splunk Observability Cloud assigns it and returns it to you in the response.' lastUpdated: type: integer format: int64 example: 1647990000000 title: DashboardLastUpdated description: 'The last time the dashboard was updated, in *nix time in milliseconds. The system sets this value, and you can''t modify it.' lastUpdatedBy: type: string example: XXXX888 title: DashboardLastUpdatedBy description: 'ID of the last user who updated the dashboard. If the last update was by Splunk Observability Cloud, the value is AAAAAAAAAA. This value is read-only.' maxDelayOverride: type: integer format: int32 example: 1000 title: DashboardMaxDelayOverride description: 'Milliseconds to wait for late-arriving data points before rejecting them for inclusion in the charts in this dashboard. This value overrides but doesn''t change the max delay setting for individual charts in the dashboard. If you omit this property, the system uses individual chart settings. For individual charts, you can force the system to calculate a sensible value by removing the maxDelayOverride property of the chart. To force the system to do this for all charts in a dashboard, set CreateDashboardBody.maxDelayOverride to 0.' name: type: string example: Latency title: DashboardName description: 'A human-readable label for the dashboard. The UI displays this label in the dashboard group for the dashboard' selectedEventOverlays: type: array items: title: Event overlay for charts in a dashboard type: object required: - eventSignal properties: eventSignal: title: A search term that selects charts to overlay type: object required: - eventSearchText properties: eventSearchText: type: string example: ValueExceeded description: 'The event name or partial name that the system uses to select events to suggest as overlays on the charts in the dashboard' eventType: type: string enum: - detectorEvents - eventTimeSeries example: detectorEvents description: 'Controls the source of the event. You can specify the following: detectorEvents: Select events that come from a detector eventTimeSeries: Select events that come from a time series The API doesn''t accept other event types.' description: 'A filter that selects charts to overlay with events, based on event names and types' overlayId: type: string example: E5 description: 'Unique ID for this event overlay. Use this ID with any element of the selectedEventOverlays property to apply this overlay to a dashboard. Note: The system generates this value if you don''t specify one.' sources: type: array items: properties: NOT: type: boolean default: false example: false description: 'Controls the action of the filter. If set to true, then the system only selects events that don''t match the filter.' property: type: string example: datacenter description: 'The custom property or dimension name that provides the value to test in the filter. If the name you specify isn''t defined in one or more of the events associated with the dashboard, the filter never matches anything. If the NOT property for this filter is set to true and the filter never matches, all event overlays are suppressed.' value: type: array items: type: string example: - Paris - London description: 'An array of values to test against the specified property. If any of the values match, the system includes the event. Note: You must specify at least one element.' title: DashboardEventSources description: 'List of filters to apply to events for this event overlay, in the form of a JSON array.' description: 'Settings for an event overlay applied to each chart in a dashboard. You specify the event overlays for a dashboard with two different properties: CreateDashboardBody.EventOverlays: Inactive event overlays that you want to define for use at a later time. CreateDashboardBody.selectedEventOverlays: Active event overlays that you want to apply immediately to charts in the dashboard.' title: DashboardSelectedEventOverlays description: 'List of event overlays that are currently active for the charts in this dashboard, in the form of a JSON array of JSON objects. For each overlay, the system displays the active events that match the overlay search term and optional feature, using the color and event line settings for the overlay. To set options for inactive overlays so you can apply them at a later time, use the eventOverlays property instead.' tags: type: array items: type: string title: DashboardTags description: not used permissions: title: Permission configuration for the dashboard type: object properties: acl: type: array items: title: An access control layer type: object properties: actions: type: array items: type: string enum: - READ - WRITE description: Action the user, team, or organization can take with the dashboard. principalType: type: string enum: - USER - TEAM - ORG description: Clarify whether this permission configuration is for a user, a team, or an organization. principalId: type: string description: ID of the user, team, or organization for which you're granting permissions. description: A permission configuration for a user, team, or organization. description: 'List of permission configurations. Use this list to specify read and write permissions for your dashboard. The parent property is set to null by default if you do this. Use the parent property instead if you want your dashboard to inherit permissions from an existing dashboard group.' parent: type: string description: 'ID of the dashboard group you want your dashboard to inherit permissions from. Use this property to configure your dashboard to inherit permissions from an existing dashboard group. Use the acl property instead if you want to specify various read and write permission configurations.' description: Read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard. examples: example: value: authorizedWriters: teams: - ZZZZ4 - Z2X users: - YXXX - XYYY chartDensity: DEFAULT charts: - chartId: XY1XX5 column: 5 height: 2 row: 10 width: 7 created: 1641024000000 creator: XXYYX customProperties: string description: Latency measurements eventOverlays: - eventColorIndex: 5 eventLine: true eventSignal: eventSearchText: ValueExceeded eventType: detectorEvents sources: - NOT: false property: datacenter value: - Paris - London filters: sources: - NOT: false property: host value: - host5 - host6 time: end: 1647943200000 start: 1647936000000 variables: - alias: Europe preferredSuggestions: - Europe - Asia property: datacenter required: true restricted: true value: - London - Paris groupId: YYXXYY id: ZZZXXXX lastUpdated: 1647990000000 lastUpdatedBy: XXXX888 maxDelayOverride: 1000 name: Latency permissions: acl: - actions: - READ principalId: string principalType: USER parent: string selectedEventOverlays: - eventSignal: eventSearchText: ValueExceeded eventType: detectorEvents overlayId: E5 sources: - NOT: false property: datacenter value: - Paris - London tags: - string '400': description: HTTP 400 response content: application/json: schema: type: object properties: code: type: integer format: int32 description: HTTP response code. Always '400' message: type: string description: Error explanation examples: example: value: code: 0 message: string security: - SessionToken: [] tags: - Dashboards delete: summary: Delete Single Dashboard description: 'Deletes the dashboard that has the ID specified in the {id} path parameter. This API doesn''t use a request body.' parameters: - name: id in: path description: ID of an existing dashboard required: true schema: type: string - name: Content-Type in: header description: Format of the request body. Always application/json. required: true schema: type: string - name: X-SF-TOKEN in: header description: Authentication token required: true schema: type: string responses: '200': description: HTTP 200 response security: - SessionToken: [] tags: - Dashboards /dashboard/simple: post: summary: Create Simple Dashboard description: 'Creates a dashboard containing the new and existing charts you specify in the request body. For this dashboard, you can only specify the following values: Dashboard group: To add the new dashboard to an existing dashboard group, use the groupId query parameter. If you don''t provide groupId, the API creates a new dashboard group. Note: If you''re using the Enterprise Edition of Splunk Observability Cloud, the dashboardViews entitlement is enabled. In this case, the API returns an error instead of creating a dashboard. Dashboard name: To specify a name for the new dashboard, use the name query parameter. You must provide the name parameter or specify a new chart as the first entry in the list of charts in the request body (new charts always require the name field). If you don''t provide name, and the first chart in the list isn''t a new chart, the API returns an error. This endpoint doesn''t let you set the following dashboard-related fields: authorizedWriters: List of users and teams that can modify the dashboard chartDensity: Desired density of charts in this dashboard description: Extended description of the dashboard eventOverlays: List of all events you can display on charts in the dashboard filters: List of filters to apply to all charts in the dashboard. Filters include or exclude data points based on custom properties or dimensions. maxDelayOverride: For all charts in the dashboard, this overrides the maxDelay value for the chart selectedEventOverlays: List of all active event overlays for this dashboard permissions: Read and write control for this dashboard The request body for this operation is a list of chart objects you want to add to the new dashboard, in the form of a JSON array of JSON objects.' parameters: - name: name in: query description: 'Name to assign to the dashboard. If you don''t provide this parameter, the API gives the new dashboard the name of the first new chart in the list of charts in the request body. If you don''t provide name, and the first chart in the list is not a new chart, the API returns an error.' schema: type: string - name: groupId in: query description: 'ID of an existing group to which you want to add the dashboard. If you don''t provide this parameter, the API creates a new dashboard group to contain the new dashboard Note: If you''re using the Enterprise Edition of Splunk Observability Cloud, the dashboardViews entitlement is enabled. In this case, the API returns an error instead of creating a dashboard.' schema: type: string - name: Content-Type in: header description: Format of the request body. Always application/json. required: true schema: type: string - name: X-SF-TOKEN in: header description: Authentication token required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: title: Chart object in simple dashboard request body type: object properties: customProperties: title: Custom properties type: object example: usage: Latency tracking department: IT description: Custom properties for the chart, in the form of a JSON object description: title: Chart description type: string example: Latency tracking chart for use by IT department description: 'Description of the chart. This value appears underneath the chart name in the user interface.' chartId: title: ID of an existing chart example: AA4FA description: 'Splunk Observability Cloud-assigned ID of an existing chart. Use this field to add an existing chart to a new dashboard. In chart objects for existing charts you want to add to the dashboard, you must specify a value for the chartId field. The API ignores all other values. If the API can''t find an existing chart with the specified ID, the API returns an error. If you''re adding a new chart, you don''t have to add chartId to the chart object. If you do, the API ignores it.' name: title: Chart name (displayed) type: string example: LatencyChart description: 'Displayed name of the chart in the dashboard. If you''re using the API to create a new chart for the new dashboard, you must specify a value for this field.' options: type: object title: Properties of a chart required: - type properties: areaChartOptions: title: Properties for area charts type: object properties: showDataMarkers: title: Controls the display of data markers type: boolean default: false example: true description: 'If the options.type property is TimeSeriesChart and the options.defaultPlotType property is AreaChart, then the showDataMarkers field determines if Splunk Observability Cloud shows data markers in the chart; otherwise, the property is ignored.' axes: title: Axes options type: array items: title: Options for chart axes type: object properties: highWatermark: type: number format: float example: 12500 description: 'A point on the Y axis at which the chart displays a horizontal line, indicating the max Y value of interest. Points with a Y value that exceeds the high water mark still appear. Notes: Splunk Observability Cloud only uses this value for time series charts. Value must be less than or equal to options.axes.max and greater than options.axes.lowWaterMark for the corresponding axis.' highWatermarkLabel: type: string maxLength: 1000 example: Maximum expected value description: 'A label that''s displayed beside the horizontal line indicating the high water mark Notes: Splunk Observability Cloud only uses this value for time series charts. If options.axes.highWaterMark isn''t specified, this label is ignored.' label: type: string example: Latency in milliseconds description: 'Label that''s displayed for the Y axis of the chart. It appears to the left of axis values on the left axis and to the right of axis values on the right axis. Note: Splunk Observability Cloud only uses this value for time series charts.' lowWatermark: type: number format: float example: 500 description: 'A point on the Y axis at which the chart displays a horizontal line, indicating the minimum Y value of interest. Points with a Y value that is less than the low water mark still appear. Notes: Splunk Observability Cloud only uses this value for time series charts. Value must be greater than or equal to options.axes.min and less than options.axes.highWaterMark for the corresponding axis.' lowWatermarkLabel: type: string maxLength: 1000 example: Minimum expected value description: 'A label that''s displayed beside the horizontal line indicating the low water mark. Notes: Splunk Observability Cloud only uses this value for time series charts. If options.axes.lowWaterMark isn''t specified, this label is ignored.' max: type: number format: float example: 15000 description: 'Specifies the largest data value to display on the chart. Overrides options.includeZero if the properties are set to incompatible values. Notes: This value is only used if options.type is set to TimeSeriesChart. The value must be greater than the value of options.axes.min for the same options.axes element.' min: type: number format: float example: 1000 description: 'Specifies the smallest data value to display on the chart. Overrides options.includeZero if the properties are set to incompatible values. Notes: This value is only used if options.type is set to TimeSeriesChart. The value must be less than the value of options.axes.max for the same options.axes element.' description: 'These options are only used for time series charts. List of axis options for the left and right side of a time series chart, in the form of an array of JSON objects. The first element specifies options for the left side of the chart, and the second element corresponds to the right side of the chart. Other elements are ignored.' axisPrecision: title: 'Specifies the number of digits displayed for values plotted on the chart ' type: integer minimum: 3 maximum: 10 default: 3 example: 5 description: 'Precision that Splunk Observability Cloud uses to display values in the chart. Choose a value that is sensible for the data; that is, ensure that the variations in the data are discernible using the specified precision. For example, if the data values usually fluctuate between 100000 and 100010, using a precision of 3 would result in a value of 100000 for every data point. Setting the precision to 6 would distinguish between 100001 and 100002. Note: Splunk Observability Cloud only uses this value for time series charts.' colorBy: title: 'Specifies the mechanism by which color is applied to values in the chart ' type: string enum: - Range - Scale - Dimension - Metric example: Metric description: 'Specifies how to apply a color scheme to the values in the chart. If you want to apply color in a text chart, use HTML within the markdown property. The values you can use depend on the type of chart you specify in options.type: Text: The property is ignored Heatmap: The Range and Scale enumerated types are allowed; the default is Range List: The Dimension, Metric, and Scale enumerated types are allowed; the default is Metric SingleValue: The Dimension, Metric, and Scale enumerated types are allowed; the default is Metric TimeSeriesChart: The Dimension and Metric enumerated types are allowed; the default is Dimension.' colorRange: title: Specifies color range options for coloring a heatmap chart type: object properties: color: title: Starting color for a heatmap chart color range type: string minLength: 7 description: 'The starting hex color value for data values in a heatmap chart. The options.colorScale property controls how Splunk Observability Cloud creates a range of colors to represent different data values; options.colorRange.color is the starting point of the range, and options.colorScale controls the number of different colors. For best results, set options.colorRange.color to one of the 21 colors in the official Splunk Observability Cloud color palette. Specify the value as a 6-character hexadecimal value preceded by the "#" character, for example "#00b9ff" (light blue)' max: title: 'Maximum color value assigned to a data value in the heatmap chart ' type: string minLength: 7 description: 'The color value associated with the largest incoming data value in the heatmap Specify the value as a 6-character hexadecimal value preceded by the ''#'' character, for example "#ea1849" (grass green)' min: title: 'Minimum color value assigned to a data value in the heatmap chart ' type: string minLength: 7 description: 'The color value associated with the smallest incoming data value in the heatmap Specify the value as a 6-character hexadecimal value preceded by the ''#'' character, for example "#999999".' description: 'Range of color values for a heatmap chart, including the lowest and highest color to use, in the form of a JSON object. The options.colorScale property controls how Splunk Observability Cloud sets each intermediate chart color within the range.' colorScale: title: 'Specifies how to apply the range of specified color values to data in a heatmap chart ' type: object properties: inverted: title: 'Determines if colors are applied in reverse order from the default for the app ' type: boolean default: false description: 'Determines how to use colors specified in options.colorRange. If this property is set to true and options.colorBy is set to Range, darker colors represent smaller data values. For chart types other than Heatmap, setting this property to true results in red representing lower values and green representing higher ones (if the default color scheme is in use). Available when the chart type specified in options.type is set to Heatmap, SingleValue, or List' thresholds: title: Specifies data values that partition the data in the chart type: array items: type: number format: float description: 'Specifies data values that map to color gradient values, in the form of a JSON array. Sort the values from lowest to highest. Data values that are outside the specified partitions don''t appear in color, so set the first element to the lowest expected data value. Similarly, set the last element to the highest expected data value. Note: Splunk Observability Cloud uses only the first six elements in the array.' description: 'Properties that specify the limits of the color ranges specified in options.colorRange. These properties also control how to order the colors in the color gradient. Settings you make in options.colorScale2 override any settings you make here.' colorScale2: title: Secondary visualization properties type: array items: title: Secondary visualization options type: object required: - paletteIndex properties: gt: title: 'Indicates the lower threshold of this range, not including the value itself ' type: number format: float description: 'The lower threshold of a color range, not including the specified value itself. Notes: Available if the options.type property is set to List, SingleValue, or Heatmap The value must be less than the value of options.colorScale2.lt or options.colorScale2.lte of the same element. options.colorScale2.gt and options.colorScale2.gte are mutually exclusive' gte: title: 'Indicates the lower threshold of this range, including the value itself ' type: number format: float description: 'The lower threshold of a color range, including the specified value itself. Notes: Available if the options.type property is set to List, SingleValue, or Heatmap The value must be less than the value of options.colorScale2.lt or options.colorScale2.lte of the same element. options.colorScale2.gt and options.colorScale2.gte are mutually exclusive' lt: title: 'Indicates the upper threshold of this range, not including the value itself ' type: number format: float description: 'The upper threshold of a color range, not including the specified value itself. Notes: Available if the options.type property is set to List, SingleValue, or Heatmap The value must be less than the value of options.colorScale2.gt or options.colorScale2.gte of the same element. options.colorScale2.lt and options.colorScale2.lte are mutually exclusive' lte: title: 'Indicates the upper threshold of this range,including the value itself ' type: number format: float description: 'The upper threshold of a color range, including the specified value itself. Notes: Available if the options.type property is set to List, SingleValue, or Heatmap The value must be less than the value of options.colorScale2.gt or options.colorScale2.gte of the same element. options.colorScale2.lt and options.colorScale2.lte are mutually exclusive' paletteIndex: title: Color to use for data points in the specified range type: integer minimum: 0 maximum: 21 description: 'Index of a color listed in table 5 Color palette in the section Chart color palettes. The value is used to color points in the specified range. Notes: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. Depending on the settings users select for color blindness, they may see the alternate colors listed in Table 6. Color vision deficiency alternatives of the Charts API guide.' description: 'List of secondary visualization color properties, in the form of a JSON array. Each element contains a range of values and the color to display for the range. The array covers the entire range displayed in the secondary visualization or heatmap chart. Splunk Observability Cloud automatically orders the array elements by the chart values. The lowest value is the left border of the secondary visualization, and the highest value is the right border.' defaultPlotType: title: Specifies the plot type to use for this chart type: string example: LineChart enum: - LineChart - AreaChart - ColumnChart - Histogram default: LineChart description: 'Specifies the plot type to use for this chart: LineChart: A plot with data points connected by a series of straight lines. AreaChart: Similar to a LineChart, but with the area between the plot line and the x-axis filled with the line color. Column: Shaded vertical bars with their bottom on the x-axis and their top at the data points value. The bars aren''t connected. Histogram: Colored rectangular bins, with the color representing the number of data points for a value. Depending on how you set up your histogram chart, a green bar can indicate a higher number of data points for a particular value than a red bar.' groupBy: title: 'Custom properties that you want to group together chart ' type: array items: type: string description: 'A list of custom property names to group together in a histogram or table chart, in the form of a JSON array of strings. Each array element must contain the name of a property in the customProperties'' property in the request body or a valid default custom property. The first array element is a custom property that determines the top-level grouping. The second element determines the grouping within each first-level grouping. All other elements in the array are ignored. For example, Heatmap chart grouping shows a heatmap that groups CPU utilization by AWS availability zone as the primary grouping and number of host CPU cores as the secondary grouping. Note: This option is only available if options.type is HeatMap or TableChart.' groupBySort: title: 'Table chart options ' type: string enum: - Ascending - Descending description: 'Sorts a specified group of values in a table chart. Groups can either be sorted by Ascending or Descending order. Note: Use only when options.type property is TableChart; otherwise, the API returns an HTTP response code 400.' hideMissingValues: title: 'Table chart options ' type: boolean default: false description: 'Determines whether to include missing metric values in a table chart or list chart. If true, MTS with missing values are excluded from the chart. Note: Use only when options.type property is List or TableChart; otherwise, the API returns an HTTP response code 400.' histogramChartOptions: type: object properties: colorThemeIndex: title: Color to use for data points in a histogram chart type: integer minimum: 0 maximum: 15 default: 15 description: 'Color palette index that points to the theme color of a histogram chart. Use one of the first 16 index values in table 5 in the section Chart color palettes. Notes: Use only when options.type is TimeSeriesChart and options.defaultPlotType is Histogram; otherwise, the API returns an HTTP response code 400. Your users may see colors other than those shown in table 5 in the section Chart color palettes, depending on the settings they select for color blindness. To learn more, see table 6 in the section Chart color palettes of the Charts API guide.' includeZero: title: Determines how 0 affects Y-axis values type: boolean default: false example: false description: 'Flag that determines how 0 is treated when dynamically calculating Y-axis values. If true, 0 is included in the calculation; otherwise, Splunk Observability Cloud ignores data points containing 0. This is a chart-wide setting applied to all the axes. However, if options.axes.min or options.axes.max exclude 0 from the displayed range for an axis, 0 isn''t displayed on that axis even if includeZero is true. Note: Only available if the options.type is TimeSeriesChart' legendOptions: title: Sets table options type: object properties: fields: title: List of table settings for properties in the chart type: array items: type: object properties: enabled: title: Determines property display type: boolean default: true description: 'Determines if the property specified by legendOptions.properties.property for this element is displayed in the data table. Note: Only available if options.type is TimeSeriesChart, TableChart, or List' property: title: Key name of a property specified for this chart type: string description: 'The key name of a property to hide or show in the data table' description: 'List of table settings for properties in the chart, in the form of a JSON array. Each element in the array is a JSON object that contains a property name and a flag. If the flag for the object is set to true, the property is displayed; otherwise, it''s hidden.' description: 'Sets options for the data table or table chart, including which properties are omitted' lineChartOptions: type: object title: Options for a line chart properties: showDataMarkers: title: Determines how to represent data points in the chart type: boolean default: false example: true description: 'Flag that determines how to represent individual data points in the chart. If true, the chart is displayed with filled circles for each data points; otherwise, the chart is displayed as a smooth line.' description: 'Line chart options for a chart, in the form of a JSON object Notes: Only available if options.type is TimeSeriesChart Only available if options.defaultPlotType is LineChart' markdown: title: Text chart contents type: string description: 'The contents of a text chart, using GitHub-Flavored Markdown (GFM) or HTML. Note: Only available if options.type is set to Text' maximumPrecision: title: Precision used used to display data type: integer description: 'Number of significant digits to the right of the decimal point to use for data points in the chart. The integer part of the data points is used, regardless of the specified precision. Choose a value so that variations in the data are visible for the specified precision. For example, if data values are in the range 0.001 to 0.01, set maximumPrecision to 4. If you don''t specify a value, Splunk Observability Cloud adjusts the precision to fit the available display area. Note: Only available if options.type is List, TableChart, or SingleValue' onChartLegendOptions: type: object title: Display options for the chart legend properties: dimensionInLegend: title: The dimension to show in the legend type: string example: datacenter description: 'Specifies the dimension to show in the legend. Ensure that the dimension exists and has different values for each set of data points in the chart. Note: Only available if options.type is TimeSeriesChart' showLegend: title: Determines if a legend show display with the chart type: boolean default: false example: true description: 'Flag that determines if Splunk Observability Cloud should display a legend with the chart. If true, a legend is displayed below the chart. This legend lists the each value of the dimension specified in the options.onChartLegendsOptions.dimensionInLegend property. Next to each value is the color of the data point that has that dimension value in the chart. Note: Only available if options.type is `TimeSeriesChart''' description: 'Properties that determine if a legend should be displayed, and if so which dimension to show in the legend. Note: Only available if the options.type property is set to TimeSeriesChart' programOptions: title: General options for the chart type: object properties: disableSampling: title: Determines if the chart uses sampling type: boolean default: false example: false description: 'Determines if the chart displays samples from the data or plots every data points. By default, Splunk Observability Cloud uses sampling to provide better performance for charts. Note: Available for all values of options.type except for Text' maxDelay: title: Interval to wait before charting the available data type: integer format: int32 minimum: 0 maximum: 900000 example: 10000 description: 'Time in milliseconds to wait before charting the available data and ignoring points that arrive afterwards. By default, Splunk Observability Cloud automatically detects and applies a sensible value. You can also choose the automatic option by explicitly setting maxDelay to 0. The maximum value is 900,000 ms (15 minutes). Note: Available for all values of options.type except Text' minimumResolution: title: The minimum data resolution to use type: integer minimum: 0 maximum: 900000 example: 10000 description: 'The minimum resolution to use when computing the SignalFlow program, specified in milliseconds. By default, Splunk Observability Cloud computes and applies a sensible value. You can also choose the automatic option by explicitly setting minimumResolution to 0. The maximum value is 900,000 ms (15 minutes). Note: Available for all values of options.type except for Text' description: 'A set of options that control the general appearance and operation of the chart Note: Available for all values of options.type except for Text' publishLabelOptions: title: General options for a specific SignalFlow statement for the chart type: array items: type: object title: General chart options for the SignalFlow in the chart properties: displayName: title: Alternate display name type: string example: PlotName description: 'Specifies an alternate value for the Plot Name column of the data table associated with the chart. Note: Only available if options.type is TimeSeriesChart, List, or SingleValue' label: title: 'The SignalFlow `publish()` function label to which the properties of this object apply ' type: string example: Latency description: 'A label in a SignalFlow publish() function that gets associated with the other properties of this SignalFlow options object. Note: Only available if options.type is TimeSeriesChart, List, SingleValue, or Heatmap' paletteIndex: title: Color to use for plots associated with this SignalFlow statement type: integer minimum: 0 maximum: 15 description: 'Color to use for this plot, in the form of an integer index into the color table displayed in table 5 in the section Chart color palettes. Only the first 16 entries (0-15) are allowed for this value. This property corresponds to the Plot Color palette selector that appears in the Visualization Options pane. To select this pane, click the Configure plot icon on the right-hand side of the Plot Editor options bar. Notes: NOT available when options.type is Heatmap or Text. For these types, the API returns an HTTP response code 400. When options.type is SingleValue or List, or when options.type is TimeSeriesChart and options.publishLabelOptions.plotType is Histogram, paletteIndex is valid but has no effect on the plot color. Users may see colors other than those shown in the table, depending on the settings they select for color blindness. To see sample swatches of the alternate colors and the mappings used for color-blind users, see the hexadecimal color codes for the first 16 entries in table 6 in the section Chart color palettes.' plotType: title: 'Override of `options.defaultPlotType` for the output of the SignalFlow statement ' type: string example: LineChart enum: - LineChart - AreaChart - ColumnChart - Histogram description: 'Enumerated types that you can use to override the value of options.defaultPlotType for the output of the SignalFlow statement referred to by options.publishLabelOptions.label. Note: Only available if options.type is TimeSeriesChart, List, or SingleValue.' valuePrefix: title: String to prepend to values displayed in charts type: string example: Latency in description: 'Specifies a string to prepend to values displayed in a single value or list chart, the data table for a chart, and the tooltip shown when you hover over a point on a chart. To learn more, see the example in the section [Single value charts] (https://dev.splunk.com/observability/docs/chartsdashboards/charts_overview#Single-value-charts). Splunk Observability Cloud overrides valuePrefix if options.publishLabelOptions.valueUnit is set for the same plot. Note: Only available if options.type is TimeSeriesChart, List, SingleValue, or Heatmap' valueSuffix: title: String to append to values displayed in charts type: string example: milliseconds description: 'Specifies a string to append to values displayed in a single value or list chart, the data table for a chart, and the tooltip shown when you hover over a point on a chart. To learn more, see the example in the section [Single value charts] (https://dev.splunk.com/observability/docs/chartsdashboards/charts_overview#Single-value-charts). Splunk Observability Cloud overrides valueSuffix if options.publishLabelOptions.valueUnit is set for the same plot. Note: Only available if options.type is TimeSeriesChart, List, SingleValue, or Heatmap' valueUnit: title: Specifies the display units to use for chart values type: string example: Millisecond enum: - Bit - Kilobit - Megabit - Gigabit - Terabit - Petabit - Exabit - Zettabit - Yottabit - Byte - Kibibyte - Mebibyte - Gibibyte - Tebibyte - Pebibyte - Exbibyte - Zebibyte - Yobibyte - Nanosecond - Microsecond - Millisecond - Second - Minute - Hour - Day - Week description: 'Specifies the units of measure for values displayed in the chart. Splunk Observability Cloud displays chart values based on the assumption that the raw data is unit of measure you select. For example, the value 1000 in a plot where options.publishLabelOption.valueUnit is set to bits is displayed as 1 Kilobit, and the value 1024 in a plot set to Bytes is presented as 1 Kebibyte. For a full specification, refer to the section Display units and other labels , The options.publishLabelOptions.valueUnit option applies to scaling and labeling in chart tooltips, axes, and data tables. If options.publishLabelOptions.valueUnit affects the chart presentation, it overrides options.publishLabelOptions.valuePrefix, options.publishLabelOptions.valueSuffix, and options.unitPrefix. Note: Available for all values of options.type except for Text.' yAxis: title: Specifies the position of the Y axis type: integer default: 0 minimum: 0 maximum: 1 example: 0 description: 'Specifies the position of the Y-axis for the plot associated with the SignalFlow statement. If yAxis is set to 0, the axis is on the left side; otherwise it''s on the right. The default is 0 (left side). Note: This option is only available if ''options.typeisTimeSeriesChart, List, or SingleValue`.' required: - label description: Plot options description: 'List of properties that specify general options for the SignalFlow program in the chart, in the form of a JSON array. The order of elements in the list is retained, but has no effect. Splunk Observability Cloud uses label values to map options to specific publish() statements in the SignalFlow program. Heatmaps do not support full publishLabelOptions elements; the description of each property shows its supported chart types. Note: Available if options.type is one of TimeSeriesChart, List, SingleValue, or Heatmap' refreshInterval: title: Interval at which Splunk Observability Cloud should update the chart with new data type: integer minimum: 0 description: 'How often, in milliseconds, Splunk Observability Cloud refreshes the chart with data. If Splunk Observability Cloud can detect the resolution of the data, the default is 10,000 (10 seconds); otherwise, the default is 3,600,000 (1 hour). Note: This option is only available if options.type is List, TableChart, or SingleValue.' secondaryVisualization: title: Specifies the secondary visualization to use with the chart type: string enum: - None - Radial - Linear - Sparkline description: 'Specifies the secondary visualization to use with list or single value charts: For list charts, see List chart secondary visualization For single value charts, see Single value chart secondary visualization Note: This option is only available if option.type is List or SingleValue.' showEventLines: title: Specifies what to show on a chart when an event occurs type: boolean default: false example: true description: 'If true, Splunk Observability Cloud displays a vertical line on the chart at the point that an event occurs. Note: This option is only available if options.type is TimeSeriesChart.' showSparkLine: title: 'Determines if Splunk Observability Cloud should show a sparkline in a single value chart ' type: boolean default: false description: 'If true, Splunk Observability Cloud displays a sparkline for the value shown in a SingleValue chart. Notes: This option is only available if "options.type": "SingleValue". The value specified for options.secondaryVisualization overrides options.showSparkLine.' sortBy: title: Specifies how to sort the entries in a chart type: string description: 'Specifies how to sort the entries in a list or table chart. The first character of the value must be either: A minus sign (-) sets descending order for the data. A plus sign (+) sets ascending order for the data. The rest of the value specifies the sort criteria: A keyword that represents a data point value, a metric, or the publish() label of the SignalFlow statement that generates the data A dimension that''s available to the chart. The default is to sort on the publish() label in ascending order; this corresponds to the Auto option in the user interface. Values that don''t map to a keyword or valid dimension are sorted with the default specification. Data that contains null sorts to the start of the list for ascending order and to the end of the list for descending order. Note: This option is only available if option.type is List or TableChart.' sortDirection: title: Specifies how to sort values in a heatmap chart type: string enum: - Ascending - Descending default: Ascending description: 'If set to Ascending, the chart displays values from low to high; otherwise, the chart displays values from high to low. Note: This option is only available if options.type is HeatMap.' sortProperty: title: A custom property to use as the sort criteria for a heatmap chart type: string description: 'The custom property to use as the sorting criteria for the heatmap chart. The value should map to a valid key name specified in the customProperties property or to a valid custom property available by default. If no value is specified, the values are displayed without an obvious order. The name of a custom property to use as the sort criteria for a heatmap chart. The value must be a valid key specified by the customProperty property or a valid default custom property. If you don''t specify a value, the chart displays the values without any obvious order. Note: This option is only available if options.type is HeatMap.' stacked: title: Controls the display of stacked plots in a time series chart type: boolean default: false description: 'Controls the display of stacked plots in a time series chart. If true, Splunk Observability Cloud stacks charts and adds data points together to create the values indicated by the axis labels. You can still see individual values when you highlight them within the colored area representing a single plot. You can also view individual values in the data table. Note: This option is only available if options.type is TimeSeriesChart and options.defaultPlotType is AreaChart or ColumnChart.' time: title: Options for the time displayed in a chart type: object properties: end: title: Timestamp of the last time to display in the chart type: integer format: int64 minimum: 0 example: 1557707430000 description: 'The timestamp of the last time to display in the chart, in *nix time Note: This option is only available if options.type is TimeSeriesChart and options.time.type is absolute.' range: title: Number of milliseconds to display in the chart type: integer format: int64 minimum: 0 default: 0 description: 'The number of milliseconds to display in the chart. From this value, Splunk Observability Cloud calculates a rolling range with the current time at the right edge of the chart. Use 0 to use the default behavior, which is -15m except for the following metrics: AWS: See the metrics listed in the Connect to AWS topic in the user documentation. GCP: See the metrics listed in the Connect to GCP topic in the user documentation. Microsoft Azure: See the metrics listed in the Connect to Azure topic in the user documentation. Note: This option is only available if options.type is TimeSeriesChart and options.time.type is relative.' start: title: Timestamp of the first time to display in the chart type: integer format: int64 minimum: 0 example: 1557534630000 description: 'The timestamp of the first time to display in the chart, in *nix time Note: This option is only available if options.type is TimeSeriesChart and options.time.type is absolute.' type: title: Determines the type of time range to use type: string enum: - relative - absolute default: relative example: relative description: 'Determines whether to use an explicit time range or to show a range of the last n milliseconds. Note: This option is only available if options.type is TimeSeriesChart.' description: 'Time-related properties for a chart. Note: These properties are only available if options.type is TimeSeriesChart.' timeStampHidden: title: Determines if the timestamp is shown with displayed values type: boolean default: false example: true description: 'Determines if the timestamp displays with displayed values. If true, the timestamp for a value appears with the value in the chart. Note: This option is only available if options.type is Heatmap, TableChart, or SingleValue.' type: title: The type of chart or visualization to use for the data type: string enum: - Heatmap - List - SingleValue - TableChart - Text - TimeSeries example: TimeSeries description: 'The type of chart or visualization to use for the data: Heatmap: Displays values in an ordered set of colored boxes. The color indicates the relative health of the value. List: Display each value in its own row within a plot that shows recent changes SingleValue: Displays a single value with a color that indicates the health of the value. TableChart: Displays metrics and dimensions in table format. Text: Displays pre-defined text, optionally formatted with Markdown markup TimeSeries: Displays multiple data points, retaining historical data, in one of four modes: Line: Displays data points as chart points connected by straight lines. Each set of chart points and lines has its own specific color. Area: Similar to a Line chart, but the area between a line and the X-axis is filled with the line color. BarChart: Displays each data point as a colored vertical bar. The base of the bar is the X-axis, and its top is the data points value. data points are closely packed around the X-axis time value associated with the data point. Also known as a column chart. You can optionally display data points in a stacked bar chart. In this type of chart, different data points are vertical bars stacked above their associated time. Colors help differentiate the data points.' unitPrefix: title: Determines whether to use metric or binary units for chart values type: string enum: - Metric - Binary default: Metric example: Metric description: 'Specifies the type of unit to use when displaying or labeling values: Metric: Values represent decimal multiples. For example, if unitPrefix is Metric, 1K represents 1 kilobyte or 1000 bytes. Binary: Values represent binary multiples. For example, if unitPrefix is Binary, 1K represents 1 kibibyte or 1024 bytes. Note: This option is available for all values of option.type except Text' packageSpecifications: title: SignalFlow internal field type: string description: For internal use only. programText: title: Chart SignalFlow program type: string example: data('demo.latency.interval').publish(label='Latency') description: 'A SignalFlow program that computes data for the chart. If you''re adding a new chart to the new dashboard, you must specify this field; otherwise, the API ignores the value. If you use more than one line of SignalFlow, separate the lines with semicolons (";") or newline characters ("\n"). See Charts and SignalFlow for more information.' tags: title: Chart tags type: array items: type: string format: UTF-8 maxLength: 256 maxItems: 50 description: 'UTF-8 string, starting with an uppercase or lowercase alphabetic character. The maximum length is expressed in characters; if a string consists solely of single-byte UTF-8 entities, 1024 characters are available.' description: 'List of chart tags, in the form of a JSON array of strings. Use tags to search for or filter charts. One use is to tag charts that are in production with the value prod. Note: You can''t have more than 50 tags per chart.' description: 'For a chart you want to add to a new simple dashboard, this JSON object contains the fields for the chart. If the chart doesn''t exist, the API uses the fields in the object to create a new chart. The only required fields are name and programText. If the chart exists, the only required field is chartId. If you specify other fields, the API ignores their values. If you specify a chart ID that doesn''t exist, the API returns an error. If you don''t specify a dashboard name in the name query parameter, the API takes the dashboard name from the chart name of the first new chart in the request body. If you don''t specify a dashboard name in the query parameter, and you don''t try to create any new charts, the API returns an error.' examples: example: value: - chartId: AA4FA customProperties: department: IT usage: Latency tracking description: Latency tracking chart for use by IT department name: LatencyChart options: areaChartOptions: showDataMarkers: true axes: - highWatermark: 12500 highWatermarkLabel: Maximum expected value label: Latency in milliseconds lowWatermark: 500 lowWatermarkLabel: Minimum expected value max: 15000 min: 1000 axisPrecision: 5 colorBy: Metric colorRange: color: string max: string min: string colorScale: inverted: true thresholds: - 0 colorScale2: - gt: 0 gte: 0 lt: 0 lte: 0 paletteIndex: 0 defaultPlotType: LineChart groupBy: - string groupBySort: Ascending hideMissingValues: true histogramChartOptions: colorThemeIndex: 0 includeZero: false legendOptions: fields: - enabled: true property: string lineChartOptions: showDataMarkers: true markdown: string maximumPrecision: 0 onChartLegendOptions: dimensionInLegend: datacenter showLegend: true programOptions: disableSampling: false maxDelay: 10000 minimumResolution: 10000 publishLabelOptions: - displayName: PlotName label: Latency paletteIndex: 0 plotType: LineChart valuePrefix: Latency in valueSuffix: milliseconds valueUnit: Millisecond yAxis: 0 refreshInterval: 0 secondaryVisualization: None showEventLines: true showSparkLine: true sortBy: string sortDirection: Ascending sortProperty: string stacked: true time: end: 1557707430000 range: 0 start: 1557534630000 type: relative timeStampHidden: true type: TimeSeries unitPrefix: Metric packageSpecifications: string programText: data('demo.latency.interval').publish(label='Latency') tags: - string responses: '200': description: HTTP 200 response content: application/json: schema: type: object properties: chartDensity: type: string default: DEFAULT enum: - DEFAULT - LOW - HIGH - HIGHEST example: DEFAULT title: DashboardChartDensity description: 'Controls the number of data points displayed in the charts for this dashboard, over the time span specified for the charts: DEFAULT maps to approximately 60 data points LOW maps to approximately 30 data points HIGH maps to approximately 120 data points HIGHEST maps to approximately 240 data points' charts: type: array items: title: Dashboard settings for a chart in a dashboard type: object required: - chartId - column - row - height - width properties: chartId: type: string example: XY1XX5 description: 'ID of an existing chart. Because charts can only belong to one dashboard, you can''t associate this ID with any other dashboard.' column: type: integer minimum: 0 maximum: 11 example: 5 description: '0-based index of the horizontal position of the chart in the dashboard display. The position represents the left-most edge of the chart. If you specify the same column and row value for more than one chart, the system tries to reconfigure the layout. If there''s space, the dashboard retains the column value and spreads out over additional rows. Note: The API doesn''t validate the maximum value. However, if you specify a value greater than 11, the chart displays in the UI as if 11 was specified. If that column is already occupied in the specified row, the system displays the chart in the first free row from the top in the specified column.' height: type: integer minimum: 1 maximum: 3 example: 2 description: 'Number of rows this chart should span. Note: The API doesn''t validate the maximum value. However, if you specify a value greater than 3, the chart displays in the UI as if 3 was specified. If the total height of all specified charts in a column is greater than 100, the system recalculates the layout to fit all the specified charts into the display of the dashboard.' row: type: integer minimum: 0 maximum: 99 example: 10 description: '0-based index of the vertical position of the chart in the dashboard display. The position The value represents the top-most edge of the chart. the system moves charts upwards as needed to fill vertical gaps. If you specify the same column and row value for more than one chart, the system tries to reconfigure the layout. If there''s space, the dashboard retains the column value and spreads out over additional rows. The API doesn''t validate the maximum value. However, if you specify a value greater than 99, the chart displays as if 0 were specified. If that row is already occupied, the system displays the first free row from the top of the specified column.' width: type: integer minimum: 1 maximum: 12 example: 7 description: 'Number of columns this chart should span. The API doesn''t validate the maximum value. However, if you use a value greater than 12, the chart displays as if you specified 12. If the total width of all specified charts in a row is greater than 100, the system recalculates the layout so that all the specified charts fit into the display.' description: 'Dashboard settings for the chart specified in chartId. These settings control how the chart appears in the dashboard.' title: DashboardChartSettings description: 'List of IDs for the charts you want to include in the dashboard, and for each chart the dashboard settings to use, in the form of a JSON array of JSON objects. The dashboard settings for charts control how Splunk Observability Cloud arranges charts in a dashboard when the charts appear in the UI.' created: type: integer format: int64 example: 1641024000000 title: DashboardCreated description: 'The dashboard creation timestamp, in *nix time in milliseconds The system sets this value, and you can''t modify it.' creator: type: string example: XXYYX title: DashboardCreator description: 'ID of the user that created the dashboard. If Splunk Observability Cloud created this dashboard, the value is AAAAAAAAAA. The system sets this value, and you can''t modify it.' customProperties: type: string title: DashboardCustomProperties description: not used description: type: string example: Latency measurements title: DashboardDescription description: 'Description of the dashboard. The system displays the value in the dashboard tab tooltip in the dashboard group in the UI.' discoveryOptions: type: object title: DashboardDiscoveryOptions description: Reserved for system use eventOverlays: type: array items: title: Filter to apply to event overlays type: object required: - property - value properties: eventSignal: title: A search term that selects charts to overlay type: object required: - eventSearchText properties: eventSearchText: type: string example: ValueExceeded description: 'The event name or partial name that the system uses to select events to suggest as overlays on the charts in the dashboard' eventType: type: string enum: - detectorEvents - eventTimeSeries example: detectorEvents description: 'Controls the source of the event. You can specify the following: detectorEvents: Select events that come from a detector eventTimeSeries: Select events that come from a time series The API doesn''t accept other event types.' description: 'A filter that selects charts to overlay with events, based on event names and types' eventColorIndex: type: integer minimum: 0 maximum: 15 example: 5 description: 'Color to use for events, in the form of an integer index into the color table displayed in table 5 Color palette in the section Chart color palettes. Only the first 16 entries (0-15) are allowed for this value. Users may see colors other than those shown in the table, depending on the settings they select for color blindness. To see sample swatches of the alternate colors and the mappings used for color-blind users, see the hexadecimal color codes for the first 16 entries in table 6, Color vision deficiency alternatives in the section Chart color palettes.' eventLine: type: boolean default: false example: true description: 'Controls the display of vertical event lines in the charts that belong to the dashboard. If true, the system displays event lines; otherwise, no event lines appear.' sources: type: array items: properties: NOT: type: boolean default: false example: false description: 'Controls the action of the filter. If set to true, then the system only selects events that don''t match the filter.' property: type: string example: datacenter description: 'The custom property or dimension name that provides the value to test in the filter. If the name you specify isn''t defined in one or more of the events associated with the dashboard, the filter never matches anything. If the NOT property for this filter is set to true and the filter never matches, all event overlays are suppressed.' value: type: array items: type: string example: - Paris - London description: 'An array of values to test against the specified property. If any of the values match, the system includes the event. Note: You must specify at least one element.' title: DashboardEventSources description: 'List of filters to apply to events for this event overlay, in the form of a JSON array.' description: 'Filters to apply to event overlays, in the form of a JSON object containing comparison expression properties. Each term in the expression tries to match the values of a dimension or custom property to criteria you specify. Based on the match results, you can include or exclude an event.' title: DashboardEventOverlays description: 'List of event overlay definitions that you can apply to all of the charts of this dashboard, in the form of a JSON array of JSON objects. When you apply the overlays, the system displays all the active events that match the specified search term and any specified filter on all the charts in the dashboard. The display uses the color you specify for the overlay and, if selected, vertical lines that mark the event. Note: The objects in this array correspond to the suggested event overlays specified in the UI, and they''re not automatically applied as active overlays. To set default active event overlays, use the selectedEventOverlays property instead.' filters: title: Filters to apply to all the charts of a dashboard type: object properties: sources: type: array items: title: Filter to apply to charts in a dashboard type: object required: - property - value properties: NOT: type: boolean default: false example: false description: 'Flag that indicates how the filter should operate. If true, data that matches the criteria is excluded from charts; otherwise, data that matches the criteria is included.' property: type: string example: host description: 'Name of the dimension or custom property to match to the data. Note: If the dimension or custom property doesn''t exist in any of the charts for the dashboard, and ChartsFilter.NOT is true, the system doesn''t display any data in the charts.' value: type: array items: type: string example: - host5 - host6 description: 'A list of values to compare to the value of the dimension or custom property specified in ChartsFilter.property. If the list contains more than one value, the filter becomes a set of queries between the value of property and each element of value. The system joins these queries with an implicit OR.' description: 'A single filter to apply to the charts in the dashboard. The filter specifies a default or user-defined dimension or custom property. You can either include or exclude all the data that matches the dimension or custom property.' description: 'List of filters to apply to the charts in the dashboard, in the form of a JSON array. Each element is a single filter for a default or user-defined dimension or custom property.' time: type: object properties: end: type: string example: 1647943200000 description: 'The end of the time range to show for all charts in the dashboard. If you don''t specify a value for this property, the system defaults to the value of the end property for each chart. Note: The specified type for end is string, but the system also accepts a 64-bit signed integer >= 0 that represents a time in *nix time in milliseconds.' start: type: string example: 1647936000000 description: 'The start of the time range to show for all charts in the dashboard. If you don''t specify a value for this property, the system defaults to the value of the start property for each chart. Note: The specified type for start is string, but the system also accepts a 64-bit signed integer >= 0 that represents a time in *nix time in milliseconds.' description: 'Time range to show in all of the charts in the dashboard, in the form of a JSON object. The specifications in this object override those in each individual chart. If you don''t specify values, the system defaults to using the individual time setting for each chart.' variables: type: array items: title: Filter that appears in the UI type: object required: - property - value properties: alias: type: string example: Europe description: 'A label for the filter. The system displays this label in the area preceding the input textarea for the filter in the UI. Note: A good way to indicate that the string is a label is to append a space and a colon (":") to it.' preferredSuggestions: type: array items: type: string example: - Europe - Asia description: 'List of strings containing values to place at the top of the Suggested Values dropdown in UI for the dashboard, in the form of a JSON array. If ChartsWebUIFilter.restricted is true, the filter must use one of the values in this array; users only have a choice of selecting a value from this array.' property: type: string example: datacenter description: 'Name of a custom property or dimension to filter against. Note: If the dimension or custom property doesn''t exist in any of the charts in the dashboard, the system doesn''t display any data in the charts.' required: type: boolean default: false example: true description: 'Flag that controls the display of chart data. If true, users must use this filter in order to see data; otherwise, users can delete the filter.' restricted: type: boolean default: false example: true description: 'Flag that controls the values allowed in the filter. If true, the only allowable values are those specified in the ChartsWebUIFilter.preferredSuggestions array; otherwise, any value is allowed.' value: type: array items: type: string example: - London - Paris description: 'A list of values to compare to the value of the dimension or custom property specified in ChartsWebUIFilter.property. If the list contains more than one value, the filter becomes a set of queries between the value of property and each element of value. The system joins these queries with an implicit OR.' description: 'The specification for a filter that appears in the UI. The filter compares the value of a dimension or custom property to a value specified in this filter. You can specify the following in the filter: A default value A list of suggested values to display in the UI A flag that controls user input; if set to true, users are limited to the default and suggested values. You can also force users to choose this filter in order to see data in the charts of this dashboard.' description: 'List of UI-oriented filters that appear at the top of the dashboard, in the form of a JSON array of JSON objects. For each filter you can specify a name and a label for the dimension or custom property to filter against, a list of suggested comparison values to display in the UI, and other properties that control the UI display. To see a more detailed description of the options, see the property descriptions for the ChartsWebUIFilter model.' description: 'Specifies the properties of filters to apply to the dashboard. Filters give you fine-grained control over the data displayed in the charts in the dashboard. You can specify ad hoc filters or save them as variables for repeated use of the filter criteria. You can also use filters to apply a custom time window to all of the charts in the dashboard.' groupId: type: string example: YYXXYY title: DashboardGroupId description: 'ID of an existing dashboard group to associate with this dashboard. If you don''t specify a value, the system creates a new dashboard group and assigns its ID to this property during the create process.' id: type: string example: ZZZXXXX title: DashboardId description: 'The ID of the dashboard. This value is read-only for a create request. Splunk Observability Cloud assigns it and returns it to you in the response.' lastUpdated: type: integer format: int64 example: 1647990000000 title: DashboardLastUpdated description: 'The last time the dashboard was updated, in *nix time in milliseconds. The system sets this value, and you can''t modify it.' lastUpdatedBy: type: string example: XXXX888 title: DashboardLastUpdatedBy description: 'ID of the last user who updated the dashboard. If the last update was by Splunk Observability Cloud, the value is AAAAAAAAAA. This value is read-only.' maxDelayOverride: type: integer format: int32 example: 1000 title: DashboardMaxDelayOverride description: 'Milliseconds to wait for late-arriving data points before rejecting them for inclusion in the charts in this dashboard. This value overrides but doesn''t change the max delay setting for individual charts in the dashboard. If you omit this property, the system uses individual chart settings. For individual charts, you can force the system to calculate a sensible value by removing the maxDelayOverride property of the chart. To force the system to do this for all charts in a dashboard, set CreateDashboardBody.maxDelayOverride to 0.' name: type: string example: Latency title: DashboardName description: 'A human-readable label for the dashboard. The UI displays this label in the dashboard group for the dashboard' selectedEventOverlays: type: array items: title: Event overlay for charts in a dashboard type: object required: - eventSignal properties: eventSignal: title: A search term that selects charts to overlay type: object required: - eventSearchText properties: eventSearchText: type: string example: ValueExceeded description: 'The event name or partial name that the system uses to select events to suggest as overlays on the charts in the dashboard' eventType: type: string enum: - detectorEvents - eventTimeSeries example: detectorEvents description: 'Controls the source of the event. You can specify the following: detectorEvents: Select events that come from a detector eventTimeSeries: Select events that come from a time series The API doesn''t accept other event types.' description: 'A filter that selects charts to overlay with events, based on event names and types' overlayId: type: string example: E5 description: 'Unique ID for this event overlay. Use this ID with any element of the selectedEventOverlays property to apply this overlay to a dashboard. Note: The system generates this value if you don''t specify one.' sources: type: array items: properties: NOT: type: boolean default: false example: false description: 'Controls the action of the filter. If set to true, then the system only selects events that don''t match the filter.' property: type: string example: datacenter description: 'The custom property or dimension name that provides the value to test in the filter. If the name you specify isn''t defined in one or more of the events associated with the dashboard, the filter never matches anything. If the NOT property for this filter is set to true and the filter never matches, all event overlays are suppressed.' value: type: array items: type: string example: - Paris - London description: 'An array of values to test against the specified property. If any of the values match, the system includes the event. Note: You must specify at least one element.' title: DashboardEventSources description: 'List of filters to apply to events for this event overlay, in the form of a JSON array.' description: 'Settings for an event overlay applied to each chart in a dashboard. You specify the event overlays for a dashboard with two different properties: CreateDashboardBody.EventOverlays: Inactive event overlays that you want to define for use at a later time. CreateDashboardBody.selectedEventOverlays: Active event overlays that you want to apply immediately to charts in the dashboard.' title: DashboardSelectedEventOverlays description: 'List of event overlays that are currently active for the charts in this dashboard, in the form of a JSON array of JSON objects. For each overlay, the system displays the active events that match the overlay search term and optional feature, using the color and event line settings for the overlay. To set options for inactive overlays so you can apply them at a later time, use the eventOverlays property instead.' tags: type: array items: type: string title: DashboardTags description: not used title: SimpleDashboardResponseBody description: 'Fields in the dashboard object returned by POST /v2/dashboard/simple. The response body includes the following: The value of name and groupId for the new dashboard, if you provided them in your request Values that the API assigned to the new dashboard object. The API automatically assigns some values, such as created. Other values, such as description, contain default values' examples: example: value: chartDensity: DEFAULT charts: - chartId: XY1XX5 column: 5 height: 2 row: 10 width: 7 created: 1641024000000 creator: XXYYX customProperties: string description: Latency measurements eventOverlays: - eventColorIndex: 5 eventLine: true eventSignal: eventSearchText: ValueExceeded eventType: detectorEvents sources: - NOT: false property: datacenter value: - Paris - London filters: sources: - NOT: false property: host value: - host5 - host6 time: end: 1647943200000 start: 1647936000000 variables: - alias: Europe preferredSuggestions: - Europe - Asia property: datacenter required: true restricted: true value: - London - Paris groupId: YYXXYY id: ZZZXXXX lastUpdated: 1647990000000 lastUpdatedBy: XXXX888 maxDelayOverride: 1000 name: Latency selectedEventOverlays: - eventSignal: eventSearchText: ValueExceeded eventType: detectorEvents overlayId: E5 sources: - NOT: false property: datacenter value: - Paris - London tags: - string security: - SessionToken: [] tags: - Dashboards