openapi: 3.0.0
info:
title: Sumo Logic accessKeyManagement logSearchesEstimatedUsage API
description: "# Getting Started\nWelcome to the Sumo Logic API reference. You can use these APIs to interact with the Sumo Logic platform. For information on Collector and Search Job APIs, see our [API home page](https://help.sumologic.com/docs/api).\n## API Endpoints\nSumo Logic has several deployments in different geographic locations. You'll need to use the Sumo Logic API endpoint corresponding to your geographic location. See the table below for the different API endpoints by deployment. For details determining your account's deployment, see [API endpoints](https://help.sumologic.com/?cid=3011).\n\n <table>\n <tr>\n <td> <strong>Deployment</strong> </td>\n <td> <strong>Endpoint</strong> </td>\n </tr>\n <tr>\n <td> AU </td>\n <td> https://api.au.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> CA </td>\n <td> https://api.ca.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> DE </td>\n <td> https://api.de.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> EU </td>\n <td> https://api.eu.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> FED </td>\n <td> https://api.fed.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> IN </td>\n <td> https://api.in.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> JP </td>\n <td> https://api.jp.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> KR </td>\n <td> https://api.kr.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> US1 </td>\n <td> https://api.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> US2 </td>\n <td> https://api.us2.sumologic.com/api/ </td>\n </tr>\n </table>\n\n## Authentication\nSumo Logic supports the following options for API authentication:\n- Access ID and Access Key\n- Base64 encoded Access ID and Access Key\n\nSee [Access Keys](https://help.sumologic.com/docs/manage/security/access-keys) to generate an Access Key. Make sure to copy the key you create, because it is displayed only once.\nWhen you have an Access ID and Access Key you can execute requests such as the following:\n ```bash\n curl -u \"<accessId>:<accessKey>\" -X GET https://api.<deployment>.sumologic.com/api/v1/users\n ```\n\nWhere `deployment` is either `au`, `ca`, `de`, `eu`, `fed`, `in`, `jp`, `us1`, or `us2`. See [API endpoints](#section/API-Endpoints) for details.\n\nIf you prefer to use basic access authentication, you can do a Base64 encoding of your `<accessId>:<accessKey>` to authenticate your HTTPS request. The following is an example request, replace the placeholder `<encoded>` with your encoded Access ID and Access Key string:\n ```bash\n curl -H \"Authorization: Basic <encoded>\" -X GET https://api.<deployment>.sumologic.com/api/v1/users\n ```\n\n\nRefer to [API Authentication](https://help.sumologic.com/?cid=3012) for a Base64 example.\n\n## Status Codes\nGeneric status codes that apply to all our APIs. See the [HTTP status code registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) for reference.\n <table>\n <tr>\n <td> <strong>HTTP Status Code</strong> </td>\n <td> <strong>Error Code</strong> </td>\n <td> <strong>Description</strong> </td>\n </tr>\n <tr>\n <td> 301 </td>\n <td> moved </td>\n <td> The requested resource SHOULD be accessed through returned URI in Location Header. See [troubleshooting](https://help.sumologic.com/docs/api/troubleshooting/#api---301-error---moved) for details.</td>\n </tr>\n <tr>\n <td> 401 </td>\n <td> unauthorized </td>\n <td> Credential could not be verified.</td>\n </tr>\n <tr>\n <td> 403 </td>\n <td> forbidden </td>\n <td> This operation is not allowed for your account type or the user doesn't have the role capability to perform this action. See [troubleshooting](https://help.sumologic.com/docs/api/troubleshooting/#api---401-error---credential-could-not-be-verified) for details.</td>\n </tr>\n <tr>\n <td> 404 </td>\n <td> notfound </td>\n <td> Requested resource could not be found. </td>\n </tr>\n <tr>\n <td> 405 </td>\n <td> method.unsupported </td>\n <td> Unsupported method for URL. </td>\n </tr>\n <tr>\n <td> 415 </td>\n <td> contenttype.invalid </td>\n <td> Invalid content type. </td>\n </tr>\n <tr>\n <td> 429 </td>\n <td> rate.limit.exceeded </td>\n <td> The API request rate is higher than 4 request per second or inflight API requests are higher than 10 request per second. </td>\n </tr>\n <tr>\n <td> 500 </td>\n <td> internal.error </td>\n <td> Internal server error. </td>\n </tr>\n <tr>\n <td> 503 </td>\n <td> service.unavailable </td>\n <td> Service is currently unavailable. </td>\n </tr>\n </table>\n\n## Filtering\nSome API endpoints support filtering results on a specified set of fields. Each endpoint that supports filtering will list the fields that can be filtered. Multiple fields can be combined by using an ampersand `&` character.\n\nExample: To get user with email `john@demo.com`:\n ```bash\n api.sumologic.com/v1/users?email=john@demo.com\n ```\n\n## Sorting\nSome API endpoints support sorting fields by using the `sortBy` query parameter. The default sort order is ascending. Prefix the field with a minus sign `-` to sort in descending order.\n\nFor example, to get 20 users sorted by their `email` in descending order:\n ```bash\n api.sumologic.com/v1/users?limit=20&sort=-email\n ```\n\n## Asynchronous Request\nAsynchronous requests do not wait for results, instead they immediately respond back with a job identifier while the job runs in the background. You can use the job identifier to track the status of the asynchronous job request. Here is a typical flow for an asynchronous request.\n1. Start an asynchronous job. On success, a job identifier is returned. The job identifier uniquely identifies\n your asynchronous job.\n\n2. Once started, use the job identifier from step 1 to track the status of your asynchronous job. An asynchronous\n request will typically provide an endpoint to poll for the status of asynchronous job. A successful response\n from the status endpoint will have the following structure:\n ```json\n {\n \"status\": \"Status of asynchronous request\",\n \"statusMessage\": \"Optional message with additional information in case request succeeds\",\n \"error\": \"Error object in case request fails\"\n }\n ```\n The `status` field can have one of the following values:\n 1. `Success`: The job succeeded. The `statusMessage` field might have additional information.\n 2. `InProgress`: The job is still running.\n 3. `Failed`: The job failed. The `error` field in the response will have more information about the failure.\n\n3. Some asynchronous APIs may provide a third endpoint (like [export result](#operation/getAsyncExportResult))\n to fetch the result of an asynchronous job.\n\n\n### Example\nLet's say we want to export a folder with the identifier `0000000006A2E86F`. We will use the [async export](#operation/beginAsyncExport) API to export all the content under the folder with `id=0000000006A2E86F`.\n1. Start an export job for the folder\n ```bash\n curl -X POST -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export\n ```\n See [authentication section](#section/Authentication) for more details about `accessId`, `accessKey`, and\n `deployment`.\n On success, you will get back a job identifier. In the response below, `C03E086C137F38B4` is the job identifier.\n ```bash\n {\n \"id\": \"C03E086C137F38B4\"\n }\n ```\n\n2. Now poll for the status of the asynchronous job with the [status](#operation/getAsyncExportStatus) endpoint.\n ```bash\n curl -X GET -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/status\n ```\n You may get a response like\n ```json\n {\n \"status\": \"InProgress\",\n \"statusMessage\": null,\n \"error\": null\n }\n ```\n It implies the job is still in progress. Keep polling till the status is either `Success` or `Failed`.\n\n3. When the asynchronous job completes (`status != \"InProgress\"`), you can fetch the results with the\n [export result](#operation/getAsyncExportResult) endpoint.\n ```bash\n curl -X GET -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/result\n ```\n\n The asynchronous job may fail (`status == \"Failed\"`). You can look at the `error` field for more details.\n ```json\n {\n \"status\": \"Failed\",\n \"errors\": {\n \"code\": \"content1:too_many_items\",\n \"message\": \"Too many objects: object count(1100) was greater than limit 1000\"\n }\n }\n ```\n\n\n## Rate Limiting\n* A rate limit of four API requests per second (240 requests per minute) applies to all API calls from a user.\n* A rate limit of 10 concurrent requests to any API endpoint applies to an access key.\n\nIf a rate is exceeded, a rate limit exceeded 429 status code is returned.\n\n## Generating Clients\nYou can use [OpenAPI Generator](https://openapi-generator.tech) to generate clients from the YAML file to access the API.\n\n### Using [NPM](https://www.npmjs.com/get-npm)\n1. Install [NPM package wrapper](https://github.com/openapitools/openapi-generator-cli) globally, exposing the CLI\n on the command line:\n ```bash\n npm install @openapitools/openapi-generator-cli -g\n ```\n You can see detailed instructions [here](https://openapi-generator.tech/docs/installation#npm).\n\n2. Download the [YAML file](/docs/sumologic-api.yaml) and save it locally. Let's say the file is saved as `sumologic-api.yaml`.\n3. Use the following command to generate `python` client inside the `sumo/client/python` directory:\n ```bash\n openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python\n ```\n\n\n### Using [Homebrew](https://brew.sh/)\n1. Install OpenAPI Generator\n ```bash\n brew install openapi-generator\n ```\n\n2. Download the [YAML file](/docs/sumologic-api.yaml) and save it locally. Let's say the file is saved as `sumologic-api.yaml`.\n3. Use the following command to generate `python` client side code inside the `sumo/client/python` directory:\n ```bash\n openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python\n ```\n"
version: 1.0.0
x-logo:
url: ./sumologic_logo.png
servers:
- url: https://api.au.sumologic.com/api/
description: AU deployment API server
- url: https://api.ca.sumologic.com/api/
description: CA deployment API server
- url: https://api.de.sumologic.com/api/
description: DE deployment API server
- url: https://api.eu.sumologic.com/api/
description: EU deployment API server
- url: https://api.fed.sumologic.com/api/
description: FED deployment API server
- url: https://api.jp.sumologic.com/api/
description: JP deployment API server
- url: https://api.kr.sumologic.com/api/
description: KR deployment API server
- url: https://api.in.sumologic.com/api/
description: IN deployment API server
- url: https://api.sumologic.com/api/
description: US1 deployment API server
- url: https://api.us2.sumologic.com/api/
description: US2 deployment API server
security:
- basicAuth: []
tags:
- name: logSearchesEstimatedUsage
description: 'Log Search Estimated Usage API.
Gets the estimated volume of data that would be scanned for a given log search in the Infrequent data tier, over a particular time range. In the Infrequent Data Tier, you pay per query, based on the amount data scanned. You can use this endpoint to get an estimate of the total data that would be scanned before running a query, and refine your query to scan less data, as necessary. For more information, see [Infrequent data tier](https://help.sumologic.com/?cid=11987).
'
x-displayName: Log Search Estimated Usage
paths:
/v1/logSearches/estimatedUsage:
post:
tags:
- logSearchesEstimatedUsage
summary: Gets Estimated Usage Details.
description: 'Gets the estimated volume of data that would be scanned for a given log search in the Infrequent data tier.
'
operationId: getLogSearchEstimatedUsage
parameters: []
requestBody:
description: The definition of the log search estimated usage.
content:
application/json:
schema:
$ref: '#/components/schemas/LogSearchEstimatedUsageRequest'
required: true
responses:
'200':
description: Log search information along with its estimated usage details.
content:
application/json:
schema:
$ref: '#/components/schemas/LogSearchEstimatedUsageDefinition'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/logSearches/estimatedUsageByTier:
post:
tags:
- logSearchesEstimatedUsage
summary: Gets Tier Wise Estimated Usage Details.
description: 'Gets the estimated volume of data that would be scanned for a given log search per data tier.
'
operationId: getLogSearchEstimatedUsageByTier
parameters: []
requestBody:
description: The definition of the log search estimated usage.
content:
application/json:
schema:
$ref: '#/components/schemas/LogSearchEstimatedUsageRequestV2'
required: true
responses:
'200':
description: Log search information along with its tier wise estimated usage details.
content:
application/json:
schema:
$ref: '#/components/schemas/LogSearchEstimatedUsageByTierDefinition'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/logSearches/estimatedUsageByMeteringType:
post:
tags:
- logSearchesEstimatedUsage
summary: Gets Estimated Usage Details Per Metering Type.
description: 'Gets the estimated volume of data, per metering type, that would be scanned for running a given log search for a given timerange.
'
operationId: getLogSearchEstimatedUsageByMeteringType
parameters: []
requestBody:
description: The definition of the log search estimated usage.
content:
application/json:
schema:
$ref: '#/components/schemas/LogSearchEstimatedUsageRequestV3'
required: true
responses:
'200':
description: Log search information along with its metering type wise estimated usage details.
content:
application/json:
schema:
$ref: '#/components/schemas/LogSearchEstimatedUsageByMeteringTypeDefinition'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/logSearches/estimatedUsageByView:
post:
tags:
- logSearchesEstimatedUsage
summary: Gets Estimated Usage Details Per View.
description: 'Gets the estimated volume of data, per view, that would be scanned for running a given log search for a given timerange.
'
operationId: logSearchesEstimatedUsageByView
parameters: []
requestBody:
description: The definition of the log search estimated usage.
content:
application/json:
schema:
$ref: '#/components/schemas/LogSearchEstimatedUsageRequestV3'
required: true
responses:
'200':
description: Log search information along with its view wise estimated usage details.
content:
application/json:
schema:
$ref: '#/components/schemas/LogSearchEstimatedUsageByViewDefinition'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
LogSearchQueryParsingMode:
type: object
properties:
parsingMode:
pattern: ^(AutoParse|Manual)$
type: string
description: "Define the parsing mode to scan the JSON format log messages. Possible values are:\n 1. `AutoParse`\n 2. `Manual`\nIn 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)."
example: AutoParse
default: Manual
description: Definition of log search parsing mode
LogSearchEstimatedUsageRequest:
allOf:
- $ref: '#/components/schemas/LogSearchQueryTimeRangeBase'
- required:
- timezone
type: object
properties:
timezone:
type: string
description: 'Time zone to get the estimated usage details. Follow the format in the [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
'
example: America/Los_Angeles
EstimatedUsageDetailsWithTier:
type: object
properties:
tier:
type: string
description: Name of the data tier. Supported Values are Continuous, Frequent, Infrequent
example: Continuous
dataScannedInBytes:
type: integer
description: Amount of data scanned in bytes, to run the query.
format: int64
example: 114086541
LogSearchEstimatedUsageDefinition:
allOf:
- $ref: '#/components/schemas/LogSearchEstimatedUsageRequest'
- required:
- estimatedUsageDetails
type: object
properties:
estimatedUsageDetails:
$ref: '#/components/schemas/EstimatedUsageDetails'
EstimatedUsageDetails:
type: object
properties:
dataScannedInBytes:
type: integer
description: Amount of data scanned in bytes, to run the query.
format: int64
example: 114086541
LogSearchEstimatedUsageByViewDefinition:
allOf:
- $ref: '#/components/schemas/LogSearchEstimatedUsageRequestV3'
- required:
- estimatedUsageDetails
type: object
properties:
estimatedUsageDetails:
type: array
items:
$ref: '#/components/schemas/EstimatedUsageDetailsPerView'
LogSearchEstimatedUsageByTierDefinition:
allOf:
- $ref: '#/components/schemas/LogSearchEstimatedUsageRequestV2'
- required:
- estimatedUsageDetails
type: object
properties:
estimatedUsageDetails:
type: array
items:
$ref: '#/components/schemas/EstimatedUsageDetailsWithTier'
LogSearchQueryEstimationQueryDefinition:
description: Definition of the log search with query and timerange.
allOf:
- $ref: '#/components/schemas/LogSearchQueryEstimationBaseDefinition'
- type: object
properties:
runByReceiptTime:
type: boolean
description: 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.
example: false
default: false
EmulateSearchContext:
type: object
properties:
roleIds:
type: array
description: List of role IDs to emulate the search context for.
example:
- 000000000000000C
items:
type: string
userId:
type: string
description: User ID to emulate the search context for.
example: 000000000000019F
description: 'Contains keys like "roleIds" with a list of role IDs or "userId" as a string.
'
AutoCompleteLookupMetaData:
type: object
properties:
fileName:
type: string
description: The lookup file name to use as a source for autocomplete values.
example: users.csv
valueColumn:
type: string
description: The column from the lookup file to use as the value.
example: user_id
labelColumn:
type: string
description: The column from the lookup file to use as the label.
example: user_name
x-class-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL)'
AutoCompleteDefinition:
required:
- type
type: object
properties:
type:
type: string
description: The autocomplete parameter type.
example: SKIP_AUTOCOMPLETE
autoCompleteKey:
type: string
description: The autocomplete key to be used to fetch autocomplete values.
example: Ephemeral-3644138589235809747-1583470806220-parameter
autoCompleteValues:
type: array
description: The array of label-value pairs for autocomplete.
items:
$ref: '#/components/schemas/AutoCompleteValueSyncDefinition'
lookupMetaData:
$ref: '#/components/schemas/AutoCompleteLookupMetaData'
LogSearchQueryTimeRangeBase:
description: Definition of the saved log search with query and timerange.
allOf:
- $ref: '#/components/schemas/LogSearchQueryTimeRangeBaseExceptParsingMode'
- $ref: '#/components/schemas/LogSearchQueryParsingMode'
EstimatedUsageDetailsWithMeteringType:
type: object
properties:
meteringType:
type: string
description: 'Name of the metering type. Metering type indicates how the data scanned within a particular data tier is actually metered and billed. Supported Values are Continuous, Frequent, Infrequent, ContinuousSecurity and FlexSecurity.
'
example: Continuous
dataScannedInBytes:
type: integer
description: Amount of data scanned in bytes, to run the query.
format: int64
example: 114086541
tier:
type: string
description: Name of the data tier. Supported Values are Continuous, Frequent, Infrequent and Flex.
example: Continuous
scanCreditAccounted:
type: boolean
description: 'Whether particular metering type is accounted against a customer''s credit on a per scan basis. e.g Data belonging to "Flex" and "Infrequent" metering type is accounted for credits on per scan basis. For other metering types, eg. "Continuous" it''s charged upfront during ingestion.
'
example: false
description: Estimated Usage details for the given log search query with the above timerange.
LogSearchQueryTimeRangeBaseExceptParsingMode:
required:
- queryString
- timeRange
type: object
properties:
queryString:
maxLength: 15000
type: string
description: Query to perform.
example: error {{sourceCategory}}| count by _sourceCategory
timeRange:
$ref: '#/components/schemas/ResolvableTimeRange'
runByReceiptTime:
type: boolean
description: 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.
example: false
default: false
queryParameters:
maxLength: 50
type: array
description: '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/'
items:
$ref: '#/components/schemas/LogSearchQueryParameterSyncDefinitionBase'
intervalTimeType:
pattern: ^(messageTime|receiptTime|searchableTime)$
type: string
description: 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.
example: messageTime
default: messageTime
x-pattern-message: should be either 'messageTime' or 'receiptTime' or 'searchableTime'
description: Definition of the saved log search with query and timerange.
ResolvableTimeRange:
required:
- type
type: object
properties:
type:
type: string
description: Type of the time range. Value must be either `CompleteLiteralTimeRange` or `BeginBoundedTimeRange`.
example:
type: BeginBoundedTimeRange
from:
type: RelativeTimeRangeBoundary
relativeTime: -15m
discriminator:
propertyName: type
LogSearchQueryEstimationBaseDefinition:
required:
- queryString
- timeRange
type: object
properties:
queryString:
maxLength: 15000
type: string
description: Log search Query to compute the estimated volume of data scanned.
example: error {{sourceCategory}}| count by _sourceCategory
timeRange:
$ref: '#/components/schemas/ResolvableTimeRange'
queryParameters:
maxLength: 50
type: array
description: '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/'
items:
$ref: '#/components/schemas/LogSearchQueryParameterSyncDefinitionBase'
intervalTimeType:
pattern: ^(messageTime|receiptTime|searchableTime)$
type: string
description: 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.
example: messageTime
default: messageTime
x-pattern-message: should be either 'messageTime' or 'receiptTime' or 'searchableTime'
description: Base definition of the log search with query and timerange (without runByReceiptTime).
ErrorDescription:
required:
- code
- message
type: object
properties:
code:
type: string
description: An error code describing the type of error.
example: auth:password_too_short
message:
type: string
description: A short English-language description of the error.
example: Your password was too short.
detail:
type: string
description: An optional fuller English-language description of the error.
example: Your password was 5 characters long, the minimum length is 12 characters. See http://example.com/password for more information.
meta:
type: object
description: An optional list of metadata about the error.
example:
minLength: 12
actualLength: 5
ErrorResponse:
required:
- errors
- id
type: object
properties:
id:
type: string
description: An identifier for the error; this is unique to the specific API request.
example: IUUQI-DGH5I-TJ045
errors:
type: array
description: A list of one or more causes of the error.
example:
- code: auth:password_too_short
message: Your password was too short.
- code: auth:password_character_classes
message: Your password did not contain any non-alphanumeric characters
items:
$ref: '#/components/schemas/ErrorDescription'
LogSearchEstimatedUsageRequestV2:
allOf:
- $ref: '#/components/schemas/LogSearchQueryTimeRangeBaseExceptParsingMode'
- required:
- timezone
type: object
properties:
timezone:
type: string
description: 'Time zone to get the estimated usage details. Follow the format in the [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
'
example: America/Los_Angeles
AutoCompleteValueSyncDefinition:
required:
- label
- value
type: object
properties:
label:
type: string
description: The label of the autocomplete value.
value:
type: string
description: The value of the autocomplete value.
LogSearchQueryParameterSyncDefinitionBase:
required:
- dataType
- name
- value
type: object
properties:
autoComplete:
$ref: '#/components/schemas/AutoCompleteDefinition'
name:
maxLength: 50
pattern: ^[a-zA-Z0-9_]+$
type: string
description: The name of the parameter.
example: sourceCategory
x-pattern-message: Name must be between 1 and 50 Characters. Can only consist alphanumeric and underscore characters.
description:
maxLength: 256
pattern: ^[a-zA-Z0-9@ \-_\.]+$
type: string
description: A description of the parameter.
example: source category for the string
x-pattern-message: Description must be between 1 and 256 Characters. Can only consist alphanumeric, @, underscore and dash characters.
dataType:
pattern: ^(NUMBER|STRING|ANY|KEYWORD)$
type: string
description: "The data type of the parameter. Supported values are:\n 1. `NUMBER`\n 2. `STRING`\n 3. `ANY`\n 4. `KEYWORD`"
example: STRING
value:
maxLength: 256
type: string
description: A value for the parameter. Should be compatible with the type set in dataType field.
example: apache
LogSearchEstimatedUsageByMeteringTypeDefinition:
allOf:
- $ref: '#/components/schemas/LogSearchEstimatedUsageRequestV3'
- required:
- estimatedUsageDetails
type: object
properties:
estimatedUsageDetails:
type: array
items:
$ref: '#/components/schemas/EstimatedUsageDetailsWithMeteringType'
EstimatedUsageDetailsPerView:
required:
- usageDetails
- viewName
type: object
properties:
viewName:
type: string
description: Name of the view for which usage is estimated.
usageDetails:
type: array
description: The scanning and data retrieval usages to run the query per view.
items:
$ref: '#/components/schemas/EstimatedUsageDetailsWithMeteringType'
LogSearchEstimatedUsageRequestV3:
allOf:
- $ref: '#/components/schemas/LogSearchQueryEstimationQueryDefinition'
- required:
- timezone
type: object
properties:
timezone:
type: string
description: 'Time zone to get the estimated usage details. Follow the format in the [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
'
example: America/Los_Angeles
emulateSearchContext:
$ref: '#/components/schemas/EmulateSearchContext'
securitySchemes:
basicAuth:
type: http
scheme: basic
x-tagGroups:
- name: Archive Management
tags:
- archiveManagement
- name: Health Events
tags:
- healthEvents
- name: Infrequent Data Tier
tags:
- logSearchesEstimatedUsage
- name: Ingest Budgets Management V2
tags:
- ingestBudgetManagementV2
- name: Library Management
tags:
- appManagement
- appManagementV2
- contentManagement
- dashboardManagement
- folderManagement
- lookupManagement
- contentPermissions
-
# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sumo-logic/refs/heads/main/openapi/sumo-logic-logsearchesestimatedusage-api-openapi.yml