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
Metering Cloud
Periodic Usage Reports

Create a usage report job

1min
POST
https://app.amberflo.io/job

Create background job that periodically executes a batch usage query and saves its result in a file in a user-provided S3 bucket.

The data saved in S3 will have a table-like structure, i.e. be a flat version of the equivalent batch usage output.

Note that the S3 bucket must have ACL enabled and Amberflo's AWS account must be granted write permissions.

You can also run a one-off job immediately, by omitting the cron specification.

Each job execution is logged and can be seen using the Account Event API.

Authentication
x-api-key
apiKey
Body Parameters
body
job-post-request
jobName
string
*
description
string
enabled
boolean
email
string
cron
string
s3Url
string
*
format
string<json | ndjson | csv>
*
range
string
*
endTimeOffset
string
scheduledTimeInSeconds
number
aggregationBucket
string<hour | day | week | month>
*
meterApiNames
string[]
filter
object
groupBy
string[]
sparse
boolean
minimizeFresh
undefined
rescaleFunction
rescale-function
Responses
200
Successful response
job-response
All Of
job-put-request +
id
string
*
jobName
string
*
description
string
enabled
boolean
email
string
cron
string
s3Url
string
*
format
string<json | ndjson | csv>
*
range
string
*
endTimeOffset
string
scheduledTimeInSeconds
number
aggregationBucket
string<hour | day | week | month>
*
meterApiNames
string[]
filter
object
groupBy
string[]
sparse
boolean
minimizeFresh
undefined
rescaleFunction
rescale-function
createTime
integer
updateTime
integer
schedulerContext
object




Updated 18 Sep 2024
Doc contributor
Doc contributor
Did this page help you?
PREVIOUS
Query raw ingested records
NEXT
List all usage report jobs
Docs powered by Archbee