--- title: "Update a metrics search page." method: PUT path: "/v2/metricsSearches/{id}" tags: ["metricsSearchesManagementV2"] --- # Update a metrics search page. `PUT /v2/metricsSearches/{id}` Update a metrics search page by the given identifier. ## Path parameters - `id` string, required ## Request body - MetricsSearchRequest - `title` string, required — Title of the metrics search page. - `timeRange` ResolvableTimeRange, required - `type` string, required — Type of the time range. Value must be either `CompleteLiteralTimeRange` or `BeginBoundedTimeRange`. - `description` string — Description of the metrics search page. - `queries` Query[], required — Queries of the metrics search page. - `queryString` string, required — The metrics, traces or logs query. - `queryType` string, required — The type of the query, either `Metrics`, `Traces`, `Spans` or `Logs`. - `queryKey` string, required — The key for metric, traces or log queries. Used as an identifier for queries. It is displayed on the panel builder and used for display overrides and query toggling. - `metricsQueryMode` string — The mode of the metrics query that the user was editing. Can be `Basic` or `Advanced`. Will ONLY be specified for metrics queries. - `metricsQueryData` MetricsQueryData — The data format describing a basic metrics query. - `metric` string, required — The metric of the query. - `aggregationType` string — The type of aggregation. Can be `Count`, `Minimum`, `Maximum`, `Sum`, `Average` or `None`. - `groupBy` string — The field to group the results by. - `filters` MetricsFilter[], required — A list of filters for the metrics query. - `key` string — The key of the metrics filter. - `value` string, required — The value of the metrics filter. - `negation` boolean — Whether or not the metrics filter is negated. - `operators` OperatorData[] — A list of operator data for the metrics query. - `operatorName` string, required — The name of the metrics operator. - `parameters` OperatorParameter[], required — A list of operator parameters for the operator data. - `key` string, required — The key of the operator parameter. - `value` string, required — The value of the operator parameter. - `tracesQueryData` TracesQueryData — The data format describing a basic traces query. - `filters` TracesFilter[], required — A list of filters for the traces query. - `type` string, required — The type of the filter. - `spansQueryData` SpansQueryData — The data format describing a basic spans query. - `filters` SpansFilter[], required — A list of filters for the spans query. - `type` string, required — The spans filter type. - `fieldName` string, required — The name of the filtering field. - `visualizations` SpansVisualization[], required — A list of used visualization methods for the spans query. - `type` string, required — The visualization type. - `name` string, required — A unique name of the visualization. - `groupBy` SpansGroupBy[], required — A list of group-by clauses for the spans query. - `type` string, required — The type of the group-by clause. - `limit` SpansLimitItem[], required — A list of limits that will be applied to the spans query. - `direction` string, required — Describes whether the results should be sorted in an ascending or a descending order. - `limitValue` integer, required — The number of aggregated results returned, e.g. if 10 is requested, then only the first 10 aggregated results are returned. - `parseMode` string — This field only applies for queryType of `Logs` but other query types may be supported in the future. Define the parsing mode to scan the JSON format log messages. Possible values are: 1. `Auto` 2. `Manual` In AutoParse mode, the system automatically figures out fields to parse based on the search query. While in the Manual mode, no fields are parsed out automatically. For more information see [Dynamic Parsing](https://help.sumologic.com/?cid=0011). - `timeSource` string — This field only applies for queryType of `Logs` but other query types may be supported in the future. Define the time source of this query. Possible values are `Message`, `Receipt`. `Message` will use the timeStamp on the message, while `Receipt` will use the timestamp it was received by Sumo. - `transient` boolean — This field only applies for queryType of `Metrics` but other query types may be supported in the future. Determines if the row should be returned in the response. Can be used in conjunction with a join, if only the result of the join is needed, and not the intermediate rows. Setting `transient` to `true` wherever the intermediate results aren't required speeds up the computation and reduces the amount of data transferred over the network. - `outputCardinalityLimit` integer — This field only applies for queryType of `Metrics` but other query types may be supported in the future. Specifies the output cardinality limitations for the query, which is the maximum number of timeseries returned in the result. - `visualSettings` string — Visual settings of the metrics search page. - `folderId` string — The identifier of the folder to save the metrics search in. By default it is saved in your personal folder. ## Response `200` The metrics search page was successfully modified. - MetricsSearchResponse - `title` string, required — Title of the metrics search page. - `timeRange` ResolvableTimeRange, required - `type` string, required — Type of the time range. Value must be either `CompleteLiteralTimeRange` or `BeginBoundedTimeRange`. - `description` string — Description of the metrics search page. - `queries` Query[], required — Queries of the metrics search page. - `queryString` string, required — The metrics, traces or logs query. - `queryType` string, required — The type of the query, either `Metrics`, `Traces`, `Spans` or `Logs`. - `queryKey` string, required — The key for metric, traces or log queries. Used as an identifier for queries. It is displayed on the panel builder and used for display overrides and query toggling. - `metricsQueryMode` string — The mode of the metrics query that the user was editing. Can be `Basic` or `Advanced`. Will ONLY be specified for metrics queries. - `metricsQueryData` MetricsQueryData — The data format describing a basic metrics query. - `metric` string, required — The metric of the query. - `aggregationType` string — The type of aggregation. Can be `Count`, `Minimum`, `Maximum`, `Sum`, `Average` or `None`. - `groupBy` string — The field to group the results by. - `filters` MetricsFilter[], required — A list of filters for the metrics query. - `key` string — The key of the metrics filter. - `value` string, required — The value of the metrics filter. - `negation` boolean — Whether or not the metrics filter is negated. - `operators` OperatorData[] — A list of operator data for the metrics query. - `operatorName` string, required — The name of the metrics operator. - `parameters` OperatorParameter[], required — A list of operator parameters for the operator data. - `key` string, required — The key of the operator parameter. - `value` string, required — The value of the operator parameter. - `tracesQueryData` TracesQueryData — The data format describing a basic traces query. - `filters` TracesFilter[], required — A list of filters for the traces query. - `type` string, required — The type of the filter. - `spansQueryData` SpansQueryData — The data format describing a basic spans query. - `filters` SpansFilter[], required — A list of filters for the spans query. - `type` string, required — The spans filter type. - `fieldName` string, required — The name of the filtering field. - `visualizations` SpansVisualization[], required — A list of used visualization methods for the spans query. - `type` string, required — The visualization type. - `name` string, required — A unique name of the visualization. - `groupBy` SpansGroupBy[], required — A list of group-by clauses for the spans query. - `type` string, required — The type of the group-by clause. - `limit` SpansLimitItem[], required — A list of limits that will be applied to the spans query. - `direction` string, required — Describes whether the results should be sorted in an ascending or a descending order. - `limitValue` integer, required — The number of aggregated results returned, e.g. if 10 is requested, then only the first 10 aggregated results are returned. - `parseMode` string — This field only applies for queryType of `Logs` but other query types may be supported in the future. Define the parsing mode to scan the JSON format log messages. Possible values are: 1. `Auto` 2. `Manual` In AutoParse mode, the system automatically figures out fields to parse based on the search query. While in the Manual mode, no fields are parsed out automatically. For more information see [Dynamic Parsing](https://help.sumologic.com/?cid=0011). - `timeSource` string — This field only applies for queryType of `Logs` but other query types may be supported in the future. Define the time source of this query. Possible values are `Message`, `Receipt`. `Message` will use the timeStamp on the message, while `Receipt` will use the timestamp it was received by Sumo. - `transient` boolean — This field only applies for queryType of `Metrics` but other query types may be supported in the future. Determines if the row should be returned in the response. Can be used in conjunction with a join, if only the result of the join is needed, and not the intermediate rows. Setting `transient` to `true` wherever the intermediate results aren't required speeds up the computation and reduces the amount of data transferred over the network. - `outputCardinalityLimit` integer — This field only applies for queryType of `Metrics` but other query types may be supported in the future. Specifies the output cardinality limitations for the query, which is the maximum number of timeseries returned in the result. - `visualSettings` string — Visual settings of the metrics search page. - `folderId` string — The identifier of the folder to save the metrics search in. By default it is saved in your personal folder. - `id` string — Unique identifier for the metrics search page. ## Other responses - `default` — Operation failed with an error. --- [API](https://skmtc.net/sumologic/apis/sumo-logic-api.md) · [All operations](https://skmtc.net/sumologic/apis/sumo-logic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sumologic/sumo-logic-api/versions/18a824df1e78/schema)