Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Localization
Monitoring
Notifications
Payments
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
List revenue facts
Lists the org's revenue facts, newest day first, for audit and export.
Lists the org's revenue facts, newest day first, for audit and export.
- Path
GET https://api.sylphx.com/v1/orgs/acme/revenue_facts - Scope
revenue:read - Effect
read— nothing is written. - Collection revenue_facts
- Query
page_size,page_token,filter - Pagination the answer carries
revenue_factsand, when there is more,next_page_token
#Request
| Field | Type | What it is |
|---|---|---|
parent | string | The org: orgs/{org}. Required. |
page_size | int32 | At most this many; default 50, clamped to 1000. |
page_token | string | next_page_token of the previous page. |
filter | string | AIP-160 filter, comparisons joined with AND: source = "…" (a source id or name), basis, store_kind, product_ref (each =), and day >= "YYYY-MM-DD", day <= "YYYY-MM-DD". The days default to the 31 days to today (UTC), and span at most 400 days. |
#Response
| Field | Type | What it is |
|---|---|---|
revenue_facts | RevenueFact[] | The page, newest day first. |
next_page_token | string | The token of the next page; empty on the last page. |
#RevenueFact
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/revenue_facts/{revenue_fact}. |
uid | string | The fact's id: a hash of its source and external key. Output only. |
meta | ResourceMeta | Resource metadata. |
source | string | The source that reported it: orgs/{org}/revenue_sources/{id}. Output only. |
external_key | string | The source's own identity for the line. Output only. |
basis | string | booked, estimated or final. Output only. |
granularity | string | transaction, day or month. Output only. |
day | string | The source's reporting day; the first of the month for a month row. Output only. |
store_kind | string | stripe, app_store, google_play, ad_network or other. Output only. |
account_ref | string | The account the source reports for. Output only. |
product_ref | string | The product reference the source uses. Output only. |
sku | string | The store's item id. Output only. |
region_code | string | Buyer country (ISO 3166-1 alpha-2), where the source reports it. Output only. |
currency_code | string | ISO 4217 code of the amounts. Output only. |
gross | string | What the buyer paid. Output only. |
fee | string | The store's or processor's fee. Output only. |
tax | string | Tax. Output only. |
net | string | What the org earns. Output only. |
units | int64 | Items or orders, where reported. Output only. |
settled_on | string | The day the money reached the bank; empty until the source says so. 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. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.UNAVAILABLE— The Resource store, the owning service's backend, or the key verifier's snapshot is unavailable; retry after Retry-After.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/revenue_facts" \
-H "Authorization: Bearer $SYLPHX_API_KEY"