Skip to main content

Get Report

Retrieve detailed information about a specific report.

Endpoint

GET /api/reports/{reportId}

Headers

Authorization
string
required
Bearer token for authentication

Path Parameters

reportId
string
required
Report UUID

Response

id
string
Report UUID
websiteId
string
Website UUID
userId
string
User who created the report
type
string
Report type
name
string
Report name
description
string
Report description
parameters
object
Report-specific parameters
createdAt
string
ISO 8601 timestamp of creation
updatedAt
string
ISO 8601 timestamp of last update

Example Request

curl https://your-umami-instance.com/api/reports/dd0e8400-e29b-41d4-a716-446655440008 \
  -H "Authorization: Bearer YOUR_TOKEN"

Example Response

{
  "id": "dd0e8400-e29b-41d4-a716-446655440008",
  "websiteId": "550e8400-e29b-41d4-a716-446655440000",
  "userId": "660e8400-e29b-41d4-a716-446655440001",
  "type": "funnel",
  "name": "Checkout Funnel",
  "description": "Track users through checkout process",
  "parameters": {
    "startDate": "2024-03-01T00:00:00.000Z",
    "endDate": "2024-03-31T23:59:59.999Z",
    "window": 30,
    "steps": [
      {"type": "path", "value": "/cart"},
      {"type": "path", "value": "/checkout"},
      {"type": "event", "value": "purchase"}
    ]
  },
  "createdAt": "2024-03-01T10:00:00.000Z",
  "updatedAt": "2024-03-05T14:20:00.000Z"
}

Error Responses

401
error
Unauthorized - You don’t have permission to view this report
404
error
Not Found - Report does not exist
You must have view permissions for the website that owns this report.

Build docs developers (and LLMs) love