POST /v1/logSearches/estimatedUsageByMeteringType
Gets the estimated volume of data, per metering type, that would be scanned for running a given log search for a given timerange.
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:
|
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. |
emulateSearchContext |
Object | No |
Contains keys like "roleIds" with a list of role IDs or "userId" as a string. |
emulateSearchContext.userId |
String | No | |
emulateSearchContext.roleIds[] |
Array | No | |
timeRange |
Object | Yes | |
timeRange.type |
String | Yes |
Type of the time range. Value must be either |
queryString |
String | Yes |
Log search Query to compute the estimated volume of data scanned. |
runByReceiptTime |
Boolean | No |
This has the value 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.