Get Reports
Retrieve a list of saved reports for a specific website.
Endpoint
Bearer token for authentication
Query Parameters
Website UUID to retrieve reports for
Filter by report type. Must be one of:
attributionbreakdownfunnelgoaljourneyretentionrevenueutm
Page number for pagination (default: 1)
Number of results per page
Search term to filter reports by name
Response
Array of report objects
User who created the report
Report name (max 200 characters)
Report description (max 500 characters)
Report-specific parameters (varies by type)
ISO 8601 timestamp of creation
ISO 8601 timestamp of last update
Example Request
curl "https://your-umami-instance.com/api/reports?websiteId=550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_TOKEN"
Example Response
{
"data": [
{
"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-01T10:00:00.000Z"
},
{
"id": "ee0e8400-e29b-41d4-a716-446655440009",
"websiteId": "550e8400-e29b-41d4-a716-446655440000",
"userId": "660e8400-e29b-41d4-a716-446655440001",
"type": "goal",
"name": "Newsletter Signups",
"description": "Track newsletter subscription goal",
"parameters": {
"startDate": "2024-03-01T00:00:00.000Z",
"endDate": "2024-03-31T23:59:59.999Z",
"type": "event",
"value": "newsletter-signup"
},
"createdAt": "2024-03-02T14:30:00.000Z",
"updatedAt": "2024-03-02T14:30:00.000Z"
}
],
"count": 2,
"page": 1,
"pageSize": 20
}
Error Responses
Unauthorized - You don’t have permission to view this website’s reports
You must have view permissions for the website to retrieve its reports.