Get Usage Data | VMware Services - VMware Aria Operations for Logs

Get Usage Data

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

URI

GET

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

COPY

Query Parameters

string of array

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

integer

start

Optional

Returns the usage report for the given start time

integer

end

Optional

Returns the usage report for the given end time

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Returns UsageReportResponseDto of type(s) */*

{
    "cspOrgId": "e442932c-1274-4495-b7f5-e567f3c0ec69",
    "referenceId": null,
    "usage": {
        "DATA_INGESTED_BILLABLE": {
            "1686700800000": 776408534,
            "1686787200000": 808110129
        },
        "DATA_INGESTED_NON_BILLABLE": {
            "1686700800000": 19101027,
            "1686787200000": 19514204,
            "1686873600000": 19595081
        },
        "DATA_ARCHIVED": {
            "1686700800000": 776408534,
            "1686787200000": 808110129
        },
        "DATA_FILTERED": {
            "1686700800000": 19101027,
            "1686787200000": 19514204,
            "1686873600000": 19595081
        }
    },
    "orgName": "test Org"
}

string

cspOrgId

Optional

Unique ID associated with the org

string

referenceId

Optional

Associated reference ID

object

usage

Optional

Map of usage type and its value.