Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Get an usage report
Gets an usage report.
This method is not served on the public API.
api.sylphx.comdoes not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.
Gets an usage report.
Not available yet. Sylphx Billing is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.
- Path
GET https://api.sylphx.com/v1/orgs/acme/usage_reports/usage-report - Scope
billing:read - Effect
read— nothing is written. - Collection usage_reports
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the usage report to get. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/usage_reports/{YYYY-MM}. |
uid | string | usr_<cell><ulid>. Output only. |
meta | ResourceMeta | Resource metadata. Output only. |
period_start_time | timestamp | The start of the period. Output only. |
period_end_time | timestamp | The end of the period. Output only. |
lines | UsageLine[] | One line per project, meter, and dimension set. Output only. |
completeness | double | The share of the period's usage that has reached Billing, from 0 to 1, from every emitter's watermark. Output only. |
compute_time | timestamp | The instant the report reflects. Output only. |
invoice | string | The period's invoice, once one exists. Output only. |
watermarks | map<string, timestamp> | Each emitting service's watermark: the time of the oldest usage it has not yet delivered. Output only. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#UsageLine
| Field | Type | What it is |
|---|---|---|
project | string | The project that used it; empty for org-level usage (Runners, Network domains), whose attribution is a dimension such as repo. Output only. |
meter | string | The meter id. Output only. |
meter_version | int32 | The meter version. Output only. |
dimensions | map<string, string> | The dimensions. Output only. |
quantity | int64 | The aggregated quantity, in the meter's base unit. Output only. |
event_count | int64 | How many usage events were aggregated. Output only. |
amount | Money | The rated amount so far, before rounding to the invoice line; unset while the meter has no price for these dimensions. Output only. |
service | string | The service that emits the meter. Output only. |
shadow_cost | Money | What the usage cost Sylphx to serve, for a class Sylphx runs but does not sell (an internal Sandboxes class rates at zero and shows its cost here); unset otherwise. Output only. |
#Money
| Field | Type | What it is |
|---|---|---|
currency_code | string | ISO 4217 currency, for example USD. Required. |
units_minor | int64 | The amount in the currency's minor unit (cents for USD). Required. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/usage_reports/usage-report" \
-H "Authorization: Bearer $SYLPHX_API_KEY"