Method: projects.locations.tensorboards.readUsage

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

HTTP request

GET https://{service-endpoint}/v1beta1/{tensorboard}:readUsage

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

Path parameters

Parameters
tensorboard

string

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

Request body

The request body must be empty.

Response body

Response message for TensorboardService.ReadTensorboardUsage.

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

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

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

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

PerMonthUsageData

Per month usage data

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

object (PerUserUsageData)

Usage data for each user in the given month.

PerUserUsageData

Per user usage data.

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

string

user's username
viewCount

string (int64 format)

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