Class: PlatformAPI::TeamUsageMonthly

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

Usage for an enterprise team at a monthly resolution.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ TeamUsageMonthly

Returns a new instance of TeamUsageMonthly.



3426
3427
3428
# File 'lib/platform-api/client.rb', line 3426

def initialize(client)
  @client = client
end

Instance Method Details

#info(team_id) ⇒ Object

Retrieves usage for an enterprise team for a range of months. Start and end dates can be specified as query parameters using the date format, YYYY-MM format. For example, '/teams/example-team/usage/monthly?start=2019-01&end=2019-02' specifies usage in January and February for 2019. If no end date is specified, one month of usage is returned.

Parameters:

  • team_id:

    unique identifier of team



3433
3434
3435
# File 'lib/platform-api/client.rb', line 3433

def info(team_id)
  @client.team_usage_monthly.info(team_id)
end