Reporting APIUpdated Jun 2

Endpoints

All endpoints are under https://api.applixir.com and require a client API key in the X-Api-Key (or Authorization: Bearer) header. See Authentication & Keys.

Common parameters

The two paged endpoints (/reports/by-country and /reports/countries) accept these query parameters:

Parameter	Type	Default	Description
`page`	int	`1`	Page number (1-based)
`pageSize`	int	`20`	Rows per page
`sortBy`	string	—	Field to sort by (e.g. `revenueAmount`, `country`)
`sortDirection`	string	`asc`	`asc` or `desc`

Date filters use the YYYY-MM-DD format (e.g. 2026-05-01). Omit them to use the account default range.

List sites

GET /api/v1/sites

Returns every site (game) on the account — or just the key's allowed sites if the key is site-scoped. Use the returned siteId values to filter the reporting endpoints.

Example

curl https://api.applixir.com/api/v1/sites \
  -H "X-Api-Key: axk_live_xxxxxxxxxxxxxxxx"

[
  {
    "siteId": "3f2c9b18-7a44-4c0e-9b1a-2d6f5e8c1a90",
    "name": "Word Tower",
    "url": "https://wordtower.example.com",
    "framework": "html5",
    "status": "live",
    "dailyActiveUsers": 42000,
    "monthlyActiveUsers": 610000,
    "createdAt": "2026-01-14T09:32:00Z"
  }
]

Field	Description
`siteId`	Unique site identifier — pass to `siteIds` on the reporting endpoints
`name`, `url`, `framework`	Site metadata
`status`	`live` (serving), `approved`, or `pending`
`dailyActiveUsers`, `monthlyActiveUsers`	Last reported DAU / MAU (may be null)
`createdAt`	When the site was added

Account totals

GET /api/v1/reports/totals

Headline totals across the account (or a filtered subset) for a date range.

Query parameters: siteIds (comma-separated siteId list — omit for all sites), fromDate, toDate.

Example

curl "https://api.applixir.com/api/v1/reports/totals?fromDate=2026-05-01&toDate=2026-05-31" \
  -H "X-Api-Key: axk_live_xxxxxxxxxxxxxxxx"

{
  "totalImpressions": 1842310,
  "totalRequests": 2153998,
  "averageCpm": 4.21,
  "totalRevenue": 7756.12,
  "fillRate": 0.855
}

Field	Description
`totalImpressions`	Ads successfully fetched and played
`totalRequests`	Ads requested
`averageCpm`	Effective revenue per 1,000 impressions (USD)
`totalRevenue`	Total earnings (USD)
`fillRate`	Impressions ÷ Requests (0–1)

Revenue by country

GET /api/v1/reports/by-country

Revenue and impressions aggregated by viewer country. Paged and filterable; honors the key's site scope.

Query parameters: siteIds, fromDate, toDate, plus the common paging parameters.

Example

curl "https://api.applixir.com/api/v1/reports/by-country?fromDate=2026-05-01&toDate=2026-05-31&sortBy=revenueAmount&sortDirection=desc" \
  -H "X-Api-Key: axk_live_xxxxxxxxxxxxxxxx"

{
  "data": [
    {
      "country": "US",
      "revenueAmount": 4120.55,
      "cpm": 6.80,
      "adRequests": 712430,
      "impressions": 605800,
      "fillRate": 0.85
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 20,
    "totalRows": 47,
    "totalPages": 3,
    "sortBy": "revenueAmount",
    "sortDirection": "desc"
  }
}

Per-site, country, day rows

GET /api/v1/reports/countries

The most granular feed: one row per site × country × day. This is the direct successor to the legacy /api/v1/revenues/countries?apiKey= feed and returns the identical row shape.

Account-level keys only

This feed does not yet support per-site filtering, so a site-scoped key returns 403. Use an account-level key, or use /reports/by-country for filterable country data.

Query parameters: the common paging parameters.

Example

curl "https://api.applixir.com/api/v1/reports/countries?page=1&pageSize=50" \
  -H "X-Api-Key: axk_live_xxxxxxxxxxxxxxxx"

{
  "data": [
    {
      "impressions": 18230,
      "clicks": 142,
      "adRequests": 21540,
      "cpm": 5.12,
      "revenueAmount": 93.34,
      "fillRate": 0.846,
      "country": "US",
      "createdAt": "2026-05-14T00:00:00Z",
      "updatedAt": "2026-05-15T03:10:00Z",
      "gameId": "3f2c9b18-7a44-4c0e-9b1a-2d6f5e8c1a90",
      "userId": "45e89eff-1f4b-4f4e-95f8-f92fcaf837ab",
      "adUnitId": "22793662433",
      "gameName": "Word Tower"
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 50,
    "totalRows": 1284,
    "totalPages": 26,
    "sortBy": null,
    "sortDirection": "asc"
  }
}

Field	Description
`gameId` / `gameName`	The site (`gameId` = `siteId`)
`country`	Viewer country (ISO code)
`impressions`, `clicks`, `adRequests`	Volume metrics
`cpm`, `revenueAmount`, `fillRate`	Effective CPM (USD), revenue (USD), fill rate (0–1)
`adUnitId`	The ad unit serving the site
`createdAt` / `updatedAt`	The reporting day and when the row was last updated

Common parameters​

List sites​

Account totals​

Revenue by country​

Per-site, country, day rows​

See also​

Common parameters

List sites

Account totals

Revenue by country

Per-site, country, day rows

See also