Get Host Usage Report

Get host usage report for a given organization and date rage with filter

Get host usage report for a given organization and date range

Request

URI

GET

https://vmc.vmware.com/api/activityanalytic/{org_id}/hosts/{freq}/usage-report

COPY

Path Parameters

string

org_id

Required

organization identifier

string

freq

Required

Frequency of host usage

freq example

daily

Query Parameters

string

start_date

Required

Starting date of Usage Report

start_date example

2025-01-27

string

end_date

Required

Ending date of Usage Report.

end_date example

2025-01-27

string

sort

Optional

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

string

filter

Optional

Filtering criteria in the format: property(,eq|ne|gt|gte|lt|lte|regexp|contains|not_contains|sw|not_sw|in|not_in|between):value. The 'eq' operation can be omitted (e.g. f1,foo). Criteria in the same filter block can be separated with 'OR' (e.g. f1,sw:foo|f1,contains:bar)

filter example

filter=body.region,eq:VOO|filter=body.instance_type,eq:I3

Authentication

This operation uses the following authentication methods.

api_key

Responses

200

Success

Returns HostUsageReportResponse of type(s) application/json

This response body class contains all of the following: InlineHostUsageReportResponse0