Inquiry analytics
Inquiries received over the period (the Reports page "Inquiries" tab): received, accepted, rejected, pending, quoted and confirmed counts, acceptance rate (accepted / received) and win rate (confirmed / received, reception cohort), monthly series, breakdown by source and by venue, processing times. Inquiries are dated by their reception.
Changed in 1.3.0: this endpoint used to count events by status and by event month over a fixed 12-month window. It now reports inquiries with the page's definitions; the legacy analytics map is kept but holds inquiry counts per reception month. Role permission: reports.view.
Request
- Base URL: https://joinways.app/api/v1
- URL: https://joinways.app/api/v1/analytics/events
- 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
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.
Last day included (YYYY-MM-DD). Give together with from.
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.
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
Inquiry metrics for the period.
Example response
{
"period": {
"timezone": "Europe/Paris"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.