Analytics

Responsiveness analytics

First response to the client for inquiries received over the period (the Reports page "Responsiveness" tab). The first response is the earliest platform reply, quote sent, email sent or information request after reception; failing that, the accept/reject in Joinways (counted as fallback). Delays are counted in each venue's business hours (closures deducted; a venue without opening hours counts 9:00 – 19:00 every day in the workspace time zone). Role permission: reports.view.

get/analytics/responsiveness

Request

  • Base URL: https://joinways.app/api/v1
  • URL: https://joinways.app/api/v1/analytics/responsiveness
  • 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

Response-time 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).

venues_with_hoursinteger
venues_showninteger

Example response

{
  "period": {
    "timezone": "Europe/Paris"
  },
  "arrivals": {
    "slot_hours": 2
  }
}

Changes

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