Analytics

Reports overview

The Reports page overview, on fixed windows relative to today (only venues applies): signed revenue month to date against the same days one year earlier, monthly goal progress, revenue booked from today to the end of the 6th month, open pipeline, win rate over the last 12 months against the 12 before, median first response time over the last 30 days against the 90 before, up to 3 computed insights, action items and a 12-month trend with a 3-month forecast. Role permission: reports.view.

get/analytics/overview

Request

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

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.

Response

Overview of the workspace.

todaystring date
timezonestring
venue_idsstring[] nullable
currencystring
goal_missing_venuesinteger

Venues shown without a goal this month while others have one. goal is then null (incomplete goal).

insightsobject[]

Up to 3 computed findings, each with kind (venueDriver, sourceVolume, venueConversion, responseTime), tone (up/down), weight and kind-specific fields (location_id, source_key, delta, share, recent, baseline, change, recent_pct, baseline_pct, closed, recent_minutes, baseline_minutes).

Example response

{
  "month": {
    "month": "2026-09"
  }
}

Changes

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