Pixels

Get a tracking pixel

GET/api/pixels/{pixelId}

Returns the specified tracking pixel and its configuration.

Try it

Headers

Name	Type	Description
Authorizationrequired	string	Token returned by POST /api/auth/login, or an API key (`umami_…`) created under Settings → API keys (self-hosted only). `Bearer <token>`.
x-umami-share-contextrequired	string	Required context header when authenticating with a share token. `<api-key>`.
x-umami-share-tokenrequired	string	Signed token returned by a share endpoint. `<api-key>`.

Path parameters

Name	Type	Description
pixelIdrequired	string	ID of the tracking pixel.

Responses

200The operation completed successfully.

Name	Type	Description
createdAtrequired	string	Date and time the record was created.
deletedAtrequired	string	Date and time the record was deleted, if applicable.
idrequired	string	Unique identifier of the resource.
namerequired	string	Display name of the resource.
slugrequired	string	URL slug used to access the resource.
teamIdrequired	string	ID of the associated team.
updatedAtrequired	string	Date and time the record was last updated.
userIdrequired	string	ID of the associated user.

200 example

{
  "createdAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "id": "string",
  "name": "string",
  "slug": "string",
  "teamId": "string",
  "updatedAt": "2024-01-15T09:30:00Z",
  "userId": "string"
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

Code samples

cURL

curl -X GET 'https://api.example.com/api/pixels/{pixelId}' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-umami-share-context: <api-key>' \
  -H 'x-umami-share-token: <api-key>'

PreviousDelete a tracking pixel NextGet visitor charts for tracking pixels