Usage

Viewing usage in portal

Octane shows you a real-time view of customer usage. The usage chart on the Customers tab shows the usage of a meter across all of the customers.

Go to a specific customer's page to view their individual usage.

Fetching usage programmatically

You can fetch usage data as shown below. Dates follow the ISO datestring format (YYYY-MM-DDTHH:mm:ss.sssZ).

import octane
octane.api_key = "<YOUR_API_KEY>"

octane.Customer.usage(
  "customer_1",
  meter_name="num_clicks",
  start_time="2020-01-01T14:48:00.000Z",
  end_time="2020-02-01T14:48:00.000Z"
)

const octane = require('octane-node')(<YOUR_API_KEY>);

// octane.customers.retrieveUsage('<CUSTOMER_ID>', '<METER_NAME>', '<START_TIME>', '<END_TIME');
octane.customers.retrieveUsage('acme_corp', 'num_api_requests', '2021-01-01', '2021-02-01');