API Reference

⌘
K
docs
API Reference
Introduction
Getting started
Language Specific SDKs
Authorization
Metering Cloud
Meter Definition
Ingest Meters
Custom Ingest Schema
Filtering Out Reported Meters
Querying Reported Usage
Querying Raw Events
Periodic Usage Reports
Billing Cloud
Account
Product Items
Product Item Price Templates
Queries
Pricing Plans
Invoices
Prepaid Orders
Prepaid Cards
Prepaid Wallet
Customer Promotions
Defining Promotions
Customer Commitment
Billing Analysis
Tax Calculation
Customers
Alerts and Webhooks
Notifications (Alerts)
Webhooks
Event Logs
Account Settings
Customer Portal
Session
Usage
Cost
Billing
Prepaid
Notifications
Meters
Usage Events
Pricing Plan
Setup Intent
Payment Method
Settings
Company Logo
Customer Details
Credits Ledger
Rewards History
Docs powered by Archbee
Customer Portal
Usage

Query the usage data scoped to the customer

1min
POST
https://app.amberflo.io/customer-portal/usage
Authentication
x-api-key
apiKey
Body Parameters
body
usage-request
aggregation
string<SUM | MIN | MAX | AVG>
meterApiName
string
*
timeGroupingInterval
string<HOUR | DAY | WEEK | MONTH>
*
valuesTimeGroupingInterval
string<HOUR | DAY | WEEK | MONTH>
timeRange
object
*
groupBy
string[]
take
object
filter
map<string, string[]>
Responses
200
Successful response
usage-response
metadata
usage-request
secondsSinceEpochIntervals
integer[]
clientMeters
object[]




Updated 30 Sep 2024
Doc contributor
Did this page help you?
PREVIOUS
Create a session
NEXT
Query the usage data (batch)
Docs powered by Archbee