Skip to main content

metrics_searches

Overview

Namemetrics_searches
TypeResource
Idsumologic.metrics_searches.metrics_searches

Fields

NameDatatypeDescription
idstringIdentifier of the metrics search.
descriptionstringItem description in the content library.
createdAtstringCreation timestamp in UTC in RFC3339 format.
createdBystringIdentifier of the user who created the resource.
desiredQuantizationInSecsintegerDesired quantization in seconds.
logQuerystringLog query used to add an overlay to the chart.
metricsQueriesarrayMetrics queries, up to the maximum of six.
modifiedAtstringLast modification timestamp in UTC.
modifiedBystringIdentifier of the user who last modified the resource.
parentIdstringIdentifier of the parent element in the content library, such as folder.
propertiesstringChart properties, like line width, color palette, and the fill missing data method. Leave this field empty to use the defaults.
This property contains JSON object encoded as a string.
timeRangeobject
titlestringItem title in the content library.

Methods

NameAccessible byRequired ParamsDescription
getMetricsSearchSELECTid, regionReturns a metrics search with the specified identifier.
createMetricsSearchINSERTregionSaves a metrics search in the content library. Metrics search consists of one or more queries, a time range, a quantization period and a set of chart properties like line width.
deleteMetricsSearchDELETEid, regionDeletes a metrics search from the content library.
updateMetricsSearchEXECid, data__description, data__metricsQueries, data__timeRange, data__title, regionUpdates a metrics search with the specified identifier. Partial updates are not supported, you must provide values for all fields.