Analytics

Accounting analytics

Realized revenue over the period (the Reports page "Finance" tab): revenue excl. tax of confirmed events dated by the event's start date (in the event's time zone), cancellation fees included and dated by the cancellation. An event's amount is its confirmed amount, else its latest accepted/signed quote, else the accepted platform amount; coverage says how many confirmed events have one. Also returns the current calendar year outlook (realized, booked ahead, forecast with an 80 % range).

Changed in 1.3.0: monthly_accounting is kept (count and revenue per event month, months with events only) but follows the period and amount rules above. Role permission: reports.view.

get/analytics/accounting

Request

  • Base URL: https://joinways.app/api/v1
  • URL: https://joinways.app/api/v1/analytics/accounting
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://joinways.app/oauth/authorize, token URL https://joinways.app/api/oauth/token, scopes: mcp.read)

Query parameters

fromstring date
Example:2026-01-01

First day included (YYYY-MM-DD, workspace time zone). Give together with to; without both, the period is the last 6 full months plus the current month (as on the Reports page). A full ISO timestamp is accepted and only its date is kept. Periods longer than 7 years are shortened to the 7 years ending on to; the effective period is echoed in period.

tostring date
Example:2026-06-30

Last day included (YYYY-MM-DD). Give together with from.

venuesstring
Example:8f1c2a4e-…,3a90b1c2-…

Comma-separated venue ids (GET /venues) to restrict the report to. Omit for all venues. An id that is not a venue of the workspace is refused with 400.

compare'year' | 'previous' | 'none'

Comparison period: year (default) = the same days one year earlier; previous = the period of the same length just before; none = no comparison (every previous value is null).

Response

Finance metrics for the period.

venue_idsstring[] nullable

Venue filter applied; null = all venues.

currencystring

Workspace currency of every amount (amounts are excl. tax, 2 decimals).

monthly_accountingobject

Legacy — YYYY-MM → events and revenue of that event month (months with events only).

Example response

{
  "period": {
    "timezone": "Europe/Paris"
  },
  "monthly": [
    {
      "month": "2026-07"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.