Update Report
Update the configuration of an existing report.
Endpoint
POST /api/reports/{reportId}
Bearer token for authentication
Path Parameters
Request Body
Report type (cannot be changed to a different type)
Updated report name (max 200 characters)
Updated report description (max 500 characters)
Updated report-specific parameters
All fields must be provided, even if only updating some values. The report type-specific parameter requirements must be met.
Response
User who last updated the report
Updated report description
Updated report parameters
ISO 8601 timestamp of update
Example Request
curl -X POST https://your-umami-instance.com/api/reports/dd0e8400-e29b-41d4-a716-446655440008 \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"websiteId": "550e8400-e29b-41d4-a716-446655440000",
"type": "funnel",
"name": "Updated Checkout Funnel",
"description": "Enhanced checkout tracking",
"parameters": {
"startDate": "2024-04-01T00:00:00.000Z",
"endDate": "2024-04-30T23:59:59.999Z",
"window": 30,
"steps": [
{"type": "path", "value": "/products"},
{"type": "path", "value": "/cart"},
{"type": "path", "value": "/checkout"},
{"type": "event", "value": "purchase"}
]
}
}'
Example Response
{
"id": "dd0e8400-e29b-41d4-a716-446655440008",
"websiteId": "550e8400-e29b-41d4-a716-446655440000",
"userId": "660e8400-e29b-41d4-a716-446655440001",
"type": "funnel",
"name": "Updated Checkout Funnel",
"description": "Enhanced checkout tracking",
"parameters": {
"startDate": "2024-04-01T00:00:00.000Z",
"endDate": "2024-04-30T23:59:59.999Z",
"window": 30,
"steps": [
{"type": "path", "value": "/products"},
{"type": "path", "value": "/cart"},
{"type": "path", "value": "/checkout"},
{"type": "event", "value": "purchase"}
]
},
"updatedAt": "2024-03-15T16:45:00.000Z"
}
Error Responses
Unauthorized - You don’t have permission to update this report
Not Found - Report does not exist
You must have update permissions for the website that owns this report.