Documentation Index
Fetch the complete documentation index at: https://docs.scaleo.io/llms.txt
Use this file to discover all available pages before exploring further.
The Public API uses a path-based version prefix.
| Version | Status | Prefix |
|---|
| v2 | Stable, default | /api/v2/... |
| v3 | Reporting metadata, additive over v2 | /api/v3/... |
Why two versions exist
v3 exposes metadata endpoints that describe which columns and breakdowns are
available for the current user role — useful for building dynamic report UIs.
Affiliate v3 endpoints
| Path | Returns |
|---|
/api/v3/affiliate/reports/statistics/options | Statistics column options |
/api/v3/affiliate/reports/statistics/breakdowns | Statistics breakdowns |
/api/v3/affiliate/reports/conversions/options | Conversions column options |
/api/v3/affiliate/reports/clicks/options | Clicks column options |
Advertiser v3 endpoints
| Path | Returns |
|---|
/api/v3/advertiser/reports/statistics/options | Statistics column options |
/api/v3/advertiser/reports/statistics/breakdowns | Statistics breakdowns |
/api/v3/advertiser/reports/conversions/options | Conversions column options |
/api/v3/advertiser/reports/conversions/columns | Conversions columns (alias) |
/api/v3/advertiser/reports/clicks/options | Clicks column options |
/api/v3/brand/... is an alias for /api/v3/advertiser/.... Use the prefix
that matches the role of your API key.
Compatibility policy
- Additive changes (new fields, new endpoints) can appear without notice.
Clients must tolerate unknown fields.
- Breaking changes require a new major version (v4), announced with a
minimum 6-month deprecation window.
Version detection
There is no explicit version response header. Derive the version from the
request path (/api/v2/ vs /api/v3/).