Method: tensorboards.readUsage

Full name: projects.locations.tensorboards.readUsage

Returns a list of monthly active users for a given TensorBoard instance.

get https://{service-endpoint}/v1/{tensorboard}:readUsage

Where {service-endpoint} is one of the supported service endpoints.

tensorboard string

Required. The name of the Tensorboard resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

The request body must be empty.

If successful, the response body contains data with the following structure:

Fields

monthlyUsageData map (key: string, value: object (PerMonthUsageData ))

Maps year-month (YYYYMM) string to per month usage data.

JSON representation
{ "monthlyUsageData": { string: { object (`PerMonthUsageData` ) }, ... } }

PerMonthUsageData

Per month usage data

Fields

userUsageData[] object (PerUserUsageData )

Usage data for each user in the given month.

JSON representation
{ "userUsageData": [ { object (`PerUserUsageData` ) } ] }

Per user usage data.

Fields

username string

user's username

viewCount string (int64 format)

Number of times the user has read data within the Tensorboard.

JSON representation
{ "username": string, "viewCount": string }