[{"label":"Latest (v1)","version":"latest"}]

vmware-aria-operations-for-logs

Get Usage Data

Description

Gets a usage report. Returns usage report for given start and end time. Usage reports show how VMware Aria Operations for Logs is used across the organization - the volume of log data ingested and stored, log statistics, recent queries, and active users

Request

URL

get

https://{api_host}/vrlic/api/v1/billing/usage-reports

Copy

Query Parameters

integer

end Optional

Returns the usage report for the given end time

integer

start Optional

Returns the usage report for the given start time

array of string

usageType Required

It represents the usage type to get report. Possible values are:

DATA_INGESTED_BILLABLE, DATA_INGESTED_NON_BILLABLE, DATA_FORWARDED, DATA_PARSED, DATA_INGESTED_PER_PARTITION, DATA_ARCHIVED, DATA_INGESTED_BILLABLE_V2, DATA_INGESTED_NON_BILLABLE_V2, DATA_QUERIED_ARCHIVE_PARTITIONS, DATA_QUERIED_FOR_LOG_RECALL, BILLABLE_DATA_INGESTED_PER_PARTITION, NON_BILLABLE_DATA_INGESTED_PER_PARTITION, DATA_TAGGED_SOURCE_PROPERTIES, DATA_TAGGED, DATA_FILTERED, DATA_INGESTED_LOG_FORWARDER, DATA_INGESTED_NPC_SOURCE

Possible values are: DATA_INGESTED_BILLABLE , DATA_INGESTED_NON_BILLABLE , DATA_FORWARDED , DATA_PARSED , DATA_INGESTED_PER_PARTITION , DATA_ARCHIVED , DATA_INGESTED_BILLABLE_V2 , DATA_INGESTED_NON_BILLABLE_V2 , DATA_QUERIED_ARCHIVE_PARTITIONS , DATA_QUERIED_FOR_LOG_RECALL , BILLABLE_DATA_INGESTED_PER_PARTITION , NON_BILLABLE_DATA_INGESTED_PER_PARTITION , DATA_TAGGED_SOURCE_PROPERTIES , DATA_TAGGED , DATA_FILTERED , DATA_INGESTED_LOG_FORWARDER , DATA_INGESTED_NPC_SOURCE

Authentication

This operation uses the following authentication methods.

bearerAuth

Response

Response Body

200 OK

Returns UsageReportResponseDto of type */*

{
	"cspOrgId": "string",
	"orgName": "string",
	"referenceId": "string",
	"usage": {
		"usageType": 0
	}
}

string

cspOrgId Optional

Unique ID associated with the org

string

orgName Optional

Associated org name

string

referenceId Optional

Associated reference ID

InlineUsageReportResponseDtoUsage

usage Optional

Map of usage type and its value.

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

curl https://{api_host}/vrlic/api/v1/billing/usage-reports?usageType=string

[{"label":"Latest (v1)","version":"latest"}]

vmware-aria-operations-for-logs

Subscription And Usage Reports Operations

get

Get Subscription Status For Org

get

Get Usage Data

Get Usage Data

Request

URL

Query Parameters

Authentication

bearerAuth

Response

Response Body

200 OK

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

On This Page

Subscription And Usage Reports Operations

Was this page helpful?