Pixels

Create a tracking pixel

POST/api/pixels

Creates a tracking pixel with a name and slug, optionally assigned to a team.

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>`.

Request body

Name	Type	Description
id	string \| null	Unique identifier of the resource.
namerequired	string	Display name of the resource.
slugrequired	string	URL slug used to access the resource.
teamId	string \| null	ID of the associated team.

Example request

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "slug": "string",
  "teamId": "string"
}

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"
}

400Bad request.

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

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

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 POST 'https://api.example.com/api/pixels' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "slug": "string",
  "teamId": "string"
}'

PreviousCreate a share for a tracking pixel NextDelete a tracking pixel