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

Validate job and query

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

This endpoint allows you to get the corresponding Usage API query that will be used by the job.

Use it to make sure your job definition is right.

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-check-response
job
job-post-request
query
usage-request[]




Updated 12 Jul 2024
Doc contributor
Did this page help you?
PREVIOUS
Delete a usage report job
NEXT
Get detailed information about your billing cloud
Docs powered by Archbee