openapi: 3.0.3 info: title: Splunk Observability Cloud — Charts version: 1.0.0 description: 'API for creating, retrieving, updating, and deleting charts. Some chart API property names differ from the option labels in the UI. These differences are noted for each property name. 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 /chart, PUT /chart/{id}, and DELETE /chart/{id} endpoints. You must have the Splunk Observability Cloud admin, power, or read_only role to use the GET /chart and GET /chart/{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 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: /chart: get: summary: Get Charts Using Query description: 'Gets one or more charts based on the selection criteria specified in the query parameters. 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: limit in: query description: 'Maximum number of charts to return. The default is 50, and Splunk Observability Cloud uses this value if you specify an invalid value.' schema: type: integer minimum: 1 default: 50 - name: name in: query description: 'A search pattern for the value of the name property of a chart. You can use any UTF-8 character in the string, and the API matches the pattern to any part of the name property. For example, name=per matches the following chart names: dropped per day 95th percentile personal disk usage The following conditions cause the API to match any value of the name property: String of length 0 Omitting the name parameter from the query' schema: type: string - name: offset in: query description: 'Position in the results at which the API should start returning charts. The API puts all the results into a 0-indexed array, sorted in a manner appropriate for the specified query parameters. The offset tells the API the array index at which it should start returning results. If you specify an offset that''s greater than the length of the results array, the API doesn''t return any values.' schema: type: integer minimum: 0 default: 0 - name: tags in: query description: "A search pattern for values in the tags array property of a chart.\nYou can use any UTF-8 character\ \ in the string, and the API matches\nthe pattern to any part of the tags property.\nTo specify more than one tag\ \ to search for, add additional tag query parameters\nto the URI. The API combines multiple tag queries with an\n\ implicit OR.\nFor example, suppose you want to retrieve the first 25 charts that have following properties:\n\n\ name matches \"myChart\"\ntags=cpu, tags=prod, tags=customer-facing\n\nThe following curl statement retrieves the\ \ charts:\ncurl -i\n --header \"Content-Type: application/json\"\n --header \"X-SF-TOKEN: \"\ \ \\\n --request GET \\\n https://api..observability.splunkcloud.com/v2/chart?limit=25&name=myChart&offset=0&tags=cpu&tags=prod" 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: title: Number of charts that match the query type: integer description: 'The number of charts that match the specified query. This value may be different from the number of charts in the results array property. The limit query parameter controls the number of charts that the request actually returns, and the offset query parameter determines the position at which the request starts returning parameters. These two factors can affect the actual number of returned charts.' results: title: Charts returned by the request type: array items: type: object properties: created: title: Chart creation time type: integer format: int64 example: 1557534630000 readOnly: true description: 'The time the chart was created, in *nix time in milliseconds. This value is always set by the system.' creator: title: Chart Creator ID type: string readOnly: true description: ID of the user that initially created the chart customProperties: title: Custom properties type: object additionalProperties: true description: User-defined JSON object containing metadata description: title: Chart description type: string description: 'Extended text description of the chart. This text appears in the Chart description text box at the top of the New Chart screen in the UI.' id: title: Chart ID type: string readOnly: true description: System-defined identifier for the chart lastUpdated: title: Chart last updated time type: integer format: int64 example: 1557707430000 readOnly: true description: 'The last time the chart was updated, in *nix time in milliseconds. This value is always set by the system.' lastUpdatedBy: title: Chart last updated ID type: string readOnly: true description: 'The ID of the last person who updated the chart. If the last update was done by the system, the value is the string literal "AAAAAAAAAA".' name: title: Chart name (displayed) type: string description: 'Short chart name. In the UI, you enter the chart name in the Untitled Chart text box at the top of the New Chart screen.' options: type: object title: Chart options properties: areaChartOptions: title: Properties specific to area charts type: object properties: showDataMarkers: title: Controls the display of data markers for area charts type: boolean default: false description: 'If options.type is TimeSeriesChart and options.defaultPlotType property is AreaChart, then areaChartOptions.showDataMarkers controls the appearance of small dots in the chart indicating times at which data arrived. To show markers, set to true; otherwise, set to false. If you use options.areaChartOptions.showDataMarkers with any other values of options.type and options.defaultPlotType, the API returns an HTTP response code 400.' axes: title: Axes options type: array items: title: Chart axes options type: object properties: highWatermark: type: number format: float 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. The 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 description: 'A label that''s displayed beside the horizontal line indicating the high water mark. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. If options.axes.highWaterMark isn''t specified, this label is ignored.' label: type: string 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' lowWatermark: type: number format: float 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. 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 description: 'A label that''s displayed beside the horizontal line indicating the low water mark. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400`. If options.axes.lowWaterMark isn''t specified, the API ignores this label.' max: type: number format: float description: 'Specifies the largest data value to display on the chart. Overrides options.includeZero if the properties are set to incompatible values. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. The value must be greater than the value of options.axes.min for the same options.axes element.' min: type: number format: float description: 'Specifies the smallest data value to display on the chart. Overrides options.includeZero if the properties are set to incompatible values. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. The value must be less than the value of options.axes.max for the same options.axes element.' description: 'Axis options for the left and right side of a chart with options.type of TimeSeriesChart. The object in the first element specifies options for the left chart axis, and the object in the second element specifies options for the right chart axis. All other elements are ignored. Note: Use only when options.type is TimeSeriesChart; otherwise, the API returns an HTTP response code 400.' axisPrecision: title: 'Specifies the number of digits displayed for values plotted on the chart. ' type: integer minimum: 3 maximum: 10 default: 3 description: 'Specifies the digits Splunk Observability Cloud displays for values plotted on 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' colorBy: title: 'Mechanism by which color is applied to values in the chart. ' type: string enum: - Range - Scale - Dimension - 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 API returns an HTTP response code 400. 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: Heatmap color range options type: object properties: color: title: Starting color for a heatmap chart color range type: string minLength: 7 description: 'The starting color value for data values in a heatmap chart. Specify the value as a 6-character hexadecimal value preceded by the "#" character. 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. The UI limits you to hexadecimal values for the colors displayed in table 5 in the section Chart color palettes of the Charts API guide. Use the same values for API requests to keep your chart settings consistent with the UI.' max: title: 'Maximum color value assigned to a data value in the heatmap chart. ' type: string minLength: 7 description: 'The color value to associate with the largest incoming data value in the heatmap chart. To learn more about this property, see the description of options.colorRange.color.' 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 chart. To learn more about this property, see the description of options.colorRange.color.' description: 'Properties that specify the range of color values to use in a heatmap chart, in the form of a JSON object. The properties specify the lowest and highest color to use. options.colorScale controls how Splunk Observability Cloud sets each intermediate chart color within the range. Note: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' colorScale: title: 'Heatmap chart color range limits ' 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 you set this property to true, and you also set options.colorBy 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).' 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. Specify the values from lowest to highest. Data values that outside the specified partitions don''t appear in color, so you should set the first array value to correspond to the lowest expected data value. Similarly, set the last array value to correspond 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, in the form of a JSON object. The properties also control the order of colors in the color gradient. The properties in options.colorScale2 override any properties you specify here. Note: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' colorScale2: title: List of secondary visualization color 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: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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, inclusive ' type: number format: float description: 'The lower threshold of a color range, including the specified value itself. Notes: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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: 'Color range upper threshold, inclusive ' type: number format: float description: 'The upper threshold of a color range, including the specified value itself. Notes: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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 of the section Charts 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 of the section Charts color palettes. of the Charts API guide.' description: 'List of secondary visualization color properties, in the form of an array of JSON objects. Each object in the array specifies the information for a single color range, including the color to display for that range and the borders of the range. The array specifies the entire range displayed in the secondary visualization or heatmap chart. You don''t need to insert the elements in a specific order, because automatically orders them by the values in the display. The lowest value becomes the left border of the secondary visualization, and the highest value becomes the right border.' defaultPlotType: title: Specifies the visualization option to use for a graph type: string enum: - LineChart - AreaChart - ColumnChart - Histogram default: LineChart description: 'When you choose a graph chart type by setting options.type to TimeSeriesChart, options.defaultPlotType sets the visualization to use for plots in the chart: LineChart: A plot with data points connected by a series of straight lines. AreaChart: Similar to a LineChart, 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. Also known as a bar chart. Histogram: Colored bars that indicate the distribution of data points values at a point in time.' groupBy: title: 'Groups of histogram chart properties ' type: array items: type: string description: 'Specifies a list of custom properties to use in grouping values in a histogram chart, in the form of a JSON array of strings. Each element must contain a key specified in customProperties or a valid default custom property. The first element determines the top-level grouping, and the second element determines the second-level grouping within each first-level grouping. All other elements are ignored. The section Heatmap chart grouping in API topics shows a heatmap that charts CPU utilization, using AWS availability zone as the top-level grouping and number of host CPU cores as the second-level grouping. Note: Use only when options.type property is Heatmap or TableChart. Otherwise, the API returns an HTTP response code 400.' 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 of the Charts API guide. 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.' includeZero: title: Determines how 0 affects Y-axis values type: boolean default: false description: '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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' legendOptions: title: 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 table. Note: Use only when options.type property is TimeSeriesChart, TableChart, List, or SingleValue. Otherwise, the API returns an HTTP response code 400.' 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: 'A list of table settings for properties in the chart, in the form of a JSON array. Each element of the array is a JSON object that contains a chart property key name and a flag. If the flag is true, the chart property appears; otherwise, it''s hidden.' description: 'Sets options for the data table of a chart or a table chart, including which properties are omitted.' lineChartOptions: type: object title: Line graph options properties: showDataMarkers: title: Determines how to represent data points in the chart type: boolean default: false description: '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: 'Specifies options for a line graph chart Note: Use only when options.type property is TimeSeriesChart and options.defaultPlotType is LineChart. Otherwise, the API returns an HTTP response code 400.' markdown: title: Text chart contents type: string description: 'The contents of a text chart, using GitHub-Flavored Markdown (GFM) or HTML. Note: Use only when options.type property is Text. Otherwise, the API returns an HTTP response code 400.' maximumPrecision: title: Specifies the number of fractional digits used to display data type: integer minimum: 0 description: 'Indicates the number of significant digits to the right of the decimal point to use for data points. 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: Use only when options.type is List, TableChart, or SingleValue. Otherwise, the API returns an HTTP response code 400.' noDataOptions: title: User-defined message for when a chart has no active metrics properties: noDataMessage: title: Display message type: string example: No active hosts found description: Message to show in a chart when no active metric is available. Max length is 140 characters. linkUrl: title: URL to additional resource type: string example: https://docs.splunk.com/Observability/gdi/opentelemetry/opentelemetry.html description: URL that links to resource for additional information. linkText: title: Display text for the URL type: string example: Set up Splunk OpenTelemetry description: Display text for the URL that links to additional resource. Max length is 50 characters. description: 'Set up a message that appears when metrics used in a chart either don''t exist or are inactive. Use only when options.type is Heatmap, List, SingleValue, or TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. A metric is considered inactive by Splunk Observability Cloud in the following cases: The metric hasn''t received any data for 24 hours. The metric is tagged as ephemeral and hasn''t received any data for one hour. Note: A chart with inactive metrics is distinct from a chart with active metrics that doesn''t receive data. For example, a chart might not receive any data despite using active metrics if you use a filter on the chart that doesn''t match any data. On a chart with active metrics, the no active metrics message won''t appear even if the chart isn''t receiving any data. To learn more about why your message might not appear, see When your message doesn''t appear in Splunk Observability Cloud user documentation.' onChartLegendOptions: type: object title: Chart legend options properties: dimensionInLegend: title: Dimension to show in the legend type: string description: '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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' showLegend: title: Determines if a legend show display with the chart type: boolean default: false description: '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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' description: 'Properties that determine if Splunk Observability Cloud should display a legend, and if so, which dimension to show in the legend, in the form of a JSON object. Note: Use only when options.type is TimeSeriesChart, List, or SingleValue. Otherwise, the API returns an HTTP response code 400.' programOptions: title: General chart options type: object properties: disableSampling: title: Determines if the chart uses sampling type: boolean default: 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 any value of options.type except Text' maxDelay: title: Interval to wait before charting the available data type: integer format: int32 minimum: 0 maximum: 900000 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 any value of options.type except Text' minimumResolution: title: Minimum data resolution to use type: integer minimum: 0 maximum: 900000 description: '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 any value of options.type except Text' timezone: title: Time zone for SignalFlow calendar window transformations type: string default: UTC description: 'Time zone that SignalFlow uses as the basis of calendar window transformation methods. For example, if you set "timezone": "Europe/Paris" and then use the transformation sum(cycle="week", cycle_start="Monday") in the SignalFlow program for your chart, the calendar window starts on Monday, Paris time. To learn more, see Timezones and SignalFlow calendar window transformations.' description: 'Options that control the general appearance and operation of the chart, in the form of a JSON object. Note: Available for any value of options.type except Text' publishLabelOptions: title: SignalFlow statement options type: array items: type: object title: SignalFlow plot options properties: displayName: title: Alternate display name type: string description: 'Specifies an alternate value for the Plot Name column of the Data Table associated with the plot. In the UI, this is the text value listed below Name, on the right side of the top bar in the Plot Editor. Note: Use only when options.type is TimeSeriesChart, List, or SingleValue.' label: title: '`publish()` block label ' type: string description: "For the SignalFlow program in the programText property of a POST\nor PUT\ \ request body, label maps its publishLabelOptions parent\nobject properties to the\ \ plot from the publish() block that has the\nsame label in its label= argument.\nFor\ \ example, if the SignalFlow program contains the statement\nA = data('demo.trans.count').publish(label='A')\n\ and the POST request body for creating a chart contains\n\"options\": {\n ...\n \"\ publishLabelOptions\": {\n ...\n \"label\": \"A\"\n }\n}\n\nthen Splunk Observability\ \ Cloud applies the properties in the publishLabelOptions object\nto the plot displayed\ \ by the SignalFlow statement.\nNote: Use only when options.type property is\nList,\ \ TimeSeriesChart, or SingleValue;\notherwise, the API returns an HTTP response code\ \ 400." paletteIndex: title: Plot color 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 of the Charts API guide.' plotType: title: Plot-specific time series graph visualization enum: - LineChart - AreaChart - ColumnChart - Histogram description: 'Plot-specific override of the time series graph visualization you specify for the entire chart. plotType only applies to the SignalFlow statement that provides data for the plot. For example, if you create a chart with two SignalFlow statements, set options.type to TimeSeriesChart, and set defaultPlotType to LineChart, Splunk Observability Cloud displays a chart with two line plots. To change one of the plots to a bar chart, set publishLabelOptions.plotType for the SignalFlow publish() label of the plot to ColumnChart. The result is a chart with a line plot and a column plot. This property corresponds to the Visualization Type 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 the plot type is Heatmap or Text. For these types, the API returns an HTTP response code 400. If you only have one plot for the chart, so that the publishLabelOptions array has only one element, this property overrides the plot type for the entire chart. type: string' valuePrefix: title: String to prepend to values displayed in a plot type: string description: 'Specifies a string to prepend to values displayed in a single value or list plot, the data table for a plot, and the tooltip shown when you hover over a point on a plot. To learn more, see the example in the section Adding a prefix and/or suffix in the user documentation. Any value you set for options.publishLabelOptions[].valueUnit property overrides valuePrefix. This property corresponds to the Prefix text box that appears when you select Custom from the Display Units dropdown list 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. Note: Not available when the plot type is Text. The API returns an HTTP response code 400.' valueSuffix: title: String to append to values displayed in charts type: string 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 Adding a prefix and/or suffix in the user documentation. Any value you set for options.publishLabelOptions[].valueUnit property overrides valueSuffix. This property corresponds to the Suffix text box that appears when you select Custom from the Display Units dropdown list 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. Note: Not available when the plot type is Text. The API returns an HTTP response code 400.' valueUnit: title: Specifies the display units to use for chart values type: string 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 plot. Splunk Observability Cloud displays values based on the assumption that the raw data has the unit of measure you select. For example, the value 1000 in a plot where you''ve set options.publishLabelOptions[].valueUnit to bits appears as 1 Kilobit, and the value 1024 in a plot set to Bytes appears as 1 Kebibyte. Splunk Observability Cloud scales units within their own unit type. To learn more, see Displaying units and other labels. The options.publishLabelOptions[].valueUnit option applies to scaling and labeling in chart tooltips, axes, and data tables. options.publishLabelOptions[].valueUnit overrides options.publishLabelOptions[].valuePrefix and options.publishLabelOptions[].valueSuffix. The property value corresponds to one of the options that appear in Display Units dropdown list 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. Note: Not available when the plot type is Text. The API returns an HTTP response code 400.' yAxis: title: Y axis position for plot type: integer default: 0 minimum: 0 maximum: 1 description: 'Position of the Y-axis for the plot to which this publishLabelOptions object applies. If yAxis is 0, the axis appears on the left side. Otherwise it appears on the right. The default is 0 (left side). Note: Use only when options.type property is TimeSeriesChart, List, or SingleValue; otherwise, the API returns an HTTP response code 400.' required: - label description: Properties of a single plot in a chart description: 'List that specifies options for each plot displayed in the chart, in the form of an array of JSON objects. In this context, a plot is the publish() block output from a single statement in the SignalFlow program for the chart. To match a SignalFlow statement to an array element, Splunk Observability Cloud maps the value of the label argument for the publish() block to the value of a publishLabelOptions[].label property. Some publishLabelOptions child object properties aren''t supported for all plot types. Note: Not available when options.type is Text; the API returns an HTTP response code 400.' refreshInterval: title: Interval at which Splunk Observability Cloud should update the chart with new data type: integer format: int32 minimum: 0 description: 'How often, in milliseconds, that Splunk Observability Cloud should refresh 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: Use only when options.type property is List, TableChart, or SingleValue. Otherwise, the API returns an HTTP response code 400.' secondaryVisualization: title: Secondary visualization to use with the chart type: string enum: - None - Radial - Linear - Sparkline description: 'Secondary visualization to use with list or single value charts. See the section Secondary visualization for examples of the available visualizations. Note: Use only when options.type property is List or SingleValue. Otherwise, the API returns an HTTP response code 400.' showEventLines: title: Specifies what to show on a chart when an event occurs type: boolean default: false description: 'If true, Splunk Observability Cloud displays a vertical line on the chart at the point that an event occurs. Note: Use only when options.type property is TimeSeriesChart; otherwise, the API returns an HTTP response code 400.' 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 single value chart. Notes: Use only when optionstype property is SingleValue. Otherwise, the API returns an HTTP response code 400. The value specified for options.secondaryVisualization overrides options.showSparkLine.' sortBy: title: Specifies how to sort the entries in a time series chart or table chart type: string description: 'Specifies how to sort the entries in a time series chart or table chart. The first character of the value must be one of the following: Minus sign (-): Sets descending order for the data Plus sign (+): Sets ascending order for the data The rest of the characters specify the sort criteria: A keyword that represents a data points 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 Splunk Observability Cloud web UI. 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 chart for ascending order and to the end of the list for descending order. Note: Use only when options.type property is TimeSeriesChart or TableChart. Otherwise, the API returns an HTTP response code 400.' 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: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' 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: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' stacked: title: Controls the display of stacked plots in a graph type: boolean default: false description: 'Controls the display of stacked plots in a graph. If true, Splunk Observability Cloud stacks the plots 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. If options.defaultPlotType is ''AreaChart, Splunk Observability Cloud displays the plots as stacked areas. If defaultPlotTypeisColumn`, Splunk Observability Cloud displays the plots as stacked columns. Note: Use only when options.type property is TimeSeriesChart and options.defaultPlotType is AreaChart or Column. Otherwise, the API returns an HTTP response code 400.' time: title: Chart time display options type: object properties: end: title: Timestamp of the last time to display in the chart type: integer format: int64 example: 205430400000 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: Use only when options.type property is TimeSeriesChart and options.time.type is relative. Otherwise, the API returns an HTTP response code 400`.' start: title: Timestamp of the first time to display in the chart type: integer format: int64 example: 205344000000 description: 'The timestamp of the first time to display in the chart, in *nix time Note: Use only when options.type property is TimeSeriesChart and options.time.type is absolute. Otherwise, the API returns an HTTP response code 400.' type: title: Determines the type of time range to use type: string enum: - relative - absolute default: relative description: 'Determines whether to use an explicit time range or to show a range of the last n milliseconds. Note: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' description: 'Time-related properties for a chart, in the form of a JSON object. Note: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' timeStampHidden: title: Determines if the timestamp is shown with displayed values type: boolean default: false description: 'Determines if the timestamp displays with displayed values. If true, the timestamp for a value appears with the value in the chart. Note: Use only when options.type property is Heatmap, TableChart, or SingleValue. Otherwise, the API returns an HTTP response code 400.' type: title: Visualization type type: string enum: - Heatmap - List - SingleValue - TableChart - Text - TimeSeriesChart description: 'Type of visualization to use for the data. Splunk Observability Cloud provides six main visualization types: Heatmap: Displays data in a set of colored boxes. You can provide an optional order and grouping; otherwise, each box represents a metric time series in the output. The color of a box is determined by the value of the metric it represents. Splunk Observability Cloud provides default values, or you can specify your own custom ranges. List: Displays data as a list of metric time series. You can provide an additional secondary visualization as well. For example, you can display a sparkline for each row in the list. SingleValue: Displays a single value with a color that you specify. You can specify an additional visualization (secondary visualization) as well. For example, you can display a sparkline next to the value. TableChart: Displays metrics and dimensions in table format. Each metric name and dimension key displays as a column. Each output MTS displays as a row. If there are multiple values for a cell, each MTS displays in a separate row. Text: Displays text you provide. You can use Markdown to format the appearance of this text. TimeSeriesChart: Displays graphs of metric time series over time, using a graph type determined by the value of options.defaultPlotType or options.publishLabelOptions.plotType: LineChart: Displays data points as plot points connected by straight lines. In a graph that displays multiple metric time series, such as metric data points for several dimension values, Splunk Observability Cloud assigns a different color to each MTS. AreaChart: Similar to a LineChart, but the area between the line and the X-axis is filled with the color of the line. You can display multiple MTS as stacked area charts by setting options.stacked to true. Column: Displays each data points in an MTS as a colored vertical bar with the base on the X-axis and the top at the data points value. This type is also known as a bar chart. In a chart that displays multiple MTS, each data points for each MTS has its own bar and bar color, and the bars are clustered around the data points timestamp. You can display multiple MTS as stacked bars by setting options.stacked to true. Histogram: Colored bars that indicate the distribution of data points values at a point in time.' unitPrefix: title: Determines whether to use metric or binary units for chart values type: string enum: - Metric - Binary default: 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 any value of option.type except Text.' relatedDetectorIds: title: Detectors linked to this chart type: array items: type: string uniqueItems: true readOnly: true description: List of detectors linked to this chart, in the form of a JSON array. Each item is a unique ID of a linked detector. This list is read-only and is retrieved from programText. autoDetectRelatedDetectorIds: title: AutoDetect detectors linked to this chart type: array items: type: string uniqueItems: true readOnly: true description: List of AutoDetect and customized AutoDetect detectors linked to this chart, in the form of a JSON array. Each item is a unique ID of a linked AutoDetect or customized AutoDetect detector. This list is read-only and is retrieved from programText. title: GetChartsResult description: 'An array of charts returned by the request. The charts match the search criteria specified in the query parameters of the request.' examples: example: value: count: 0 results: - autoDetectRelatedDetectorIds: - string created: 1557534630000 creator: string description: string id: string lastUpdated: 1557707430000 lastUpdatedBy: string name: string options: areaChartOptions: showDataMarkers: true axes: - highWatermark: 0 highWatermarkLabel: string label: string lowWatermark: 0 lowWatermarkLabel: string max: 0 min: 0 axisPrecision: 0 colorBy: Range 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: true legendOptions: fields: - enabled: true property: string lineChartOptions: showDataMarkers: true markdown: string maximumPrecision: 0 noDataOptions: linkText: Set up Splunk OpenTelemetry linkUrl: https://docs.splunk.com/Observability/gdi/opentelemetry/opentelemetry.html noDataMessage: No active hosts found onChartLegendOptions: dimensionInLegend: string showLegend: true programOptions: disableSampling: true maxDelay: 0 minimumResolution: 0 timezone: string publishLabelOptions: - displayName: string label: string paletteIndex: 0 plotType: LineChart valuePrefix: string valueSuffix: string valueUnit: Bit yAxis: 0 refreshInterval: 0 secondaryVisualization: None showEventLines: true showSparkLine: true sortBy: string sortDirection: Ascending sortProperty: string stacked: true time: end: 205430400000 range: 0 start: 205344000000 type: relative timeStampHidden: true type: Heatmap unitPrefix: Metric relatedDetectorIds: - string security: - SessionToken: [] tags: - Charts post: summary: Create Single Chart description: 'Creates a new chart. After you create the chart, add it to a dashboard using either the Create Dashboard or Update Dashboard API. You can then view and modify the chart from that dashboard. The chart also appears in the chart catalog for your organization. For more information, see Display data using 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: title: Properties for creating or updating a chart type: object properties: customProperties: title: Custom properties type: object additionalProperties: true description: User-defined JSON object containing metadata description: title: Chart description type: string description: 'Extended text description of the chart. This text appears in the Chart description text box at the top of the New Chart screen in the UI.' name: title: Chart name (displayed) type: string description: 'Short chart name. In the UI, you enter the chart name in the Untitled Chart text box at the top of the New Chart screen.' options: type: object title: Chart options properties: areaChartOptions: title: Properties specific to area charts type: object properties: showDataMarkers: title: Controls the display of data markers for area charts type: boolean default: false description: 'If options.type is TimeSeriesChart and options.defaultPlotType property is AreaChart, then areaChartOptions.showDataMarkers controls the appearance of small dots in the chart indicating times at which data arrived. To show markers, set to true; otherwise, set to false. If you use options.areaChartOptions.showDataMarkers with any other values of options.type and options.defaultPlotType, the API returns an HTTP response code 400.' axes: title: Axes options type: array items: title: Chart axes options type: object properties: highWatermark: type: number format: float 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. The 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 description: 'A label that''s displayed beside the horizontal line indicating the high water mark. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. If options.axes.highWaterMark isn''t specified, this label is ignored.' label: type: string 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' lowWatermark: type: number format: float 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. 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 description: 'A label that''s displayed beside the horizontal line indicating the low water mark. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400`. If options.axes.lowWaterMark isn''t specified, the API ignores this label.' max: type: number format: float description: 'Specifies the largest data value to display on the chart. Overrides options.includeZero if the properties are set to incompatible values. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. The value must be greater than the value of options.axes.min for the same options.axes element.' min: type: number format: float description: 'Specifies the smallest data value to display on the chart. Overrides options.includeZero if the properties are set to incompatible values. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. The value must be less than the value of options.axes.max for the same options.axes element.' description: 'Axis options for the left and right side of a chart with options.type of TimeSeriesChart. The object in the first element specifies options for the left chart axis, and the object in the second element specifies options for the right chart axis. All other elements are ignored. Note: Use only when options.type is TimeSeriesChart; otherwise, the API returns an HTTP response code 400.' axisPrecision: title: 'Specifies the number of digits displayed for values plotted on the chart. ' type: integer minimum: 3 maximum: 10 default: 3 description: 'Specifies the digits Splunk Observability Cloud displays for values plotted on 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' colorBy: title: 'Mechanism by which color is applied to values in the chart. ' type: string enum: - Range - Scale - Dimension - 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 API returns an HTTP response code 400. 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: Heatmap color range options type: object properties: color: title: Starting color for a heatmap chart color range type: string minLength: 7 description: 'The starting color value for data values in a heatmap chart. Specify the value as a 6-character hexadecimal value preceded by the "#" character. 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. The UI limits you to hexadecimal values for the colors displayed in table 5 in the section Chart color palettes of the Charts API guide. Use the same values for API requests to keep your chart settings consistent with the UI.' max: title: 'Maximum color value assigned to a data value in the heatmap chart. ' type: string minLength: 7 description: 'The color value to associate with the largest incoming data value in the heatmap chart. To learn more about this property, see the description of options.colorRange.color.' 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 chart. To learn more about this property, see the description of options.colorRange.color.' description: 'Properties that specify the range of color values to use in a heatmap chart, in the form of a JSON object. The properties specify the lowest and highest color to use. options.colorScale controls how Splunk Observability Cloud sets each intermediate chart color within the range. Note: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' colorScale: title: 'Heatmap chart color range limits ' 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 you set this property to true, and you also set options.colorBy 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).' 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. Specify the values from lowest to highest. Data values that outside the specified partitions don''t appear in color, so you should set the first array value to correspond to the lowest expected data value. Similarly, set the last array value to correspond 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, in the form of a JSON object. The properties also control the order of colors in the color gradient. The properties in options.colorScale2 override any properties you specify here. Note: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' colorScale2: title: List of secondary visualization color 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: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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, inclusive ' type: number format: float description: 'The lower threshold of a color range, including the specified value itself. Notes: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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: 'Color range upper threshold, inclusive ' type: number format: float description: 'The upper threshold of a color range, including the specified value itself. Notes: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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 of the section Charts 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 of the section Charts color palettes. of the Charts API guide.' description: 'List of secondary visualization color properties, in the form of an array of JSON objects. Each object in the array specifies the information for a single color range, including the color to display for that range and the borders of the range. The array specifies the entire range displayed in the secondary visualization or heatmap chart. You don''t need to insert the elements in a specific order, because automatically orders them by the values in the display. The lowest value becomes the left border of the secondary visualization, and the highest value becomes the right border.' defaultPlotType: title: Specifies the visualization option to use for a graph type: string enum: - LineChart - AreaChart - ColumnChart - Histogram default: LineChart description: 'When you choose a graph chart type by setting options.type to TimeSeriesChart, options.defaultPlotType sets the visualization to use for plots in the chart: LineChart: A plot with data points connected by a series of straight lines. AreaChart: Similar to a LineChart, 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. Also known as a bar chart. Histogram: Colored bars that indicate the distribution of data points values at a point in time.' groupBy: title: 'Groups of histogram chart properties ' type: array items: type: string description: 'Specifies a list of custom properties to use in grouping values in a histogram chart, in the form of a JSON array of strings. Each element must contain a key specified in customProperties or a valid default custom property. The first element determines the top-level grouping, and the second element determines the second-level grouping within each first-level grouping. All other elements are ignored. The section Heatmap chart grouping in API topics shows a heatmap that charts CPU utilization, using AWS availability zone as the top-level grouping and number of host CPU cores as the second-level grouping. Note: Use only when options.type property is Heatmap or TableChart. Otherwise, the API returns an HTTP response code 400.' 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 of the Charts API guide. 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.' includeZero: title: Determines how 0 affects Y-axis values type: boolean default: false description: '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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' legendOptions: title: 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 table. Note: Use only when options.type property is TimeSeriesChart, TableChart, List, or SingleValue. Otherwise, the API returns an HTTP response code 400.' 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: 'A list of table settings for properties in the chart, in the form of a JSON array. Each element of the array is a JSON object that contains a chart property key name and a flag. If the flag is true, the chart property appears; otherwise, it''s hidden.' description: 'Sets options for the data table of a chart or a table chart, including which properties are omitted.' lineChartOptions: type: object title: Line graph options properties: showDataMarkers: title: Determines how to represent data points in the chart type: boolean default: false description: '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: 'Specifies options for a line graph chart Note: Use only when options.type property is TimeSeriesChart and options.defaultPlotType is LineChart. Otherwise, the API returns an HTTP response code 400.' markdown: title: Text chart contents type: string description: 'The contents of a text chart, using GitHub-Flavored Markdown (GFM) or HTML. Note: Use only when options.type property is Text. Otherwise, the API returns an HTTP response code 400.' maximumPrecision: title: Specifies the number of fractional digits used to display data type: integer minimum: 0 description: 'Indicates the number of significant digits to the right of the decimal point to use for data points. 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: Use only when options.type is List, TableChart, or SingleValue. Otherwise, the API returns an HTTP response code 400.' noDataOptions: title: User-defined message for when a chart has no active metrics properties: noDataMessage: title: Display message type: string example: No active hosts found description: Message to show in a chart when no active metric is available. Max length is 140 characters. linkUrl: title: URL to additional resource type: string example: https://docs.splunk.com/Observability/gdi/opentelemetry/opentelemetry.html description: URL that links to resource for additional information. linkText: title: Display text for the URL type: string example: Set up Splunk OpenTelemetry description: Display text for the URL that links to additional resource. Max length is 50 characters. description: 'Set up a message that appears when metrics used in a chart either don''t exist or are inactive. Use only when options.type is Heatmap, List, SingleValue, or TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. A metric is considered inactive by Splunk Observability Cloud in the following cases: The metric hasn''t received any data for 24 hours. The metric is tagged as ephemeral and hasn''t received any data for one hour. Note: A chart with inactive metrics is distinct from a chart with active metrics that doesn''t receive data. For example, a chart might not receive any data despite using active metrics if you use a filter on the chart that doesn''t match any data. On a chart with active metrics, the no active metrics message won''t appear even if the chart isn''t receiving any data. To learn more about why your message might not appear, see When your message doesn''t appear in Splunk Observability Cloud user documentation.' onChartLegendOptions: type: object title: Chart legend options properties: dimensionInLegend: title: Dimension to show in the legend type: string description: '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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' showLegend: title: Determines if a legend show display with the chart type: boolean default: false description: '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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' description: 'Properties that determine if Splunk Observability Cloud should display a legend, and if so, which dimension to show in the legend, in the form of a JSON object. Note: Use only when options.type is TimeSeriesChart, List, or SingleValue. Otherwise, the API returns an HTTP response code 400.' programOptions: title: General chart options type: object properties: disableSampling: title: Determines if the chart uses sampling type: boolean default: 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 any value of options.type except Text' maxDelay: title: Interval to wait before charting the available data type: integer format: int32 minimum: 0 maximum: 900000 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 any value of options.type except Text' minimumResolution: title: Minimum data resolution to use type: integer minimum: 0 maximum: 900000 description: '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 any value of options.type except Text' timezone: title: Time zone for SignalFlow calendar window transformations type: string default: UTC description: 'Time zone that SignalFlow uses as the basis of calendar window transformation methods. For example, if you set "timezone": "Europe/Paris" and then use the transformation sum(cycle="week", cycle_start="Monday") in the SignalFlow program for your chart, the calendar window starts on Monday, Paris time. To learn more, see Timezones and SignalFlow calendar window transformations.' description: 'Options that control the general appearance and operation of the chart, in the form of a JSON object. Note: Available for any value of options.type except Text' publishLabelOptions: title: SignalFlow statement options type: array items: type: object title: SignalFlow plot options properties: displayName: title: Alternate display name type: string description: 'Specifies an alternate value for the Plot Name column of the Data Table associated with the plot. In the UI, this is the text value listed below Name, on the right side of the top bar in the Plot Editor. Note: Use only when options.type is TimeSeriesChart, List, or SingleValue.' label: title: '`publish()` block label ' type: string description: "For the SignalFlow program in the programText property of a POST\nor PUT request\ \ body, label maps its publishLabelOptions parent\nobject properties to the plot from the publish()\ \ block that has the\nsame label in its label= argument.\nFor example, if the SignalFlow program\ \ contains the statement\nA = data('demo.trans.count').publish(label='A')\nand the POST request\ \ body for creating a chart contains\n\"options\": {\n ...\n \"publishLabelOptions\": {\n\ \ ...\n \"label\": \"A\"\n }\n}\n\nthen Splunk Observability Cloud applies the properties\ \ in the publishLabelOptions object\nto the plot displayed by the SignalFlow statement.\nNote:\ \ Use only when options.type property is\nList, TimeSeriesChart, or SingleValue;\notherwise,\ \ the API returns an HTTP response code 400." paletteIndex: title: Plot color 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 of the Charts API guide.' plotType: title: Plot-specific time series graph visualization enum: - LineChart - AreaChart - ColumnChart - Histogram description: 'Plot-specific override of the time series graph visualization you specify for the entire chart. plotType only applies to the SignalFlow statement that provides data for the plot. For example, if you create a chart with two SignalFlow statements, set options.type to TimeSeriesChart, and set defaultPlotType to LineChart, Splunk Observability Cloud displays a chart with two line plots. To change one of the plots to a bar chart, set publishLabelOptions.plotType for the SignalFlow publish() label of the plot to ColumnChart. The result is a chart with a line plot and a column plot. This property corresponds to the Visualization Type 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 the plot type is Heatmap or Text. For these types, the API returns an HTTP response code 400. If you only have one plot for the chart, so that the publishLabelOptions array has only one element, this property overrides the plot type for the entire chart. type: string' valuePrefix: title: String to prepend to values displayed in a plot type: string description: 'Specifies a string to prepend to values displayed in a single value or list plot, the data table for a plot, and the tooltip shown when you hover over a point on a plot. To learn more, see the example in the section Adding a prefix and/or suffix in the user documentation. Any value you set for options.publishLabelOptions[].valueUnit property overrides valuePrefix. This property corresponds to the Prefix text box that appears when you select Custom from the Display Units dropdown list 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. Note: Not available when the plot type is Text. The API returns an HTTP response code 400.' valueSuffix: title: String to append to values displayed in charts type: string 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 Adding a prefix and/or suffix in the user documentation. Any value you set for options.publishLabelOptions[].valueUnit property overrides valueSuffix. This property corresponds to the Suffix text box that appears when you select Custom from the Display Units dropdown list 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. Note: Not available when the plot type is Text. The API returns an HTTP response code 400.' valueUnit: title: Specifies the display units to use for chart values type: string 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 plot. Splunk Observability Cloud displays values based on the assumption that the raw data has the unit of measure you select. For example, the value 1000 in a plot where you''ve set options.publishLabelOptions[].valueUnit to bits appears as 1 Kilobit, and the value 1024 in a plot set to Bytes appears as 1 Kebibyte. Splunk Observability Cloud scales units within their own unit type. To learn more, see Displaying units and other labels. The options.publishLabelOptions[].valueUnit option applies to scaling and labeling in chart tooltips, axes, and data tables. options.publishLabelOptions[].valueUnit overrides options.publishLabelOptions[].valuePrefix and options.publishLabelOptions[].valueSuffix. The property value corresponds to one of the options that appear in Display Units dropdown list 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. Note: Not available when the plot type is Text. The API returns an HTTP response code 400.' yAxis: title: Y axis position for plot type: integer default: 0 minimum: 0 maximum: 1 description: 'Position of the Y-axis for the plot to which this publishLabelOptions object applies. If yAxis is 0, the axis appears on the left side. Otherwise it appears on the right. The default is 0 (left side). Note: Use only when options.type property is TimeSeriesChart, List, or SingleValue; otherwise, the API returns an HTTP response code 400.' required: - label description: Properties of a single plot in a chart description: 'List that specifies options for each plot displayed in the chart, in the form of an array of JSON objects. In this context, a plot is the publish() block output from a single statement in the SignalFlow program for the chart. To match a SignalFlow statement to an array element, Splunk Observability Cloud maps the value of the label argument for the publish() block to the value of a publishLabelOptions[].label property. Some publishLabelOptions child object properties aren''t supported for all plot types. Note: Not available when options.type is Text; the API returns an HTTP response code 400.' refreshInterval: title: Interval at which Splunk Observability Cloud should update the chart with new data type: integer format: int32 minimum: 0 description: 'How often, in milliseconds, that Splunk Observability Cloud should refresh 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: Use only when options.type property is List, TableChart, or SingleValue. Otherwise, the API returns an HTTP response code 400.' secondaryVisualization: title: Secondary visualization to use with the chart type: string enum: - None - Radial - Linear - Sparkline description: 'Secondary visualization to use with list or single value charts. See the section Secondary visualization for examples of the available visualizations. Note: Use only when options.type property is List or SingleValue. Otherwise, the API returns an HTTP response code 400.' showEventLines: title: Specifies what to show on a chart when an event occurs type: boolean default: false description: 'If true, Splunk Observability Cloud displays a vertical line on the chart at the point that an event occurs. Note: Use only when options.type property is TimeSeriesChart; otherwise, the API returns an HTTP response code 400.' 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 single value chart. Notes: Use only when optionstype property is SingleValue. Otherwise, the API returns an HTTP response code 400. The value specified for options.secondaryVisualization overrides options.showSparkLine.' sortBy: title: Specifies how to sort the entries in a time series chart or table chart type: string description: 'Specifies how to sort the entries in a time series chart or table chart. The first character of the value must be one of the following: Minus sign (-): Sets descending order for the data Plus sign (+): Sets ascending order for the data The rest of the characters specify the sort criteria: A keyword that represents a data points 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 Splunk Observability Cloud web UI. 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 chart for ascending order and to the end of the list for descending order. Note: Use only when options.type property is TimeSeriesChart or TableChart. Otherwise, the API returns an HTTP response code 400.' 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: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' 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: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' stacked: title: Controls the display of stacked plots in a graph type: boolean default: false description: 'Controls the display of stacked plots in a graph. If true, Splunk Observability Cloud stacks the plots 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. If options.defaultPlotType is ''AreaChart, Splunk Observability Cloud displays the plots as stacked areas. If defaultPlotTypeisColumn`, Splunk Observability Cloud displays the plots as stacked columns. Note: Use only when options.type property is TimeSeriesChart and options.defaultPlotType is AreaChart or Column. Otherwise, the API returns an HTTP response code 400.' time: title: Chart time display options type: object properties: end: title: Timestamp of the last time to display in the chart type: integer format: int64 example: 205430400000 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: Use only when options.type property is TimeSeriesChart and options.time.type is relative. Otherwise, the API returns an HTTP response code 400`.' start: title: Timestamp of the first time to display in the chart type: integer format: int64 example: 205344000000 description: 'The timestamp of the first time to display in the chart, in *nix time Note: Use only when options.type property is TimeSeriesChart and options.time.type is absolute. Otherwise, the API returns an HTTP response code 400.' type: title: Determines the type of time range to use type: string enum: - relative - absolute default: relative description: 'Determines whether to use an explicit time range or to show a range of the last n milliseconds. Note: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' description: 'Time-related properties for a chart, in the form of a JSON object. Note: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' timeStampHidden: title: Determines if the timestamp is shown with displayed values type: boolean default: false description: 'Determines if the timestamp displays with displayed values. If true, the timestamp for a value appears with the value in the chart. Note: Use only when options.type property is Heatmap, TableChart, or SingleValue. Otherwise, the API returns an HTTP response code 400.' type: title: Visualization type type: string enum: - Heatmap - List - SingleValue - TableChart - Text - TimeSeriesChart description: 'Type of visualization to use for the data. Splunk Observability Cloud provides six main visualization types: Heatmap: Displays data in a set of colored boxes. You can provide an optional order and grouping; otherwise, each box represents a metric time series in the output. The color of a box is determined by the value of the metric it represents. Splunk Observability Cloud provides default values, or you can specify your own custom ranges. List: Displays data as a list of metric time series. You can provide an additional secondary visualization as well. For example, you can display a sparkline for each row in the list. SingleValue: Displays a single value with a color that you specify. You can specify an additional visualization (secondary visualization) as well. For example, you can display a sparkline next to the value. TableChart: Displays metrics and dimensions in table format. Each metric name and dimension key displays as a column. Each output MTS displays as a row. If there are multiple values for a cell, each MTS displays in a separate row. Text: Displays text you provide. You can use Markdown to format the appearance of this text. TimeSeriesChart: Displays graphs of metric time series over time, using a graph type determined by the value of options.defaultPlotType or options.publishLabelOptions.plotType: LineChart: Displays data points as plot points connected by straight lines. In a graph that displays multiple metric time series, such as metric data points for several dimension values, Splunk Observability Cloud assigns a different color to each MTS. AreaChart: Similar to a LineChart, but the area between the line and the X-axis is filled with the color of the line. You can display multiple MTS as stacked area charts by setting options.stacked to true. Column: Displays each data points in an MTS as a colored vertical bar with the base on the X-axis and the top at the data points value. This type is also known as a bar chart. In a chart that displays multiple MTS, each data points for each MTS has its own bar and bar color, and the bars are clustered around the data points timestamp. You can display multiple MTS as stacked bars by setting options.stacked to true. Histogram: Colored bars that indicate the distribution of data points values at a point in time.' unitPrefix: title: Determines whether to use metric or binary units for chart values type: string enum: - Metric - Binary default: 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 any value of option.type except Text.' packageSpecifications: title: SignalFlow internal field type: string default: '' description: For internal use only. programText: title: Chart SignalFlow program type: string description: 'SignalFlow program that provides the chart data. If you use more than one line of SignalFlow, separate the lines with semicolons (;) or newline characters (\n). See Charts and SignalFlow. Note: Required only for charts with options.type of values Heatmap, List, SingleValue, TableChart, and TimeSeriesChart.' tags: title: Chart tags type: array items: type: string maxItems: 50 description: 'An array that contains tag values. You can 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.' examples: example: value: description: string name: string options: areaChartOptions: showDataMarkers: true axes: - highWatermark: 0 highWatermarkLabel: string label: string lowWatermark: 0 lowWatermarkLabel: string max: 0 min: 0 axisPrecision: 0 colorBy: Range 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: true legendOptions: fields: - enabled: true property: string lineChartOptions: showDataMarkers: true markdown: string maximumPrecision: 0 noDataOptions: linkText: Set up Splunk OpenTelemetry linkUrl: https://docs.splunk.com/Observability/gdi/opentelemetry/opentelemetry.html noDataMessage: No active hosts found onChartLegendOptions: dimensionInLegend: string showLegend: true programOptions: disableSampling: true maxDelay: 0 minimumResolution: 0 timezone: string publishLabelOptions: - displayName: string label: string paletteIndex: 0 plotType: LineChart valuePrefix: string valueSuffix: string valueUnit: Bit yAxis: 0 refreshInterval: 0 secondaryVisualization: None showEventLines: true showSparkLine: true sortBy: string sortDirection: Ascending sortProperty: string stacked: true time: end: 205430400000 range: 0 start: 205344000000 type: relative timeStampHidden: true type: Heatmap unitPrefix: Metric packageSpecifications: string programText: string tags: - string responses: '200': description: HTTP 200 response content: application/json: schema: type: object title: Response object for successful chart creation or update properties: created: title: Chart creation time type: integer format: int64 example: 1557534630000 readOnly: true description: 'The time the chart was created, in *nix time in milliseconds. This value is always set by the system.' creator: title: Chart Creator ID type: string readOnly: true description: ID of the user that initially created the chart customProperties: title: Custom properties type: object additionalProperties: true description: User-defined JSON object containing metadata description: title: Chart description type: string description: 'Extended text description of the chart. This text appears in the Chart description text box at the top of the New Chart screen in the UI.' id: title: Chart ID type: string readOnly: true description: System-defined identifier for the chart lastUpdated: title: Chart last updated time type: integer format: int64 example: 1557707430000 readOnly: true description: 'The last time the chart was updated, in *nix time in milliseconds. This value is always set by the system.' lastUpdatedBy: title: Chart last updated ID type: string readOnly: true description: 'The ID of the last person who updated the chart. If the last update was done by the system, the value is the string literal "AAAAAAAAAA".' name: title: Chart name (displayed) type: string description: 'Short chart name. In the UI, you enter the chart name in the Untitled Chart text box at the top of the New Chart screen.' options: type: object title: Chart options properties: areaChartOptions: title: Properties specific to area charts type: object properties: showDataMarkers: title: Controls the display of data markers for area charts type: boolean default: false description: 'If options.type is TimeSeriesChart and options.defaultPlotType property is AreaChart, then areaChartOptions.showDataMarkers controls the appearance of small dots in the chart indicating times at which data arrived. To show markers, set to true; otherwise, set to false. If you use options.areaChartOptions.showDataMarkers with any other values of options.type and options.defaultPlotType, the API returns an HTTP response code 400.' axes: title: Axes options type: array items: title: Chart axes options type: object properties: highWatermark: type: number format: float 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. The 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 description: 'A label that''s displayed beside the horizontal line indicating the high water mark. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. If options.axes.highWaterMark isn''t specified, this label is ignored.' label: type: string 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' lowWatermark: type: number format: float 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. 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 description: 'A label that''s displayed beside the horizontal line indicating the low water mark. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400`. If options.axes.lowWaterMark isn''t specified, the API ignores this label.' max: type: number format: float description: 'Specifies the largest data value to display on the chart. Overrides options.includeZero if the properties are set to incompatible values. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. The value must be greater than the value of options.axes.min for the same options.axes element.' min: type: number format: float description: 'Specifies the smallest data value to display on the chart. Overrides options.includeZero if the properties are set to incompatible values. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. The value must be less than the value of options.axes.max for the same options.axes element.' description: 'Axis options for the left and right side of a chart with options.type of TimeSeriesChart. The object in the first element specifies options for the left chart axis, and the object in the second element specifies options for the right chart axis. All other elements are ignored. Note: Use only when options.type is TimeSeriesChart; otherwise, the API returns an HTTP response code 400.' axisPrecision: title: 'Specifies the number of digits displayed for values plotted on the chart. ' type: integer minimum: 3 maximum: 10 default: 3 description: 'Specifies the digits Splunk Observability Cloud displays for values plotted on 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' colorBy: title: 'Mechanism by which color is applied to values in the chart. ' type: string enum: - Range - Scale - Dimension - 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 API returns an HTTP response code 400. 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: Heatmap color range options type: object properties: color: title: Starting color for a heatmap chart color range type: string minLength: 7 description: 'The starting color value for data values in a heatmap chart. Specify the value as a 6-character hexadecimal value preceded by the "#" character. 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. The UI limits you to hexadecimal values for the colors displayed in table 5 in the section Chart color palettes of the Charts API guide. Use the same values for API requests to keep your chart settings consistent with the UI.' max: title: 'Maximum color value assigned to a data value in the heatmap chart. ' type: string minLength: 7 description: 'The color value to associate with the largest incoming data value in the heatmap chart. To learn more about this property, see the description of options.colorRange.color.' 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 chart. To learn more about this property, see the description of options.colorRange.color.' description: 'Properties that specify the range of color values to use in a heatmap chart, in the form of a JSON object. The properties specify the lowest and highest color to use. options.colorScale controls how Splunk Observability Cloud sets each intermediate chart color within the range. Note: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' colorScale: title: 'Heatmap chart color range limits ' 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 you set this property to true, and you also set options.colorBy 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).' 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. Specify the values from lowest to highest. Data values that outside the specified partitions don''t appear in color, so you should set the first array value to correspond to the lowest expected data value. Similarly, set the last array value to correspond 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, in the form of a JSON object. The properties also control the order of colors in the color gradient. The properties in options.colorScale2 override any properties you specify here. Note: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' colorScale2: title: List of secondary visualization color 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: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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, inclusive ' type: number format: float description: 'The lower threshold of a color range, including the specified value itself. Notes: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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: 'Color range upper threshold, inclusive ' type: number format: float description: 'The upper threshold of a color range, including the specified value itself. Notes: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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 of the section Charts 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 of the section Charts color palettes. of the Charts API guide.' description: 'List of secondary visualization color properties, in the form of an array of JSON objects. Each object in the array specifies the information for a single color range, including the color to display for that range and the borders of the range. The array specifies the entire range displayed in the secondary visualization or heatmap chart. You don''t need to insert the elements in a specific order, because automatically orders them by the values in the display. The lowest value becomes the left border of the secondary visualization, and the highest value becomes the right border.' defaultPlotType: title: Specifies the visualization option to use for a graph type: string enum: - LineChart - AreaChart - ColumnChart - Histogram default: LineChart description: 'When you choose a graph chart type by setting options.type to TimeSeriesChart, options.defaultPlotType sets the visualization to use for plots in the chart: LineChart: A plot with data points connected by a series of straight lines. AreaChart: Similar to a LineChart, 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. Also known as a bar chart. Histogram: Colored bars that indicate the distribution of data points values at a point in time.' groupBy: title: 'Groups of histogram chart properties ' type: array items: type: string description: 'Specifies a list of custom properties to use in grouping values in a histogram chart, in the form of a JSON array of strings. Each element must contain a key specified in customProperties or a valid default custom property. The first element determines the top-level grouping, and the second element determines the second-level grouping within each first-level grouping. All other elements are ignored. The section Heatmap chart grouping in API topics shows a heatmap that charts CPU utilization, using AWS availability zone as the top-level grouping and number of host CPU cores as the second-level grouping. Note: Use only when options.type property is Heatmap or TableChart. Otherwise, the API returns an HTTP response code 400.' 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 of the Charts API guide. 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.' includeZero: title: Determines how 0 affects Y-axis values type: boolean default: false description: '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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' legendOptions: title: 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 table. Note: Use only when options.type property is TimeSeriesChart, TableChart, List, or SingleValue. Otherwise, the API returns an HTTP response code 400.' 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: 'A list of table settings for properties in the chart, in the form of a JSON array. Each element of the array is a JSON object that contains a chart property key name and a flag. If the flag is true, the chart property appears; otherwise, it''s hidden.' description: 'Sets options for the data table of a chart or a table chart, including which properties are omitted.' lineChartOptions: type: object title: Line graph options properties: showDataMarkers: title: Determines how to represent data points in the chart type: boolean default: false description: '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: 'Specifies options for a line graph chart Note: Use only when options.type property is TimeSeriesChart and options.defaultPlotType is LineChart. Otherwise, the API returns an HTTP response code 400.' markdown: title: Text chart contents type: string description: 'The contents of a text chart, using GitHub-Flavored Markdown (GFM) or HTML. Note: Use only when options.type property is Text. Otherwise, the API returns an HTTP response code 400.' maximumPrecision: title: Specifies the number of fractional digits used to display data type: integer minimum: 0 description: 'Indicates the number of significant digits to the right of the decimal point to use for data points. 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: Use only when options.type is List, TableChart, or SingleValue. Otherwise, the API returns an HTTP response code 400.' noDataOptions: title: User-defined message for when a chart has no active metrics properties: noDataMessage: title: Display message type: string example: No active hosts found description: Message to show in a chart when no active metric is available. Max length is 140 characters. linkUrl: title: URL to additional resource type: string example: https://docs.splunk.com/Observability/gdi/opentelemetry/opentelemetry.html description: URL that links to resource for additional information. linkText: title: Display text for the URL type: string example: Set up Splunk OpenTelemetry description: Display text for the URL that links to additional resource. Max length is 50 characters. description: 'Set up a message that appears when metrics used in a chart either don''t exist or are inactive. Use only when options.type is Heatmap, List, SingleValue, or TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. A metric is considered inactive by Splunk Observability Cloud in the following cases: The metric hasn''t received any data for 24 hours. The metric is tagged as ephemeral and hasn''t received any data for one hour. Note: A chart with inactive metrics is distinct from a chart with active metrics that doesn''t receive data. For example, a chart might not receive any data despite using active metrics if you use a filter on the chart that doesn''t match any data. On a chart with active metrics, the no active metrics message won''t appear even if the chart isn''t receiving any data. To learn more about why your message might not appear, see When your message doesn''t appear in Splunk Observability Cloud user documentation.' onChartLegendOptions: type: object title: Chart legend options properties: dimensionInLegend: title: Dimension to show in the legend type: string description: '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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' showLegend: title: Determines if a legend show display with the chart type: boolean default: false description: '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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' description: 'Properties that determine if Splunk Observability Cloud should display a legend, and if so, which dimension to show in the legend, in the form of a JSON object. Note: Use only when options.type is TimeSeriesChart, List, or SingleValue. Otherwise, the API returns an HTTP response code 400.' programOptions: title: General chart options type: object properties: disableSampling: title: Determines if the chart uses sampling type: boolean default: 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 any value of options.type except Text' maxDelay: title: Interval to wait before charting the available data type: integer format: int32 minimum: 0 maximum: 900000 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 any value of options.type except Text' minimumResolution: title: Minimum data resolution to use type: integer minimum: 0 maximum: 900000 description: '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 any value of options.type except Text' timezone: title: Time zone for SignalFlow calendar window transformations type: string default: UTC description: 'Time zone that SignalFlow uses as the basis of calendar window transformation methods. For example, if you set "timezone": "Europe/Paris" and then use the transformation sum(cycle="week", cycle_start="Monday") in the SignalFlow program for your chart, the calendar window starts on Monday, Paris time. To learn more, see Timezones and SignalFlow calendar window transformations.' description: 'Options that control the general appearance and operation of the chart, in the form of a JSON object. Note: Available for any value of options.type except Text' publishLabelOptions: title: SignalFlow statement options type: array items: type: object title: SignalFlow plot options properties: displayName: title: Alternate display name type: string description: 'Specifies an alternate value for the Plot Name column of the Data Table associated with the plot. In the UI, this is the text value listed below Name, on the right side of the top bar in the Plot Editor. Note: Use only when options.type is TimeSeriesChart, List, or SingleValue.' label: title: '`publish()` block label ' type: string description: "For the SignalFlow program in the programText property of a POST\nor PUT request\ \ body, label maps its publishLabelOptions parent\nobject properties to the plot from the\ \ publish() block that has the\nsame label in its label= argument.\nFor example, if the SignalFlow\ \ program contains the statement\nA = data('demo.trans.count').publish(label='A')\nand the\ \ POST request body for creating a chart contains\n\"options\": {\n ...\n \"publishLabelOptions\"\ : {\n ...\n \"label\": \"A\"\n }\n}\n\nthen Splunk Observability Cloud applies the\ \ properties in the publishLabelOptions object\nto the plot displayed by the SignalFlow statement.\n\ Note: Use only when options.type property is\nList, TimeSeriesChart, or SingleValue;\notherwise,\ \ the API returns an HTTP response code 400." paletteIndex: title: Plot color 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 of the Charts API guide.' plotType: title: Plot-specific time series graph visualization enum: - LineChart - AreaChart - ColumnChart - Histogram description: 'Plot-specific override of the time series graph visualization you specify for the entire chart. plotType only applies to the SignalFlow statement that provides data for the plot. For example, if you create a chart with two SignalFlow statements, set options.type to TimeSeriesChart, and set defaultPlotType to LineChart, Splunk Observability Cloud displays a chart with two line plots. To change one of the plots to a bar chart, set publishLabelOptions.plotType for the SignalFlow publish() label of the plot to ColumnChart. The result is a chart with a line plot and a column plot. This property corresponds to the Visualization Type 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 the plot type is Heatmap or Text. For these types, the API returns an HTTP response code 400. If you only have one plot for the chart, so that the publishLabelOptions array has only one element, this property overrides the plot type for the entire chart. type: string' valuePrefix: title: String to prepend to values displayed in a plot type: string description: 'Specifies a string to prepend to values displayed in a single value or list plot, the data table for a plot, and the tooltip shown when you hover over a point on a plot. To learn more, see the example in the section Adding a prefix and/or suffix in the user documentation. Any value you set for options.publishLabelOptions[].valueUnit property overrides valuePrefix. This property corresponds to the Prefix text box that appears when you select Custom from the Display Units dropdown list 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. Note: Not available when the plot type is Text. The API returns an HTTP response code 400.' valueSuffix: title: String to append to values displayed in charts type: string 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 Adding a prefix and/or suffix in the user documentation. Any value you set for options.publishLabelOptions[].valueUnit property overrides valueSuffix. This property corresponds to the Suffix text box that appears when you select Custom from the Display Units dropdown list 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. Note: Not available when the plot type is Text. The API returns an HTTP response code 400.' valueUnit: title: Specifies the display units to use for chart values type: string 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 plot. Splunk Observability Cloud displays values based on the assumption that the raw data has the unit of measure you select. For example, the value 1000 in a plot where you''ve set options.publishLabelOptions[].valueUnit to bits appears as 1 Kilobit, and the value 1024 in a plot set to Bytes appears as 1 Kebibyte. Splunk Observability Cloud scales units within their own unit type. To learn more, see Displaying units and other labels. The options.publishLabelOptions[].valueUnit option applies to scaling and labeling in chart tooltips, axes, and data tables. options.publishLabelOptions[].valueUnit overrides options.publishLabelOptions[].valuePrefix and options.publishLabelOptions[].valueSuffix. The property value corresponds to one of the options that appear in Display Units dropdown list 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. Note: Not available when the plot type is Text. The API returns an HTTP response code 400.' yAxis: title: Y axis position for plot type: integer default: 0 minimum: 0 maximum: 1 description: 'Position of the Y-axis for the plot to which this publishLabelOptions object applies. If yAxis is 0, the axis appears on the left side. Otherwise it appears on the right. The default is 0 (left side). Note: Use only when options.type property is TimeSeriesChart, List, or SingleValue; otherwise, the API returns an HTTP response code 400.' required: - label description: Properties of a single plot in a chart description: 'List that specifies options for each plot displayed in the chart, in the form of an array of JSON objects. In this context, a plot is the publish() block output from a single statement in the SignalFlow program for the chart. To match a SignalFlow statement to an array element, Splunk Observability Cloud maps the value of the label argument for the publish() block to the value of a publishLabelOptions[].label property. Some publishLabelOptions child object properties aren''t supported for all plot types. Note: Not available when options.type is Text; the API returns an HTTP response code 400.' refreshInterval: title: Interval at which Splunk Observability Cloud should update the chart with new data type: integer format: int32 minimum: 0 description: 'How often, in milliseconds, that Splunk Observability Cloud should refresh 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: Use only when options.type property is List, TableChart, or SingleValue. Otherwise, the API returns an HTTP response code 400.' secondaryVisualization: title: Secondary visualization to use with the chart type: string enum: - None - Radial - Linear - Sparkline description: 'Secondary visualization to use with list or single value charts. See the section Secondary visualization for examples of the available visualizations. Note: Use only when options.type property is List or SingleValue. Otherwise, the API returns an HTTP response code 400.' showEventLines: title: Specifies what to show on a chart when an event occurs type: boolean default: false description: 'If true, Splunk Observability Cloud displays a vertical line on the chart at the point that an event occurs. Note: Use only when options.type property is TimeSeriesChart; otherwise, the API returns an HTTP response code 400.' 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 single value chart. Notes: Use only when optionstype property is SingleValue. Otherwise, the API returns an HTTP response code 400. The value specified for options.secondaryVisualization overrides options.showSparkLine.' sortBy: title: Specifies how to sort the entries in a time series chart or table chart type: string description: 'Specifies how to sort the entries in a time series chart or table chart. The first character of the value must be one of the following: Minus sign (-): Sets descending order for the data Plus sign (+): Sets ascending order for the data The rest of the characters specify the sort criteria: A keyword that represents a data points 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 Splunk Observability Cloud web UI. 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 chart for ascending order and to the end of the list for descending order. Note: Use only when options.type property is TimeSeriesChart or TableChart. Otherwise, the API returns an HTTP response code 400.' 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: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' 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: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' stacked: title: Controls the display of stacked plots in a graph type: boolean default: false description: 'Controls the display of stacked plots in a graph. If true, Splunk Observability Cloud stacks the plots 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. If options.defaultPlotType is ''AreaChart, Splunk Observability Cloud displays the plots as stacked areas. If defaultPlotTypeisColumn`, Splunk Observability Cloud displays the plots as stacked columns. Note: Use only when options.type property is TimeSeriesChart and options.defaultPlotType is AreaChart or Column. Otherwise, the API returns an HTTP response code 400.' time: title: Chart time display options type: object properties: end: title: Timestamp of the last time to display in the chart type: integer format: int64 example: 205430400000 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: Use only when options.type property is TimeSeriesChart and options.time.type is relative. Otherwise, the API returns an HTTP response code 400`.' start: title: Timestamp of the first time to display in the chart type: integer format: int64 example: 205344000000 description: 'The timestamp of the first time to display in the chart, in *nix time Note: Use only when options.type property is TimeSeriesChart and options.time.type is absolute. Otherwise, the API returns an HTTP response code 400.' type: title: Determines the type of time range to use type: string enum: - relative - absolute default: relative description: 'Determines whether to use an explicit time range or to show a range of the last n milliseconds. Note: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' description: 'Time-related properties for a chart, in the form of a JSON object. Note: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' timeStampHidden: title: Determines if the timestamp is shown with displayed values type: boolean default: false description: 'Determines if the timestamp displays with displayed values. If true, the timestamp for a value appears with the value in the chart. Note: Use only when options.type property is Heatmap, TableChart, or SingleValue. Otherwise, the API returns an HTTP response code 400.' type: title: Visualization type type: string enum: - Heatmap - List - SingleValue - TableChart - Text - TimeSeriesChart description: 'Type of visualization to use for the data. Splunk Observability Cloud provides six main visualization types: Heatmap: Displays data in a set of colored boxes. You can provide an optional order and grouping; otherwise, each box represents a metric time series in the output. The color of a box is determined by the value of the metric it represents. Splunk Observability Cloud provides default values, or you can specify your own custom ranges. List: Displays data as a list of metric time series. You can provide an additional secondary visualization as well. For example, you can display a sparkline for each row in the list. SingleValue: Displays a single value with a color that you specify. You can specify an additional visualization (secondary visualization) as well. For example, you can display a sparkline next to the value. TableChart: Displays metrics and dimensions in table format. Each metric name and dimension key displays as a column. Each output MTS displays as a row. If there are multiple values for a cell, each MTS displays in a separate row. Text: Displays text you provide. You can use Markdown to format the appearance of this text. TimeSeriesChart: Displays graphs of metric time series over time, using a graph type determined by the value of options.defaultPlotType or options.publishLabelOptions.plotType: LineChart: Displays data points as plot points connected by straight lines. In a graph that displays multiple metric time series, such as metric data points for several dimension values, Splunk Observability Cloud assigns a different color to each MTS. AreaChart: Similar to a LineChart, but the area between the line and the X-axis is filled with the color of the line. You can display multiple MTS as stacked area charts by setting options.stacked to true. Column: Displays each data points in an MTS as a colored vertical bar with the base on the X-axis and the top at the data points value. This type is also known as a bar chart. In a chart that displays multiple MTS, each data points for each MTS has its own bar and bar color, and the bars are clustered around the data points timestamp. You can display multiple MTS as stacked bars by setting options.stacked to true. Histogram: Colored bars that indicate the distribution of data points values at a point in time.' unitPrefix: title: Determines whether to use metric or binary units for chart values type: string enum: - Metric - Binary default: 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 any value of option.type except Text.' packageSpecifications: title: SignalFlow internal field type: string default: '' description: For internal use only. programText: title: Chart SignalFlow program type: string description: 'SignalFlow program that provides the chart data. If you use more than one line of SignalFlow, separate the lines with semicolons (;) or newline characters (\n). See Charts and SignalFlow. Note: Required only for charts with options.type of values Heatmap, List, SingleValue, TableChart, and TimeSeriesChart.' tags: title: Chart tags type: array items: type: string maxItems: 50 description: 'An array that contains tag values. You can 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.' relatedDetectorIds: title: Detectors linked to this chart type: array items: type: string uniqueItems: true readOnly: true description: List of detectors linked to this chart, in the form of a JSON array. Each item is a unique ID of a linked detector. This list is read-only and is retrieved from programText. autoDetectRelatedDetectorIds: title: AutoDetect detectors linked to this chart type: array items: type: string uniqueItems: true readOnly: true description: List of AutoDetect and customized AutoDetect detectors linked to this chart, in the form of a JSON array. Each item is a unique ID of a linked AutoDetect or customized AutoDetect detector. This list is read-only and is retrieved from programText. examples: example: value: autoDetectRelatedDetectorIds: - string created: 1557534630000 creator: string description: string id: string lastUpdated: 1557707430000 lastUpdatedBy: string name: string options: areaChartOptions: showDataMarkers: true axes: - highWatermark: 0 highWatermarkLabel: string label: string lowWatermark: 0 lowWatermarkLabel: string max: 0 min: 0 axisPrecision: 0 colorBy: Range 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: true legendOptions: fields: - enabled: true property: string lineChartOptions: showDataMarkers: true markdown: string maximumPrecision: 0 noDataOptions: linkText: Set up Splunk OpenTelemetry linkUrl: https://docs.splunk.com/Observability/gdi/opentelemetry/opentelemetry.html noDataMessage: No active hosts found onChartLegendOptions: dimensionInLegend: string showLegend: true programOptions: disableSampling: true maxDelay: 0 minimumResolution: 0 timezone: string publishLabelOptions: - displayName: string label: string paletteIndex: 0 plotType: LineChart valuePrefix: string valueSuffix: string valueUnit: Bit yAxis: 0 refreshInterval: 0 secondaryVisualization: None showEventLines: true showSparkLine: true sortBy: string sortDirection: Ascending sortProperty: string stacked: true time: end: 205430400000 range: 0 start: 205344000000 type: relative timeStampHidden: true type: Heatmap unitPrefix: Metric packageSpecifications: string programText: string relatedDetectorIds: - string tags: - string security: - SessionToken: [] tags: - Charts /chart/{id}: get: summary: Get Chart Using Chart ID description: Retrieves the chart identified by the chart ID in the id path parameter parameters: - name: id in: path description: The ID of the chart you want to retrieve 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 title: Response object for retrieving a single chart by ID properties: created: title: Chart creation time type: integer format: int64 example: 1557534630000 readOnly: true description: 'The time the chart was created, in *nix time in milliseconds. This value is always set by the system.' creator: title: Chart Creator ID type: string readOnly: true description: ID of the user that initially created the chart customProperties: title: Custom properties type: object additionalProperties: true description: User-defined JSON object containing metadata description: title: Chart description type: string description: 'Extended text description of the chart. This text appears in the Chart description text box at the top of the New Chart screen in the UI.' id: title: Chart ID type: string readOnly: true description: System-defined identifier for the chart lastUpdated: title: Chart last updated time type: integer format: int64 example: 1557707430000 readOnly: true description: 'The last time the chart was updated, in *nix time in milliseconds. This value is always set by the system.' lastUpdatedBy: title: Chart last updated ID type: string readOnly: true description: 'The ID of the last person who updated the chart. If the last update was done by the system, the value is the string literal "AAAAAAAAAA".' name: title: Chart name (displayed) type: string description: 'Short chart name. In the UI, you enter the chart name in the Untitled Chart text box at the top of the New Chart screen.' options: type: object title: Chart options properties: areaChartOptions: title: Properties specific to area charts type: object properties: showDataMarkers: title: Controls the display of data markers for area charts type: boolean default: false description: 'If options.type is TimeSeriesChart and options.defaultPlotType property is AreaChart, then areaChartOptions.showDataMarkers controls the appearance of small dots in the chart indicating times at which data arrived. To show markers, set to true; otherwise, set to false. If you use options.areaChartOptions.showDataMarkers with any other values of options.type and options.defaultPlotType, the API returns an HTTP response code 400.' axes: title: Axes options type: array items: title: Chart axes options type: object properties: highWatermark: type: number format: float 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. The 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 description: 'A label that''s displayed beside the horizontal line indicating the high water mark. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. If options.axes.highWaterMark isn''t specified, this label is ignored.' label: type: string 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' lowWatermark: type: number format: float 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. 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 description: 'A label that''s displayed beside the horizontal line indicating the low water mark. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400`. If options.axes.lowWaterMark isn''t specified, the API ignores this label.' max: type: number format: float description: 'Specifies the largest data value to display on the chart. Overrides options.includeZero if the properties are set to incompatible values. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. The value must be greater than the value of options.axes.min for the same options.axes element.' min: type: number format: float description: 'Specifies the smallest data value to display on the chart. Overrides options.includeZero if the properties are set to incompatible values. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. The value must be less than the value of options.axes.max for the same options.axes element.' description: 'Axis options for the left and right side of a chart with options.type of TimeSeriesChart. The object in the first element specifies options for the left chart axis, and the object in the second element specifies options for the right chart axis. All other elements are ignored. Note: Use only when options.type is TimeSeriesChart; otherwise, the API returns an HTTP response code 400.' axisPrecision: title: 'Specifies the number of digits displayed for values plotted on the chart. ' type: integer minimum: 3 maximum: 10 default: 3 description: 'Specifies the digits Splunk Observability Cloud displays for values plotted on 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' colorBy: title: 'Mechanism by which color is applied to values in the chart. ' type: string enum: - Range - Scale - Dimension - 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 API returns an HTTP response code 400. 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: Heatmap color range options type: object properties: color: title: Starting color for a heatmap chart color range type: string minLength: 7 description: 'The starting color value for data values in a heatmap chart. Specify the value as a 6-character hexadecimal value preceded by the "#" character. 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. The UI limits you to hexadecimal values for the colors displayed in table 5 in the section Chart color palettes of the Charts API guide. Use the same values for API requests to keep your chart settings consistent with the UI.' max: title: 'Maximum color value assigned to a data value in the heatmap chart. ' type: string minLength: 7 description: 'The color value to associate with the largest incoming data value in the heatmap chart. To learn more about this property, see the description of options.colorRange.color.' 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 chart. To learn more about this property, see the description of options.colorRange.color.' description: 'Properties that specify the range of color values to use in a heatmap chart, in the form of a JSON object. The properties specify the lowest and highest color to use. options.colorScale controls how Splunk Observability Cloud sets each intermediate chart color within the range. Note: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' colorScale: title: 'Heatmap chart color range limits ' 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 you set this property to true, and you also set options.colorBy 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).' 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. Specify the values from lowest to highest. Data values that outside the specified partitions don''t appear in color, so you should set the first array value to correspond to the lowest expected data value. Similarly, set the last array value to correspond 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, in the form of a JSON object. The properties also control the order of colors in the color gradient. The properties in options.colorScale2 override any properties you specify here. Note: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' colorScale2: title: List of secondary visualization color 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: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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, inclusive ' type: number format: float description: 'The lower threshold of a color range, including the specified value itself. Notes: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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: 'Color range upper threshold, inclusive ' type: number format: float description: 'The upper threshold of a color range, including the specified value itself. Notes: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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 of the section Charts 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 of the section Charts color palettes. of the Charts API guide.' description: 'List of secondary visualization color properties, in the form of an array of JSON objects. Each object in the array specifies the information for a single color range, including the color to display for that range and the borders of the range. The array specifies the entire range displayed in the secondary visualization or heatmap chart. You don''t need to insert the elements in a specific order, because automatically orders them by the values in the display. The lowest value becomes the left border of the secondary visualization, and the highest value becomes the right border.' defaultPlotType: title: Specifies the visualization option to use for a graph type: string enum: - LineChart - AreaChart - ColumnChart - Histogram default: LineChart description: 'When you choose a graph chart type by setting options.type to TimeSeriesChart, options.defaultPlotType sets the visualization to use for plots in the chart: LineChart: A plot with data points connected by a series of straight lines. AreaChart: Similar to a LineChart, 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. Also known as a bar chart. Histogram: Colored bars that indicate the distribution of data points values at a point in time.' groupBy: title: 'Groups of histogram chart properties ' type: array items: type: string description: 'Specifies a list of custom properties to use in grouping values in a histogram chart, in the form of a JSON array of strings. Each element must contain a key specified in customProperties or a valid default custom property. The first element determines the top-level grouping, and the second element determines the second-level grouping within each first-level grouping. All other elements are ignored. The section Heatmap chart grouping in API topics shows a heatmap that charts CPU utilization, using AWS availability zone as the top-level grouping and number of host CPU cores as the second-level grouping. Note: Use only when options.type property is Heatmap or TableChart. Otherwise, the API returns an HTTP response code 400.' 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 of the Charts API guide. 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.' includeZero: title: Determines how 0 affects Y-axis values type: boolean default: false description: '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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' legendOptions: title: 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 table. Note: Use only when options.type property is TimeSeriesChart, TableChart, List, or SingleValue. Otherwise, the API returns an HTTP response code 400.' 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: 'A list of table settings for properties in the chart, in the form of a JSON array. Each element of the array is a JSON object that contains a chart property key name and a flag. If the flag is true, the chart property appears; otherwise, it''s hidden.' description: 'Sets options for the data table of a chart or a table chart, including which properties are omitted.' lineChartOptions: type: object title: Line graph options properties: showDataMarkers: title: Determines how to represent data points in the chart type: boolean default: false description: '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: 'Specifies options for a line graph chart Note: Use only when options.type property is TimeSeriesChart and options.defaultPlotType is LineChart. Otherwise, the API returns an HTTP response code 400.' markdown: title: Text chart contents type: string description: 'The contents of a text chart, using GitHub-Flavored Markdown (GFM) or HTML. Note: Use only when options.type property is Text. Otherwise, the API returns an HTTP response code 400.' maximumPrecision: title: Specifies the number of fractional digits used to display data type: integer minimum: 0 description: 'Indicates the number of significant digits to the right of the decimal point to use for data points. 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: Use only when options.type is List, TableChart, or SingleValue. Otherwise, the API returns an HTTP response code 400.' noDataOptions: title: User-defined message for when a chart has no active metrics properties: noDataMessage: title: Display message type: string example: No active hosts found description: Message to show in a chart when no active metric is available. Max length is 140 characters. linkUrl: title: URL to additional resource type: string example: https://docs.splunk.com/Observability/gdi/opentelemetry/opentelemetry.html description: URL that links to resource for additional information. linkText: title: Display text for the URL type: string example: Set up Splunk OpenTelemetry description: Display text for the URL that links to additional resource. Max length is 50 characters. description: 'Set up a message that appears when metrics used in a chart either don''t exist or are inactive. Use only when options.type is Heatmap, List, SingleValue, or TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. A metric is considered inactive by Splunk Observability Cloud in the following cases: The metric hasn''t received any data for 24 hours. The metric is tagged as ephemeral and hasn''t received any data for one hour. Note: A chart with inactive metrics is distinct from a chart with active metrics that doesn''t receive data. For example, a chart might not receive any data despite using active metrics if you use a filter on the chart that doesn''t match any data. On a chart with active metrics, the no active metrics message won''t appear even if the chart isn''t receiving any data. To learn more about why your message might not appear, see When your message doesn''t appear in Splunk Observability Cloud user documentation.' onChartLegendOptions: type: object title: Chart legend options properties: dimensionInLegend: title: Dimension to show in the legend type: string description: '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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' showLegend: title: Determines if a legend show display with the chart type: boolean default: false description: '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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' description: 'Properties that determine if Splunk Observability Cloud should display a legend, and if so, which dimension to show in the legend, in the form of a JSON object. Note: Use only when options.type is TimeSeriesChart, List, or SingleValue. Otherwise, the API returns an HTTP response code 400.' programOptions: title: General chart options type: object properties: disableSampling: title: Determines if the chart uses sampling type: boolean default: 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 any value of options.type except Text' maxDelay: title: Interval to wait before charting the available data type: integer format: int32 minimum: 0 maximum: 900000 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 any value of options.type except Text' minimumResolution: title: Minimum data resolution to use type: integer minimum: 0 maximum: 900000 description: '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 any value of options.type except Text' timezone: title: Time zone for SignalFlow calendar window transformations type: string default: UTC description: 'Time zone that SignalFlow uses as the basis of calendar window transformation methods. For example, if you set "timezone": "Europe/Paris" and then use the transformation sum(cycle="week", cycle_start="Monday") in the SignalFlow program for your chart, the calendar window starts on Monday, Paris time. To learn more, see Timezones and SignalFlow calendar window transformations.' description: 'Options that control the general appearance and operation of the chart, in the form of a JSON object. Note: Available for any value of options.type except Text' publishLabelOptions: title: SignalFlow statement options type: array items: type: object title: SignalFlow plot options properties: displayName: title: Alternate display name type: string description: 'Specifies an alternate value for the Plot Name column of the Data Table associated with the plot. In the UI, this is the text value listed below Name, on the right side of the top bar in the Plot Editor. Note: Use only when options.type is TimeSeriesChart, List, or SingleValue.' label: title: '`publish()` block label ' type: string description: "For the SignalFlow program in the programText property of a POST\nor PUT request\ \ body, label maps its publishLabelOptions parent\nobject properties to the plot from the\ \ publish() block that has the\nsame label in its label= argument.\nFor example, if the SignalFlow\ \ program contains the statement\nA = data('demo.trans.count').publish(label='A')\nand the\ \ POST request body for creating a chart contains\n\"options\": {\n ...\n \"publishLabelOptions\"\ : {\n ...\n \"label\": \"A\"\n }\n}\n\nthen Splunk Observability Cloud applies the\ \ properties in the publishLabelOptions object\nto the plot displayed by the SignalFlow statement.\n\ Note: Use only when options.type property is\nList, TimeSeriesChart, or SingleValue;\notherwise,\ \ the API returns an HTTP response code 400." paletteIndex: title: Plot color 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 of the Charts API guide.' plotType: title: Plot-specific time series graph visualization enum: - LineChart - AreaChart - ColumnChart - Histogram description: 'Plot-specific override of the time series graph visualization you specify for the entire chart. plotType only applies to the SignalFlow statement that provides data for the plot. For example, if you create a chart with two SignalFlow statements, set options.type to TimeSeriesChart, and set defaultPlotType to LineChart, Splunk Observability Cloud displays a chart with two line plots. To change one of the plots to a bar chart, set publishLabelOptions.plotType for the SignalFlow publish() label of the plot to ColumnChart. The result is a chart with a line plot and a column plot. This property corresponds to the Visualization Type 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 the plot type is Heatmap or Text. For these types, the API returns an HTTP response code 400. If you only have one plot for the chart, so that the publishLabelOptions array has only one element, this property overrides the plot type for the entire chart. type: string' valuePrefix: title: String to prepend to values displayed in a plot type: string description: 'Specifies a string to prepend to values displayed in a single value or list plot, the data table for a plot, and the tooltip shown when you hover over a point on a plot. To learn more, see the example in the section Adding a prefix and/or suffix in the user documentation. Any value you set for options.publishLabelOptions[].valueUnit property overrides valuePrefix. This property corresponds to the Prefix text box that appears when you select Custom from the Display Units dropdown list 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. Note: Not available when the plot type is Text. The API returns an HTTP response code 400.' valueSuffix: title: String to append to values displayed in charts type: string 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 Adding a prefix and/or suffix in the user documentation. Any value you set for options.publishLabelOptions[].valueUnit property overrides valueSuffix. This property corresponds to the Suffix text box that appears when you select Custom from the Display Units dropdown list 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. Note: Not available when the plot type is Text. The API returns an HTTP response code 400.' valueUnit: title: Specifies the display units to use for chart values type: string 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 plot. Splunk Observability Cloud displays values based on the assumption that the raw data has the unit of measure you select. For example, the value 1000 in a plot where you''ve set options.publishLabelOptions[].valueUnit to bits appears as 1 Kilobit, and the value 1024 in a plot set to Bytes appears as 1 Kebibyte. Splunk Observability Cloud scales units within their own unit type. To learn more, see Displaying units and other labels. The options.publishLabelOptions[].valueUnit option applies to scaling and labeling in chart tooltips, axes, and data tables. options.publishLabelOptions[].valueUnit overrides options.publishLabelOptions[].valuePrefix and options.publishLabelOptions[].valueSuffix. The property value corresponds to one of the options that appear in Display Units dropdown list 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. Note: Not available when the plot type is Text. The API returns an HTTP response code 400.' yAxis: title: Y axis position for plot type: integer default: 0 minimum: 0 maximum: 1 description: 'Position of the Y-axis for the plot to which this publishLabelOptions object applies. If yAxis is 0, the axis appears on the left side. Otherwise it appears on the right. The default is 0 (left side). Note: Use only when options.type property is TimeSeriesChart, List, or SingleValue; otherwise, the API returns an HTTP response code 400.' required: - label description: Properties of a single plot in a chart description: 'List that specifies options for each plot displayed in the chart, in the form of an array of JSON objects. In this context, a plot is the publish() block output from a single statement in the SignalFlow program for the chart. To match a SignalFlow statement to an array element, Splunk Observability Cloud maps the value of the label argument for the publish() block to the value of a publishLabelOptions[].label property. Some publishLabelOptions child object properties aren''t supported for all plot types. Note: Not available when options.type is Text; the API returns an HTTP response code 400.' refreshInterval: title: Interval at which Splunk Observability Cloud should update the chart with new data type: integer format: int32 minimum: 0 description: 'How often, in milliseconds, that Splunk Observability Cloud should refresh 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: Use only when options.type property is List, TableChart, or SingleValue. Otherwise, the API returns an HTTP response code 400.' secondaryVisualization: title: Secondary visualization to use with the chart type: string enum: - None - Radial - Linear - Sparkline description: 'Secondary visualization to use with list or single value charts. See the section Secondary visualization for examples of the available visualizations. Note: Use only when options.type property is List or SingleValue. Otherwise, the API returns an HTTP response code 400.' showEventLines: title: Specifies what to show on a chart when an event occurs type: boolean default: false description: 'If true, Splunk Observability Cloud displays a vertical line on the chart at the point that an event occurs. Note: Use only when options.type property is TimeSeriesChart; otherwise, the API returns an HTTP response code 400.' 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 single value chart. Notes: Use only when optionstype property is SingleValue. Otherwise, the API returns an HTTP response code 400. The value specified for options.secondaryVisualization overrides options.showSparkLine.' sortBy: title: Specifies how to sort the entries in a time series chart or table chart type: string description: 'Specifies how to sort the entries in a time series chart or table chart. The first character of the value must be one of the following: Minus sign (-): Sets descending order for the data Plus sign (+): Sets ascending order for the data The rest of the characters specify the sort criteria: A keyword that represents a data points 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 Splunk Observability Cloud web UI. 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 chart for ascending order and to the end of the list for descending order. Note: Use only when options.type property is TimeSeriesChart or TableChart. Otherwise, the API returns an HTTP response code 400.' 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: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' 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: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' stacked: title: Controls the display of stacked plots in a graph type: boolean default: false description: 'Controls the display of stacked plots in a graph. If true, Splunk Observability Cloud stacks the plots 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. If options.defaultPlotType is ''AreaChart, Splunk Observability Cloud displays the plots as stacked areas. If defaultPlotTypeisColumn`, Splunk Observability Cloud displays the plots as stacked columns. Note: Use only when options.type property is TimeSeriesChart and options.defaultPlotType is AreaChart or Column. Otherwise, the API returns an HTTP response code 400.' time: title: Chart time display options type: object properties: end: title: Timestamp of the last time to display in the chart type: integer format: int64 example: 205430400000 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: Use only when options.type property is TimeSeriesChart and options.time.type is relative. Otherwise, the API returns an HTTP response code 400`.' start: title: Timestamp of the first time to display in the chart type: integer format: int64 example: 205344000000 description: 'The timestamp of the first time to display in the chart, in *nix time Note: Use only when options.type property is TimeSeriesChart and options.time.type is absolute. Otherwise, the API returns an HTTP response code 400.' type: title: Determines the type of time range to use type: string enum: - relative - absolute default: relative description: 'Determines whether to use an explicit time range or to show a range of the last n milliseconds. Note: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' description: 'Time-related properties for a chart, in the form of a JSON object. Note: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' timeStampHidden: title: Determines if the timestamp is shown with displayed values type: boolean default: false description: 'Determines if the timestamp displays with displayed values. If true, the timestamp for a value appears with the value in the chart. Note: Use only when options.type property is Heatmap, TableChart, or SingleValue. Otherwise, the API returns an HTTP response code 400.' type: title: Visualization type type: string enum: - Heatmap - List - SingleValue - TableChart - Text - TimeSeriesChart description: 'Type of visualization to use for the data. Splunk Observability Cloud provides six main visualization types: Heatmap: Displays data in a set of colored boxes. You can provide an optional order and grouping; otherwise, each box represents a metric time series in the output. The color of a box is determined by the value of the metric it represents. Splunk Observability Cloud provides default values, or you can specify your own custom ranges. List: Displays data as a list of metric time series. You can provide an additional secondary visualization as well. For example, you can display a sparkline for each row in the list. SingleValue: Displays a single value with a color that you specify. You can specify an additional visualization (secondary visualization) as well. For example, you can display a sparkline next to the value. TableChart: Displays metrics and dimensions in table format. Each metric name and dimension key displays as a column. Each output MTS displays as a row. If there are multiple values for a cell, each MTS displays in a separate row. Text: Displays text you provide. You can use Markdown to format the appearance of this text. TimeSeriesChart: Displays graphs of metric time series over time, using a graph type determined by the value of options.defaultPlotType or options.publishLabelOptions.plotType: LineChart: Displays data points as plot points connected by straight lines. In a graph that displays multiple metric time series, such as metric data points for several dimension values, Splunk Observability Cloud assigns a different color to each MTS. AreaChart: Similar to a LineChart, but the area between the line and the X-axis is filled with the color of the line. You can display multiple MTS as stacked area charts by setting options.stacked to true. Column: Displays each data points in an MTS as a colored vertical bar with the base on the X-axis and the top at the data points value. This type is also known as a bar chart. In a chart that displays multiple MTS, each data points for each MTS has its own bar and bar color, and the bars are clustered around the data points timestamp. You can display multiple MTS as stacked bars by setting options.stacked to true. Histogram: Colored bars that indicate the distribution of data points values at a point in time.' unitPrefix: title: Determines whether to use metric or binary units for chart values type: string enum: - Metric - Binary default: 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 any value of option.type except Text.' packageSpecifications: title: SignalFlow internal field type: string default: '' description: For internal use only. programText: title: Chart SignalFlow program type: string description: 'SignalFlow program that provides the chart data. If you use more than one line of SignalFlow, separate the lines with semicolons (;) or newline characters (\n). See Charts and SignalFlow. Note: Required only for charts with options.type of values Heatmap, List, SingleValue, TableChart, and TimeSeriesChart.' tags: title: Chart tags type: array items: type: string maxItems: 50 description: 'An array that contains tag values. You can 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.' relatedDetectorIds: title: Detectors linked to this chart type: array items: type: string uniqueItems: true readOnly: true description: List of detectors linked to this chart, in the form of a JSON array. Each item is a unique ID of a linked detector. This list is read-only and is retrieved from programText. autoDetectRelatedDetectorIds: title: AutoDetect detectors linked to this chart type: array items: type: string uniqueItems: true readOnly: true description: List of AutoDetect and customized AutoDetect detectors linked to this chart, in the form of a JSON array. Each item is a unique ID of a linked AutoDetect or customized AutoDetect detector. This list is read-only and is retrieved from programText. examples: example: value: autoDetectRelatedDetectorIds: - string created: 1557534630000 creator: string description: string id: string lastUpdated: 1557707430000 lastUpdatedBy: string name: string options: areaChartOptions: showDataMarkers: true axes: - highWatermark: 0 highWatermarkLabel: string label: string lowWatermark: 0 lowWatermarkLabel: string max: 0 min: 0 axisPrecision: 0 colorBy: Range 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: true legendOptions: fields: - enabled: true property: string lineChartOptions: showDataMarkers: true markdown: string maximumPrecision: 0 noDataOptions: linkText: Set up Splunk OpenTelemetry linkUrl: https://docs.splunk.com/Observability/gdi/opentelemetry/opentelemetry.html noDataMessage: No active hosts found onChartLegendOptions: dimensionInLegend: string showLegend: true programOptions: disableSampling: true maxDelay: 0 minimumResolution: 0 timezone: string publishLabelOptions: - displayName: string label: string paletteIndex: 0 plotType: LineChart valuePrefix: string valueSuffix: string valueUnit: Bit yAxis: 0 refreshInterval: 0 secondaryVisualization: None showEventLines: true showSparkLine: true sortBy: string sortDirection: Ascending sortProperty: string stacked: true time: end: 205430400000 range: 0 start: 205344000000 type: relative timeStampHidden: true type: Heatmap unitPrefix: Metric packageSpecifications: string programText: string relatedDetectorIds: - string tags: - string security: - SessionToken: [] tags: - Charts put: summary: Update Single Chart description: 'Updates the chart identified by the chart ID in the id path parameter. If you don''t include a property in the request body, the API removes it from the chart or resets it to its default state. Notes: If you change the chart type in options.type, the API removes properties that don''t apply to the new chart type. If you change the chart to a new type, then change it back to its original type, you don''t have access to the previous type-specific values, so you have to specify them again.' parameters: - name: id in: path description: The ID of the chart you want to update required: true schema: type: string - name: Content-Type in: header 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: title: Properties for creating or updating a chart type: object properties: customProperties: title: Custom properties type: object additionalProperties: true description: User-defined JSON object containing metadata description: title: Chart description type: string description: 'Extended text description of the chart. This text appears in the Chart description text box at the top of the New Chart screen in the UI.' name: title: Chart name (displayed) type: string description: 'Short chart name. In the UI, you enter the chart name in the Untitled Chart text box at the top of the New Chart screen.' options: type: object title: Chart options properties: areaChartOptions: title: Properties specific to area charts type: object properties: showDataMarkers: title: Controls the display of data markers for area charts type: boolean default: false description: 'If options.type is TimeSeriesChart and options.defaultPlotType property is AreaChart, then areaChartOptions.showDataMarkers controls the appearance of small dots in the chart indicating times at which data arrived. To show markers, set to true; otherwise, set to false. If you use options.areaChartOptions.showDataMarkers with any other values of options.type and options.defaultPlotType, the API returns an HTTP response code 400.' axes: title: Axes options type: array items: title: Chart axes options type: object properties: highWatermark: type: number format: float 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. The 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 description: 'A label that''s displayed beside the horizontal line indicating the high water mark. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. If options.axes.highWaterMark isn''t specified, this label is ignored.' label: type: string 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' lowWatermark: type: number format: float 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. 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 description: 'A label that''s displayed beside the horizontal line indicating the low water mark. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400`. If options.axes.lowWaterMark isn''t specified, the API ignores this label.' max: type: number format: float description: 'Specifies the largest data value to display on the chart. Overrides options.includeZero if the properties are set to incompatible values. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. The value must be greater than the value of options.axes.min for the same options.axes element.' min: type: number format: float description: 'Specifies the smallest data value to display on the chart. Overrides options.includeZero if the properties are set to incompatible values. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. The value must be less than the value of options.axes.max for the same options.axes element.' description: 'Axis options for the left and right side of a chart with options.type of TimeSeriesChart. The object in the first element specifies options for the left chart axis, and the object in the second element specifies options for the right chart axis. All other elements are ignored. Note: Use only when options.type is TimeSeriesChart; otherwise, the API returns an HTTP response code 400.' axisPrecision: title: 'Specifies the number of digits displayed for values plotted on the chart. ' type: integer minimum: 3 maximum: 10 default: 3 description: 'Specifies the digits Splunk Observability Cloud displays for values plotted on 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' colorBy: title: 'Mechanism by which color is applied to values in the chart. ' type: string enum: - Range - Scale - Dimension - 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 API returns an HTTP response code 400. 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: Heatmap color range options type: object properties: color: title: Starting color for a heatmap chart color range type: string minLength: 7 description: 'The starting color value for data values in a heatmap chart. Specify the value as a 6-character hexadecimal value preceded by the "#" character. 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. The UI limits you to hexadecimal values for the colors displayed in table 5 in the section Chart color palettes of the Charts API guide. Use the same values for API requests to keep your chart settings consistent with the UI.' max: title: 'Maximum color value assigned to a data value in the heatmap chart. ' type: string minLength: 7 description: 'The color value to associate with the largest incoming data value in the heatmap chart. To learn more about this property, see the description of options.colorRange.color.' 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 chart. To learn more about this property, see the description of options.colorRange.color.' description: 'Properties that specify the range of color values to use in a heatmap chart, in the form of a JSON object. The properties specify the lowest and highest color to use. options.colorScale controls how Splunk Observability Cloud sets each intermediate chart color within the range. Note: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' colorScale: title: 'Heatmap chart color range limits ' 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 you set this property to true, and you also set options.colorBy 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).' 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. Specify the values from lowest to highest. Data values that outside the specified partitions don''t appear in color, so you should set the first array value to correspond to the lowest expected data value. Similarly, set the last array value to correspond 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, in the form of a JSON object. The properties also control the order of colors in the color gradient. The properties in options.colorScale2 override any properties you specify here. Note: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' colorScale2: title: List of secondary visualization color 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: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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, inclusive ' type: number format: float description: 'The lower threshold of a color range, including the specified value itself. Notes: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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: 'Color range upper threshold, inclusive ' type: number format: float description: 'The upper threshold of a color range, including the specified value itself. Notes: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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 of the section Charts 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 of the section Charts color palettes. of the Charts API guide.' description: 'List of secondary visualization color properties, in the form of an array of JSON objects. Each object in the array specifies the information for a single color range, including the color to display for that range and the borders of the range. The array specifies the entire range displayed in the secondary visualization or heatmap chart. You don''t need to insert the elements in a specific order, because automatically orders them by the values in the display. The lowest value becomes the left border of the secondary visualization, and the highest value becomes the right border.' defaultPlotType: title: Specifies the visualization option to use for a graph type: string enum: - LineChart - AreaChart - ColumnChart - Histogram default: LineChart description: 'When you choose a graph chart type by setting options.type to TimeSeriesChart, options.defaultPlotType sets the visualization to use for plots in the chart: LineChart: A plot with data points connected by a series of straight lines. AreaChart: Similar to a LineChart, 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. Also known as a bar chart. Histogram: Colored bars that indicate the distribution of data points values at a point in time.' groupBy: title: 'Groups of histogram chart properties ' type: array items: type: string description: 'Specifies a list of custom properties to use in grouping values in a histogram chart, in the form of a JSON array of strings. Each element must contain a key specified in customProperties or a valid default custom property. The first element determines the top-level grouping, and the second element determines the second-level grouping within each first-level grouping. All other elements are ignored. The section Heatmap chart grouping in API topics shows a heatmap that charts CPU utilization, using AWS availability zone as the top-level grouping and number of host CPU cores as the second-level grouping. Note: Use only when options.type property is Heatmap or TableChart. Otherwise, the API returns an HTTP response code 400.' 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 of the Charts API guide. 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.' includeZero: title: Determines how 0 affects Y-axis values type: boolean default: false description: '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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' legendOptions: title: 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 table. Note: Use only when options.type property is TimeSeriesChart, TableChart, List, or SingleValue. Otherwise, the API returns an HTTP response code 400.' 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: 'A list of table settings for properties in the chart, in the form of a JSON array. Each element of the array is a JSON object that contains a chart property key name and a flag. If the flag is true, the chart property appears; otherwise, it''s hidden.' description: 'Sets options for the data table of a chart or a table chart, including which properties are omitted.' lineChartOptions: type: object title: Line graph options properties: showDataMarkers: title: Determines how to represent data points in the chart type: boolean default: false description: '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: 'Specifies options for a line graph chart Note: Use only when options.type property is TimeSeriesChart and options.defaultPlotType is LineChart. Otherwise, the API returns an HTTP response code 400.' markdown: title: Text chart contents type: string description: 'The contents of a text chart, using GitHub-Flavored Markdown (GFM) or HTML. Note: Use only when options.type property is Text. Otherwise, the API returns an HTTP response code 400.' maximumPrecision: title: Specifies the number of fractional digits used to display data type: integer minimum: 0 description: 'Indicates the number of significant digits to the right of the decimal point to use for data points. 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: Use only when options.type is List, TableChart, or SingleValue. Otherwise, the API returns an HTTP response code 400.' noDataOptions: title: User-defined message for when a chart has no active metrics properties: noDataMessage: title: Display message type: string example: No active hosts found description: Message to show in a chart when no active metric is available. Max length is 140 characters. linkUrl: title: URL to additional resource type: string example: https://docs.splunk.com/Observability/gdi/opentelemetry/opentelemetry.html description: URL that links to resource for additional information. linkText: title: Display text for the URL type: string example: Set up Splunk OpenTelemetry description: Display text for the URL that links to additional resource. Max length is 50 characters. description: 'Set up a message that appears when metrics used in a chart either don''t exist or are inactive. Use only when options.type is Heatmap, List, SingleValue, or TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. A metric is considered inactive by Splunk Observability Cloud in the following cases: The metric hasn''t received any data for 24 hours. The metric is tagged as ephemeral and hasn''t received any data for one hour. Note: A chart with inactive metrics is distinct from a chart with active metrics that doesn''t receive data. For example, a chart might not receive any data despite using active metrics if you use a filter on the chart that doesn''t match any data. On a chart with active metrics, the no active metrics message won''t appear even if the chart isn''t receiving any data. To learn more about why your message might not appear, see When your message doesn''t appear in Splunk Observability Cloud user documentation.' onChartLegendOptions: type: object title: Chart legend options properties: dimensionInLegend: title: Dimension to show in the legend type: string description: '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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' showLegend: title: Determines if a legend show display with the chart type: boolean default: false description: '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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' description: 'Properties that determine if Splunk Observability Cloud should display a legend, and if so, which dimension to show in the legend, in the form of a JSON object. Note: Use only when options.type is TimeSeriesChart, List, or SingleValue. Otherwise, the API returns an HTTP response code 400.' programOptions: title: General chart options type: object properties: disableSampling: title: Determines if the chart uses sampling type: boolean default: 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 any value of options.type except Text' maxDelay: title: Interval to wait before charting the available data type: integer format: int32 minimum: 0 maximum: 900000 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 any value of options.type except Text' minimumResolution: title: Minimum data resolution to use type: integer minimum: 0 maximum: 900000 description: '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 any value of options.type except Text' timezone: title: Time zone for SignalFlow calendar window transformations type: string default: UTC description: 'Time zone that SignalFlow uses as the basis of calendar window transformation methods. For example, if you set "timezone": "Europe/Paris" and then use the transformation sum(cycle="week", cycle_start="Monday") in the SignalFlow program for your chart, the calendar window starts on Monday, Paris time. To learn more, see Timezones and SignalFlow calendar window transformations.' description: 'Options that control the general appearance and operation of the chart, in the form of a JSON object. Note: Available for any value of options.type except Text' publishLabelOptions: title: SignalFlow statement options type: array items: type: object title: SignalFlow plot options properties: displayName: title: Alternate display name type: string description: 'Specifies an alternate value for the Plot Name column of the Data Table associated with the plot. In the UI, this is the text value listed below Name, on the right side of the top bar in the Plot Editor. Note: Use only when options.type is TimeSeriesChart, List, or SingleValue.' label: title: '`publish()` block label ' type: string description: "For the SignalFlow program in the programText property of a POST\nor PUT request\ \ body, label maps its publishLabelOptions parent\nobject properties to the plot from the publish()\ \ block that has the\nsame label in its label= argument.\nFor example, if the SignalFlow program\ \ contains the statement\nA = data('demo.trans.count').publish(label='A')\nand the POST request\ \ body for creating a chart contains\n\"options\": {\n ...\n \"publishLabelOptions\": {\n\ \ ...\n \"label\": \"A\"\n }\n}\n\nthen Splunk Observability Cloud applies the properties\ \ in the publishLabelOptions object\nto the plot displayed by the SignalFlow statement.\nNote:\ \ Use only when options.type property is\nList, TimeSeriesChart, or SingleValue;\notherwise,\ \ the API returns an HTTP response code 400." paletteIndex: title: Plot color 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 of the Charts API guide.' plotType: title: Plot-specific time series graph visualization enum: - LineChart - AreaChart - ColumnChart - Histogram description: 'Plot-specific override of the time series graph visualization you specify for the entire chart. plotType only applies to the SignalFlow statement that provides data for the plot. For example, if you create a chart with two SignalFlow statements, set options.type to TimeSeriesChart, and set defaultPlotType to LineChart, Splunk Observability Cloud displays a chart with two line plots. To change one of the plots to a bar chart, set publishLabelOptions.plotType for the SignalFlow publish() label of the plot to ColumnChart. The result is a chart with a line plot and a column plot. This property corresponds to the Visualization Type 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 the plot type is Heatmap or Text. For these types, the API returns an HTTP response code 400. If you only have one plot for the chart, so that the publishLabelOptions array has only one element, this property overrides the plot type for the entire chart. type: string' valuePrefix: title: String to prepend to values displayed in a plot type: string description: 'Specifies a string to prepend to values displayed in a single value or list plot, the data table for a plot, and the tooltip shown when you hover over a point on a plot. To learn more, see the example in the section Adding a prefix and/or suffix in the user documentation. Any value you set for options.publishLabelOptions[].valueUnit property overrides valuePrefix. This property corresponds to the Prefix text box that appears when you select Custom from the Display Units dropdown list 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. Note: Not available when the plot type is Text. The API returns an HTTP response code 400.' valueSuffix: title: String to append to values displayed in charts type: string 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 Adding a prefix and/or suffix in the user documentation. Any value you set for options.publishLabelOptions[].valueUnit property overrides valueSuffix. This property corresponds to the Suffix text box that appears when you select Custom from the Display Units dropdown list 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. Note: Not available when the plot type is Text. The API returns an HTTP response code 400.' valueUnit: title: Specifies the display units to use for chart values type: string 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 plot. Splunk Observability Cloud displays values based on the assumption that the raw data has the unit of measure you select. For example, the value 1000 in a plot where you''ve set options.publishLabelOptions[].valueUnit to bits appears as 1 Kilobit, and the value 1024 in a plot set to Bytes appears as 1 Kebibyte. Splunk Observability Cloud scales units within their own unit type. To learn more, see Displaying units and other labels. The options.publishLabelOptions[].valueUnit option applies to scaling and labeling in chart tooltips, axes, and data tables. options.publishLabelOptions[].valueUnit overrides options.publishLabelOptions[].valuePrefix and options.publishLabelOptions[].valueSuffix. The property value corresponds to one of the options that appear in Display Units dropdown list 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. Note: Not available when the plot type is Text. The API returns an HTTP response code 400.' yAxis: title: Y axis position for plot type: integer default: 0 minimum: 0 maximum: 1 description: 'Position of the Y-axis for the plot to which this publishLabelOptions object applies. If yAxis is 0, the axis appears on the left side. Otherwise it appears on the right. The default is 0 (left side). Note: Use only when options.type property is TimeSeriesChart, List, or SingleValue; otherwise, the API returns an HTTP response code 400.' required: - label description: Properties of a single plot in a chart description: 'List that specifies options for each plot displayed in the chart, in the form of an array of JSON objects. In this context, a plot is the publish() block output from a single statement in the SignalFlow program for the chart. To match a SignalFlow statement to an array element, Splunk Observability Cloud maps the value of the label argument for the publish() block to the value of a publishLabelOptions[].label property. Some publishLabelOptions child object properties aren''t supported for all plot types. Note: Not available when options.type is Text; the API returns an HTTP response code 400.' refreshInterval: title: Interval at which Splunk Observability Cloud should update the chart with new data type: integer format: int32 minimum: 0 description: 'How often, in milliseconds, that Splunk Observability Cloud should refresh 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: Use only when options.type property is List, TableChart, or SingleValue. Otherwise, the API returns an HTTP response code 400.' secondaryVisualization: title: Secondary visualization to use with the chart type: string enum: - None - Radial - Linear - Sparkline description: 'Secondary visualization to use with list or single value charts. See the section Secondary visualization for examples of the available visualizations. Note: Use only when options.type property is List or SingleValue. Otherwise, the API returns an HTTP response code 400.' showEventLines: title: Specifies what to show on a chart when an event occurs type: boolean default: false description: 'If true, Splunk Observability Cloud displays a vertical line on the chart at the point that an event occurs. Note: Use only when options.type property is TimeSeriesChart; otherwise, the API returns an HTTP response code 400.' 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 single value chart. Notes: Use only when optionstype property is SingleValue. Otherwise, the API returns an HTTP response code 400. The value specified for options.secondaryVisualization overrides options.showSparkLine.' sortBy: title: Specifies how to sort the entries in a time series chart or table chart type: string description: 'Specifies how to sort the entries in a time series chart or table chart. The first character of the value must be one of the following: Minus sign (-): Sets descending order for the data Plus sign (+): Sets ascending order for the data The rest of the characters specify the sort criteria: A keyword that represents a data points 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 Splunk Observability Cloud web UI. 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 chart for ascending order and to the end of the list for descending order. Note: Use only when options.type property is TimeSeriesChart or TableChart. Otherwise, the API returns an HTTP response code 400.' 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: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' 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: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' stacked: title: Controls the display of stacked plots in a graph type: boolean default: false description: 'Controls the display of stacked plots in a graph. If true, Splunk Observability Cloud stacks the plots 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. If options.defaultPlotType is ''AreaChart, Splunk Observability Cloud displays the plots as stacked areas. If defaultPlotTypeisColumn`, Splunk Observability Cloud displays the plots as stacked columns. Note: Use only when options.type property is TimeSeriesChart and options.defaultPlotType is AreaChart or Column. Otherwise, the API returns an HTTP response code 400.' time: title: Chart time display options type: object properties: end: title: Timestamp of the last time to display in the chart type: integer format: int64 example: 205430400000 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: Use only when options.type property is TimeSeriesChart and options.time.type is relative. Otherwise, the API returns an HTTP response code 400`.' start: title: Timestamp of the first time to display in the chart type: integer format: int64 example: 205344000000 description: 'The timestamp of the first time to display in the chart, in *nix time Note: Use only when options.type property is TimeSeriesChart and options.time.type is absolute. Otherwise, the API returns an HTTP response code 400.' type: title: Determines the type of time range to use type: string enum: - relative - absolute default: relative description: 'Determines whether to use an explicit time range or to show a range of the last n milliseconds. Note: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' description: 'Time-related properties for a chart, in the form of a JSON object. Note: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' timeStampHidden: title: Determines if the timestamp is shown with displayed values type: boolean default: false description: 'Determines if the timestamp displays with displayed values. If true, the timestamp for a value appears with the value in the chart. Note: Use only when options.type property is Heatmap, TableChart, or SingleValue. Otherwise, the API returns an HTTP response code 400.' type: title: Visualization type type: string enum: - Heatmap - List - SingleValue - TableChart - Text - TimeSeriesChart description: 'Type of visualization to use for the data. Splunk Observability Cloud provides six main visualization types: Heatmap: Displays data in a set of colored boxes. You can provide an optional order and grouping; otherwise, each box represents a metric time series in the output. The color of a box is determined by the value of the metric it represents. Splunk Observability Cloud provides default values, or you can specify your own custom ranges. List: Displays data as a list of metric time series. You can provide an additional secondary visualization as well. For example, you can display a sparkline for each row in the list. SingleValue: Displays a single value with a color that you specify. You can specify an additional visualization (secondary visualization) as well. For example, you can display a sparkline next to the value. TableChart: Displays metrics and dimensions in table format. Each metric name and dimension key displays as a column. Each output MTS displays as a row. If there are multiple values for a cell, each MTS displays in a separate row. Text: Displays text you provide. You can use Markdown to format the appearance of this text. TimeSeriesChart: Displays graphs of metric time series over time, using a graph type determined by the value of options.defaultPlotType or options.publishLabelOptions.plotType: LineChart: Displays data points as plot points connected by straight lines. In a graph that displays multiple metric time series, such as metric data points for several dimension values, Splunk Observability Cloud assigns a different color to each MTS. AreaChart: Similar to a LineChart, but the area between the line and the X-axis is filled with the color of the line. You can display multiple MTS as stacked area charts by setting options.stacked to true. Column: Displays each data points in an MTS as a colored vertical bar with the base on the X-axis and the top at the data points value. This type is also known as a bar chart. In a chart that displays multiple MTS, each data points for each MTS has its own bar and bar color, and the bars are clustered around the data points timestamp. You can display multiple MTS as stacked bars by setting options.stacked to true. Histogram: Colored bars that indicate the distribution of data points values at a point in time.' unitPrefix: title: Determines whether to use metric or binary units for chart values type: string enum: - Metric - Binary default: 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 any value of option.type except Text.' packageSpecifications: title: SignalFlow internal field type: string default: '' description: For internal use only. programText: title: Chart SignalFlow program type: string description: 'SignalFlow program that provides the chart data. If you use more than one line of SignalFlow, separate the lines with semicolons (;) or newline characters (\n). See Charts and SignalFlow. Note: Required only for charts with options.type of values Heatmap, List, SingleValue, TableChart, and TimeSeriesChart.' tags: title: Chart tags type: array items: type: string maxItems: 50 description: 'An array that contains tag values. You can 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.' examples: example: value: description: string name: string options: areaChartOptions: showDataMarkers: true axes: - highWatermark: 0 highWatermarkLabel: string label: string lowWatermark: 0 lowWatermarkLabel: string max: 0 min: 0 axisPrecision: 0 colorBy: Range 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: true legendOptions: fields: - enabled: true property: string lineChartOptions: showDataMarkers: true markdown: string maximumPrecision: 0 noDataOptions: linkText: Set up Splunk OpenTelemetry linkUrl: https://docs.splunk.com/Observability/gdi/opentelemetry/opentelemetry.html noDataMessage: No active hosts found onChartLegendOptions: dimensionInLegend: string showLegend: true programOptions: disableSampling: true maxDelay: 0 minimumResolution: 0 timezone: string publishLabelOptions: - displayName: string label: string paletteIndex: 0 plotType: LineChart valuePrefix: string valueSuffix: string valueUnit: Bit yAxis: 0 refreshInterval: 0 secondaryVisualization: None showEventLines: true showSparkLine: true sortBy: string sortDirection: Ascending sortProperty: string stacked: true time: end: 205430400000 range: 0 start: 205344000000 type: relative timeStampHidden: true type: Heatmap unitPrefix: Metric packageSpecifications: string programText: string tags: - string responses: '200': description: HTTP 200 response content: application/json: schema: type: object title: Response object for successful chart creation or update properties: created: title: Chart creation time type: integer format: int64 example: 1557534630000 readOnly: true description: 'The time the chart was created, in *nix time in milliseconds. This value is always set by the system.' creator: title: Chart Creator ID type: string readOnly: true description: ID of the user that initially created the chart customProperties: title: Custom properties type: object additionalProperties: true description: User-defined JSON object containing metadata description: title: Chart description type: string description: 'Extended text description of the chart. This text appears in the Chart description text box at the top of the New Chart screen in the UI.' id: title: Chart ID type: string readOnly: true description: System-defined identifier for the chart lastUpdated: title: Chart last updated time type: integer format: int64 example: 1557707430000 readOnly: true description: 'The last time the chart was updated, in *nix time in milliseconds. This value is always set by the system.' lastUpdatedBy: title: Chart last updated ID type: string readOnly: true description: 'The ID of the last person who updated the chart. If the last update was done by the system, the value is the string literal "AAAAAAAAAA".' name: title: Chart name (displayed) type: string description: 'Short chart name. In the UI, you enter the chart name in the Untitled Chart text box at the top of the New Chart screen.' options: type: object title: Chart options properties: areaChartOptions: title: Properties specific to area charts type: object properties: showDataMarkers: title: Controls the display of data markers for area charts type: boolean default: false description: 'If options.type is TimeSeriesChart and options.defaultPlotType property is AreaChart, then areaChartOptions.showDataMarkers controls the appearance of small dots in the chart indicating times at which data arrived. To show markers, set to true; otherwise, set to false. If you use options.areaChartOptions.showDataMarkers with any other values of options.type and options.defaultPlotType, the API returns an HTTP response code 400.' axes: title: Axes options type: array items: title: Chart axes options type: object properties: highWatermark: type: number format: float 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. The 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 description: 'A label that''s displayed beside the horizontal line indicating the high water mark. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. If options.axes.highWaterMark isn''t specified, this label is ignored.' label: type: string 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' lowWatermark: type: number format: float 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. 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 description: 'A label that''s displayed beside the horizontal line indicating the low water mark. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400`. If options.axes.lowWaterMark isn''t specified, the API ignores this label.' max: type: number format: float description: 'Specifies the largest data value to display on the chart. Overrides options.includeZero if the properties are set to incompatible values. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. The value must be greater than the value of options.axes.min for the same options.axes element.' min: type: number format: float description: 'Specifies the smallest data value to display on the chart. Overrides options.includeZero if the properties are set to incompatible values. Notes: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. The value must be less than the value of options.axes.max for the same options.axes element.' description: 'Axis options for the left and right side of a chart with options.type of TimeSeriesChart. The object in the first element specifies options for the left chart axis, and the object in the second element specifies options for the right chart axis. All other elements are ignored. Note: Use only when options.type is TimeSeriesChart; otherwise, the API returns an HTTP response code 400.' axisPrecision: title: 'Specifies the number of digits displayed for values plotted on the chart. ' type: integer minimum: 3 maximum: 10 default: 3 description: 'Specifies the digits Splunk Observability Cloud displays for values plotted on 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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' colorBy: title: 'Mechanism by which color is applied to values in the chart. ' type: string enum: - Range - Scale - Dimension - 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 API returns an HTTP response code 400. 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: Heatmap color range options type: object properties: color: title: Starting color for a heatmap chart color range type: string minLength: 7 description: 'The starting color value for data values in a heatmap chart. Specify the value as a 6-character hexadecimal value preceded by the "#" character. 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. The UI limits you to hexadecimal values for the colors displayed in table 5 in the section Chart color palettes of the Charts API guide. Use the same values for API requests to keep your chart settings consistent with the UI.' max: title: 'Maximum color value assigned to a data value in the heatmap chart. ' type: string minLength: 7 description: 'The color value to associate with the largest incoming data value in the heatmap chart. To learn more about this property, see the description of options.colorRange.color.' 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 chart. To learn more about this property, see the description of options.colorRange.color.' description: 'Properties that specify the range of color values to use in a heatmap chart, in the form of a JSON object. The properties specify the lowest and highest color to use. options.colorScale controls how Splunk Observability Cloud sets each intermediate chart color within the range. Note: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' colorScale: title: 'Heatmap chart color range limits ' 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 you set this property to true, and you also set options.colorBy 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).' 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. Specify the values from lowest to highest. Data values that outside the specified partitions don''t appear in color, so you should set the first array value to correspond to the lowest expected data value. Similarly, set the last array value to correspond 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, in the form of a JSON object. The properties also control the order of colors in the color gradient. The properties in options.colorScale2 override any properties you specify here. Note: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' colorScale2: title: List of secondary visualization color 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: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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, inclusive ' type: number format: float description: 'The lower threshold of a color range, including the specified value itself. Notes: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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: 'Color range upper threshold, inclusive ' type: number format: float description: 'The upper threshold of a color range, including the specified value itself. Notes: Use only when options.type property is List or SingleValue; otherwise, the API returns an HTTP response code 400. 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 of the section Charts 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 of the section Charts color palettes. of the Charts API guide.' description: 'List of secondary visualization color properties, in the form of an array of JSON objects. Each object in the array specifies the information for a single color range, including the color to display for that range and the borders of the range. The array specifies the entire range displayed in the secondary visualization or heatmap chart. You don''t need to insert the elements in a specific order, because automatically orders them by the values in the display. The lowest value becomes the left border of the secondary visualization, and the highest value becomes the right border.' defaultPlotType: title: Specifies the visualization option to use for a graph type: string enum: - LineChart - AreaChart - ColumnChart - Histogram default: LineChart description: 'When you choose a graph chart type by setting options.type to TimeSeriesChart, options.defaultPlotType sets the visualization to use for plots in the chart: LineChart: A plot with data points connected by a series of straight lines. AreaChart: Similar to a LineChart, 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. Also known as a bar chart. Histogram: Colored bars that indicate the distribution of data points values at a point in time.' groupBy: title: 'Groups of histogram chart properties ' type: array items: type: string description: 'Specifies a list of custom properties to use in grouping values in a histogram chart, in the form of a JSON array of strings. Each element must contain a key specified in customProperties or a valid default custom property. The first element determines the top-level grouping, and the second element determines the second-level grouping within each first-level grouping. All other elements are ignored. The section Heatmap chart grouping in API topics shows a heatmap that charts CPU utilization, using AWS availability zone as the top-level grouping and number of host CPU cores as the second-level grouping. Note: Use only when options.type property is Heatmap or TableChart. Otherwise, the API returns an HTTP response code 400.' 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 of the Charts API guide. 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.' includeZero: title: Determines how 0 affects Y-axis values type: boolean default: false description: '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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' legendOptions: title: 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 table. Note: Use only when options.type property is TimeSeriesChart, TableChart, List, or SingleValue. Otherwise, the API returns an HTTP response code 400.' 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: 'A list of table settings for properties in the chart, in the form of a JSON array. Each element of the array is a JSON object that contains a chart property key name and a flag. If the flag is true, the chart property appears; otherwise, it''s hidden.' description: 'Sets options for the data table of a chart or a table chart, including which properties are omitted.' lineChartOptions: type: object title: Line graph options properties: showDataMarkers: title: Determines how to represent data points in the chart type: boolean default: false description: '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: 'Specifies options for a line graph chart Note: Use only when options.type property is TimeSeriesChart and options.defaultPlotType is LineChart. Otherwise, the API returns an HTTP response code 400.' markdown: title: Text chart contents type: string description: 'The contents of a text chart, using GitHub-Flavored Markdown (GFM) or HTML. Note: Use only when options.type property is Text. Otherwise, the API returns an HTTP response code 400.' maximumPrecision: title: Specifies the number of fractional digits used to display data type: integer minimum: 0 description: 'Indicates the number of significant digits to the right of the decimal point to use for data points. 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: Use only when options.type is List, TableChart, or SingleValue. Otherwise, the API returns an HTTP response code 400.' noDataOptions: title: User-defined message for when a chart has no active metrics properties: noDataMessage: title: Display message type: string example: No active hosts found description: Message to show in a chart when no active metric is available. Max length is 140 characters. linkUrl: title: URL to additional resource type: string example: https://docs.splunk.com/Observability/gdi/opentelemetry/opentelemetry.html description: URL that links to resource for additional information. linkText: title: Display text for the URL type: string example: Set up Splunk OpenTelemetry description: Display text for the URL that links to additional resource. Max length is 50 characters. description: 'Set up a message that appears when metrics used in a chart either don''t exist or are inactive. Use only when options.type is Heatmap, List, SingleValue, or TimeSeriesChart. Otherwise, the API returns an HTTP response code 400. A metric is considered inactive by Splunk Observability Cloud in the following cases: The metric hasn''t received any data for 24 hours. The metric is tagged as ephemeral and hasn''t received any data for one hour. Note: A chart with inactive metrics is distinct from a chart with active metrics that doesn''t receive data. For example, a chart might not receive any data despite using active metrics if you use a filter on the chart that doesn''t match any data. On a chart with active metrics, the no active metrics message won''t appear even if the chart isn''t receiving any data. To learn more about why your message might not appear, see When your message doesn''t appear in Splunk Observability Cloud user documentation.' onChartLegendOptions: type: object title: Chart legend options properties: dimensionInLegend: title: Dimension to show in the legend type: string description: '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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' showLegend: title: Determines if a legend show display with the chart type: boolean default: false description: '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: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' description: 'Properties that determine if Splunk Observability Cloud should display a legend, and if so, which dimension to show in the legend, in the form of a JSON object. Note: Use only when options.type is TimeSeriesChart, List, or SingleValue. Otherwise, the API returns an HTTP response code 400.' programOptions: title: General chart options type: object properties: disableSampling: title: Determines if the chart uses sampling type: boolean default: 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 any value of options.type except Text' maxDelay: title: Interval to wait before charting the available data type: integer format: int32 minimum: 0 maximum: 900000 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 any value of options.type except Text' minimumResolution: title: Minimum data resolution to use type: integer minimum: 0 maximum: 900000 description: '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 any value of options.type except Text' timezone: title: Time zone for SignalFlow calendar window transformations type: string default: UTC description: 'Time zone that SignalFlow uses as the basis of calendar window transformation methods. For example, if you set "timezone": "Europe/Paris" and then use the transformation sum(cycle="week", cycle_start="Monday") in the SignalFlow program for your chart, the calendar window starts on Monday, Paris time. To learn more, see Timezones and SignalFlow calendar window transformations.' description: 'Options that control the general appearance and operation of the chart, in the form of a JSON object. Note: Available for any value of options.type except Text' publishLabelOptions: title: SignalFlow statement options type: array items: type: object title: SignalFlow plot options properties: displayName: title: Alternate display name type: string description: 'Specifies an alternate value for the Plot Name column of the Data Table associated with the plot. In the UI, this is the text value listed below Name, on the right side of the top bar in the Plot Editor. Note: Use only when options.type is TimeSeriesChart, List, or SingleValue.' label: title: '`publish()` block label ' type: string description: "For the SignalFlow program in the programText property of a POST\nor PUT request\ \ body, label maps its publishLabelOptions parent\nobject properties to the plot from the\ \ publish() block that has the\nsame label in its label= argument.\nFor example, if the SignalFlow\ \ program contains the statement\nA = data('demo.trans.count').publish(label='A')\nand the\ \ POST request body for creating a chart contains\n\"options\": {\n ...\n \"publishLabelOptions\"\ : {\n ...\n \"label\": \"A\"\n }\n}\n\nthen Splunk Observability Cloud applies the\ \ properties in the publishLabelOptions object\nto the plot displayed by the SignalFlow statement.\n\ Note: Use only when options.type property is\nList, TimeSeriesChart, or SingleValue;\notherwise,\ \ the API returns an HTTP response code 400." paletteIndex: title: Plot color 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 of the Charts API guide.' plotType: title: Plot-specific time series graph visualization enum: - LineChart - AreaChart - ColumnChart - Histogram description: 'Plot-specific override of the time series graph visualization you specify for the entire chart. plotType only applies to the SignalFlow statement that provides data for the plot. For example, if you create a chart with two SignalFlow statements, set options.type to TimeSeriesChart, and set defaultPlotType to LineChart, Splunk Observability Cloud displays a chart with two line plots. To change one of the plots to a bar chart, set publishLabelOptions.plotType for the SignalFlow publish() label of the plot to ColumnChart. The result is a chart with a line plot and a column plot. This property corresponds to the Visualization Type 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 the plot type is Heatmap or Text. For these types, the API returns an HTTP response code 400. If you only have one plot for the chart, so that the publishLabelOptions array has only one element, this property overrides the plot type for the entire chart. type: string' valuePrefix: title: String to prepend to values displayed in a plot type: string description: 'Specifies a string to prepend to values displayed in a single value or list plot, the data table for a plot, and the tooltip shown when you hover over a point on a plot. To learn more, see the example in the section Adding a prefix and/or suffix in the user documentation. Any value you set for options.publishLabelOptions[].valueUnit property overrides valuePrefix. This property corresponds to the Prefix text box that appears when you select Custom from the Display Units dropdown list 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. Note: Not available when the plot type is Text. The API returns an HTTP response code 400.' valueSuffix: title: String to append to values displayed in charts type: string 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 Adding a prefix and/or suffix in the user documentation. Any value you set for options.publishLabelOptions[].valueUnit property overrides valueSuffix. This property corresponds to the Suffix text box that appears when you select Custom from the Display Units dropdown list 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. Note: Not available when the plot type is Text. The API returns an HTTP response code 400.' valueUnit: title: Specifies the display units to use for chart values type: string 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 plot. Splunk Observability Cloud displays values based on the assumption that the raw data has the unit of measure you select. For example, the value 1000 in a plot where you''ve set options.publishLabelOptions[].valueUnit to bits appears as 1 Kilobit, and the value 1024 in a plot set to Bytes appears as 1 Kebibyte. Splunk Observability Cloud scales units within their own unit type. To learn more, see Displaying units and other labels. The options.publishLabelOptions[].valueUnit option applies to scaling and labeling in chart tooltips, axes, and data tables. options.publishLabelOptions[].valueUnit overrides options.publishLabelOptions[].valuePrefix and options.publishLabelOptions[].valueSuffix. The property value corresponds to one of the options that appear in Display Units dropdown list 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. Note: Not available when the plot type is Text. The API returns an HTTP response code 400.' yAxis: title: Y axis position for plot type: integer default: 0 minimum: 0 maximum: 1 description: 'Position of the Y-axis for the plot to which this publishLabelOptions object applies. If yAxis is 0, the axis appears on the left side. Otherwise it appears on the right. The default is 0 (left side). Note: Use only when options.type property is TimeSeriesChart, List, or SingleValue; otherwise, the API returns an HTTP response code 400.' required: - label description: Properties of a single plot in a chart description: 'List that specifies options for each plot displayed in the chart, in the form of an array of JSON objects. In this context, a plot is the publish() block output from a single statement in the SignalFlow program for the chart. To match a SignalFlow statement to an array element, Splunk Observability Cloud maps the value of the label argument for the publish() block to the value of a publishLabelOptions[].label property. Some publishLabelOptions child object properties aren''t supported for all plot types. Note: Not available when options.type is Text; the API returns an HTTP response code 400.' refreshInterval: title: Interval at which Splunk Observability Cloud should update the chart with new data type: integer format: int32 minimum: 0 description: 'How often, in milliseconds, that Splunk Observability Cloud should refresh 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: Use only when options.type property is List, TableChart, or SingleValue. Otherwise, the API returns an HTTP response code 400.' secondaryVisualization: title: Secondary visualization to use with the chart type: string enum: - None - Radial - Linear - Sparkline description: 'Secondary visualization to use with list or single value charts. See the section Secondary visualization for examples of the available visualizations. Note: Use only when options.type property is List or SingleValue. Otherwise, the API returns an HTTP response code 400.' showEventLines: title: Specifies what to show on a chart when an event occurs type: boolean default: false description: 'If true, Splunk Observability Cloud displays a vertical line on the chart at the point that an event occurs. Note: Use only when options.type property is TimeSeriesChart; otherwise, the API returns an HTTP response code 400.' 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 single value chart. Notes: Use only when optionstype property is SingleValue. Otherwise, the API returns an HTTP response code 400. The value specified for options.secondaryVisualization overrides options.showSparkLine.' sortBy: title: Specifies how to sort the entries in a time series chart or table chart type: string description: 'Specifies how to sort the entries in a time series chart or table chart. The first character of the value must be one of the following: Minus sign (-): Sets descending order for the data Plus sign (+): Sets ascending order for the data The rest of the characters specify the sort criteria: A keyword that represents a data points 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 Splunk Observability Cloud web UI. 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 chart for ascending order and to the end of the list for descending order. Note: Use only when options.type property is TimeSeriesChart or TableChart. Otherwise, the API returns an HTTP response code 400.' 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: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' 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: Use only when options.type property is Heatmap. Otherwise, the API returns an HTTP response code 400.' stacked: title: Controls the display of stacked plots in a graph type: boolean default: false description: 'Controls the display of stacked plots in a graph. If true, Splunk Observability Cloud stacks the plots 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. If options.defaultPlotType is ''AreaChart, Splunk Observability Cloud displays the plots as stacked areas. If defaultPlotTypeisColumn`, Splunk Observability Cloud displays the plots as stacked columns. Note: Use only when options.type property is TimeSeriesChart and options.defaultPlotType is AreaChart or Column. Otherwise, the API returns an HTTP response code 400.' time: title: Chart time display options type: object properties: end: title: Timestamp of the last time to display in the chart type: integer format: int64 example: 205430400000 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: Use only when options.type property is TimeSeriesChart and options.time.type is relative. Otherwise, the API returns an HTTP response code 400`.' start: title: Timestamp of the first time to display in the chart type: integer format: int64 example: 205344000000 description: 'The timestamp of the first time to display in the chart, in *nix time Note: Use only when options.type property is TimeSeriesChart and options.time.type is absolute. Otherwise, the API returns an HTTP response code 400.' type: title: Determines the type of time range to use type: string enum: - relative - absolute default: relative description: 'Determines whether to use an explicit time range or to show a range of the last n milliseconds. Note: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' description: 'Time-related properties for a chart, in the form of a JSON object. Note: Use only when options.type property is TimeSeriesChart. Otherwise, the API returns an HTTP response code 400.' timeStampHidden: title: Determines if the timestamp is shown with displayed values type: boolean default: false description: 'Determines if the timestamp displays with displayed values. If true, the timestamp for a value appears with the value in the chart. Note: Use only when options.type property is Heatmap, TableChart, or SingleValue. Otherwise, the API returns an HTTP response code 400.' type: title: Visualization type type: string enum: - Heatmap - List - SingleValue - TableChart - Text - TimeSeriesChart description: 'Type of visualization to use for the data. Splunk Observability Cloud provides six main visualization types: Heatmap: Displays data in a set of colored boxes. You can provide an optional order and grouping; otherwise, each box represents a metric time series in the output. The color of a box is determined by the value of the metric it represents. Splunk Observability Cloud provides default values, or you can specify your own custom ranges. List: Displays data as a list of metric time series. You can provide an additional secondary visualization as well. For example, you can display a sparkline for each row in the list. SingleValue: Displays a single value with a color that you specify. You can specify an additional visualization (secondary visualization) as well. For example, you can display a sparkline next to the value. TableChart: Displays metrics and dimensions in table format. Each metric name and dimension key displays as a column. Each output MTS displays as a row. If there are multiple values for a cell, each MTS displays in a separate row. Text: Displays text you provide. You can use Markdown to format the appearance of this text. TimeSeriesChart: Displays graphs of metric time series over time, using a graph type determined by the value of options.defaultPlotType or options.publishLabelOptions.plotType: LineChart: Displays data points as plot points connected by straight lines. In a graph that displays multiple metric time series, such as metric data points for several dimension values, Splunk Observability Cloud assigns a different color to each MTS. AreaChart: Similar to a LineChart, but the area between the line and the X-axis is filled with the color of the line. You can display multiple MTS as stacked area charts by setting options.stacked to true. Column: Displays each data points in an MTS as a colored vertical bar with the base on the X-axis and the top at the data points value. This type is also known as a bar chart. In a chart that displays multiple MTS, each data points for each MTS has its own bar and bar color, and the bars are clustered around the data points timestamp. You can display multiple MTS as stacked bars by setting options.stacked to true. Histogram: Colored bars that indicate the distribution of data points values at a point in time.' unitPrefix: title: Determines whether to use metric or binary units for chart values type: string enum: - Metric - Binary default: 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 any value of option.type except Text.' packageSpecifications: title: SignalFlow internal field type: string default: '' description: For internal use only. programText: title: Chart SignalFlow program type: string description: 'SignalFlow program that provides the chart data. If you use more than one line of SignalFlow, separate the lines with semicolons (;) or newline characters (\n). See Charts and SignalFlow. Note: Required only for charts with options.type of values Heatmap, List, SingleValue, TableChart, and TimeSeriesChart.' tags: title: Chart tags type: array items: type: string maxItems: 50 description: 'An array that contains tag values. You can 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.' relatedDetectorIds: title: Detectors linked to this chart type: array items: type: string uniqueItems: true readOnly: true description: List of detectors linked to this chart, in the form of a JSON array. Each item is a unique ID of a linked detector. This list is read-only and is retrieved from programText. autoDetectRelatedDetectorIds: title: AutoDetect detectors linked to this chart type: array items: type: string uniqueItems: true readOnly: true description: List of AutoDetect and customized AutoDetect detectors linked to this chart, in the form of a JSON array. Each item is a unique ID of a linked AutoDetect or customized AutoDetect detector. This list is read-only and is retrieved from programText. examples: example: value: autoDetectRelatedDetectorIds: - string created: 1557534630000 creator: string description: string id: string lastUpdated: 1557707430000 lastUpdatedBy: string name: string options: areaChartOptions: showDataMarkers: true axes: - highWatermark: 0 highWatermarkLabel: string label: string lowWatermark: 0 lowWatermarkLabel: string max: 0 min: 0 axisPrecision: 0 colorBy: Range 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: true legendOptions: fields: - enabled: true property: string lineChartOptions: showDataMarkers: true markdown: string maximumPrecision: 0 noDataOptions: linkText: Set up Splunk OpenTelemetry linkUrl: https://docs.splunk.com/Observability/gdi/opentelemetry/opentelemetry.html noDataMessage: No active hosts found onChartLegendOptions: dimensionInLegend: string showLegend: true programOptions: disableSampling: true maxDelay: 0 minimumResolution: 0 timezone: string publishLabelOptions: - displayName: string label: string paletteIndex: 0 plotType: LineChart valuePrefix: string valueSuffix: string valueUnit: Bit yAxis: 0 refreshInterval: 0 secondaryVisualization: None showEventLines: true showSparkLine: true sortBy: string sortDirection: Ascending sortProperty: string stacked: true time: end: 205430400000 range: 0 start: 205344000000 type: relative timeStampHidden: true type: Heatmap unitPrefix: Metric packageSpecifications: string programText: string relatedDetectorIds: - string tags: - string security: - SessionToken: [] tags: - Charts delete: summary: Delete Single Chart description: Deletes the chart identified by the chart ID in the id path parameter. parameters: - name: id in: path description: The ID of the chart you want to update 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: - Charts