---
title: "Funnel event counts"
method: GET
path: "/reports/events"
---

# Funnel event counts

`GET /reports/events`

## Request

- Base URL: `https://api.web2wave.com/api`
- URL: `https://api.web2wave.com/api/reports/events`
- Auth: API key in header `api_key`

Counts of the funnel events per time bucket and/or per quiz, quiz version, paywall,
paywall version and payment system, read straight from the event log.

Each row has, for every event, the number of events (`<name>`) and the number of unique users
(`<name>_users`):
`paywall_view` (`CompleteRegistration` / `Quiz finished`, the same definition as the cabinet
Overview), `initiate_checkout` (`InitiateCheckout`), `add_payment_info` (`AddPaymentInfo`) and
`subscribe` (`Subscribe`).

`from`/`to` accept a date (whole day in the project timezone) or a date-time with an exact time
(`2026-10-01T16:00:00Z`). Defaults to the last 24 hours; the range is limited to 93 days.
`hour` / `day` buckets are in UTC. `payment_system` is read from the `payment_system` property of
the event and is empty when the event does not carry it.
Without `group_by` a single total row is returned.

## Query parameters

- `from` string, date-time
- `to` string, date-time
- `group_by` string
- `quizzes` string
- `paywalls` string

## Headers

- `api_key` string, required

## Response `200`

Event counts

- object
  - `success` boolean
  - `from` string, date-time
  - `to` string, date-time
  - `group_by` string[]
  - `truncated` boolean: True when more than 5000 rows matched and the result was cut.
  - `data` object[]

## Other responses

- `422`: Unknown `group_by` value, invalid date range or range over 93 days.

## Changes

- **2026-11-03** `eb8b2d9124ac`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/web2wave/apis/web2wave-api/changes/reports/events/get.md)

---

[API](https://skmtc.dev/web2wave/apis/web2wave-api.md) - [All operations](https://skmtc.dev/web2wave/apis/web2wave-api/llms.txt) - [OpenAPI document](https://skmtc.dev/web2wave/apis/web2wave-api/revisions/eb8b2d9124ac?raw)
