POST /v1/logSearches/estimatedUsage

Gets the estimated volume of data that would be scanned for a given log search in the Infrequent data tier.

Servers

https://api.au.sumologic.com/api/
https://api.ca.sumologic.com/api/
https://api.de.sumologic.com/api/
https://api.eu.sumologic.com/api/
https://api.fed.sumologic.com/api/
https://api.jp.sumologic.com/api/
https://api.kr.sumologic.com/api/
https://api.in.sumologic.com/api/
https://api.sumologic.com/api/
https://api.us2.sumologic.com/api/

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`queryParameters[]`	Array	No	Values for search template used in the search query. Learn more about the search templates here : https://help.sumologic.com/docs/search/get-started-with-search/build-search/search-templates/
`queryParameters[].name`	String	Yes	The name of the parameter.
`queryParameters[].description`	String	No	A description of the parameter.
`queryParameters[].dataType`	String	Yes	The data type of the parameter. Supported values are: `NUMBER` `STRING` `ANY` `KEYWORD`
`queryParameters[].value`	String	Yes	A value for the parameter. Should be compatible with the type set in dataType field.
`timezone`	String	Yes	Time zone to get the estimated usage details. Follow the format in the IANA Time Zone Database.
`timeRange`	Object	Yes
`timeRange.type`	String	Yes	Type of the time range. Value must be either `CompleteLiteralTimeRange` or `BeginBoundedTimeRange`.
`queryString`	String	Yes	Query to perform.
`intervalTimeType`	String	No	This parameter defines whether you want to run the search by messageTime, receiptTime, or searchableTime. By default, the search will run by messageTime. If both runByReceiptTime and intervalTimeType parameters are present then the preference will be given to the intervalTimeType. This is available in beta only(Contact your sumologic representative to enable this feature). Default value: "messageTime"
`parsingMode`	String	No	Define the parsing mode to scan the JSON format log messages. Possible values are: `AutoParse` `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. Default value: "Manual"
`runByReceiptTime`	Boolean	No	This has the value `true` if the search is to be run by receipt time and `false` if it is to be run by message time. Default value: false

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.