umami-reports

Umami Reports

Create and run all 8 Umami report types via the API. Read operations execute directly. Write operations (create, update, delete) ask for confirmation first.

Prerequisites

Read .umami.json from project root for host, websiteId, token. If missing, invoke bvdr:umami-setup.

Report CRUD

List reports

curl -s "{host}/api/reports?websiteId={websiteId}" \
  -H "Authorization: Bearer {token}"

Create report (confirm first)

curl -s -X POST "{host}/api/reports" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "websiteId": "{websiteId}",
    "type": "{reportType}",
    "name": "{reportName}",
    "description": "{description}",
    "parameters": { ... }
  }'

Get report

curl -s "{host}/api/reports/{reportId}" \
  -H "Authorization: Bearer {token}"

Update report (confirm first)

Note: Umami uses POST for updates (not PUT). Verify against your instance version at implementation time.

curl -s -X POST "{host}/api/reports/{reportId}" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{ "name": "...", "parameters": { ... } }'

Delete report (confirm first)

curl -s -X DELETE "{host}/api/reports/{reportId}" \
  -H "Authorization: Bearer {token}"

---

Report Types

Funnel

Track sequential step completion with drop-off rates.

curl -s -X POST "{host}/api/reports/funnel" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "websiteId": "{websiteId}",
    "startDate": "2026-01-01T00:00:00Z",
    "endDate": "2026-03-12T23:59:59Z",
    "timezone": "Europe/Bucharest",
    "window": 60,
    "steps": [
      { "type": "path", "value": "/pricing" },
      { "type": "path", "value": "/signup" },
      { "type": "event", "value": "purchase-complete" }
    ]
  }'

• steps — minimum 2. Each step has type (path or event) and value
• window — time window in minutes a user has between funnel steps to count as a conversion
• Steps must be completed in order (other pages can be visited between steps)
• Output: step completion counts and drop-off rates