Get Pixels
Retrieve all tracking pixels that the authenticated user has created or has access to through teams.
Endpoint
Bearer token for authentication
Query Parameters
Page number for pagination (default: 1)
Number of results per page
Search term to filter pixels by name
Response
Array of pixel objects
Pixel name (max 100 characters)
Unique pixel slug (max 100 characters)
Owner user UUID (for personal pixels)
Team UUID (for team pixels)
ISO 8601 timestamp of creation
ISO 8601 timestamp of last update
Example Request
curl "https://your-umami-instance.com/api/pixels?page=1&pageSize=20" \
-H "Authorization: Bearer YOUR_TOKEN"
Example Response
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Email Campaign Tracker",
"slug": "email-campaign",
"userId": "660e8400-e29b-41d4-a716-446655440001",
"teamId": null,
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z"
},
{
"id": "770e8400-e29b-41d4-a716-446655440002",
"name": "Newsletter Tracker",
"slug": "newsletter",
"userId": null,
"teamId": "880e8400-e29b-41d4-a716-446655440003",
"createdAt": "2024-02-20T14:45:00.000Z",
"updatedAt": "2024-02-20T14:45:00.000Z"
}
],
"count": 2,
"page": 1,
"pageSize": 20
}
Tracking pixels are 1x1 transparent images used to track email opens, page views, and other events where JavaScript tracking isn’t available.