Skip to main content

​
Get Pixel

Retrieve detailed information about a specific tracking pixel.

​
Endpoint

GET /api/pixels/{pixelId}

​
Headers

​
Authorization
string
required
Bearer token for authentication

​
Path Parameters

​
pixelId
string
required
Pixel UUID

​
Response

​
id
string
Pixel UUID
​
name
string
Pixel name
​
slug
string
Pixel slug
​
userId
string
Owner user UUID (null for team pixels)
​
teamId
string
Team UUID (null for personal pixels)
​
createdAt
string
ISO 8601 timestamp of creation
​
updatedAt
string
ISO 8601 timestamp of last update

​
Example Request

curl "https://your-umami-instance.com/api/pixels/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Example Response

{
  "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-02-20T14:15:00.000Z"
}

​
Error Responses

​
401
error
Unauthorized - You don’t have permission to view this pixel
​
404
error
Not Found - Pixel does not exist
You must have view permissions for the pixel. This includes being the owner or a team member for team pixels.

Build docs developers (and LLMs) love

Get started for freeTalk to us