Skip to main content
GET
Retrieve a tracking pixel
GET /v1/tracking-pixel/{pixel_id} requires Tracking pixels: Read (tracking_pixels.view). The response includes id, name, type, pixel_id, head_code, body_code, links_count, and timestamps. Provider pixels return a pixel_id with both code fields set to null. Custom pixels return pixel_id: null and their configured code fields. Because custom code is returned, give this permission only to trusted integrations. Unavailable biq_pxl_... IDs return 404 resource_not_found.

Shared API behavior

Authentication is workspace-scoped; see Authentication. Errors use the standard envelope and request IDs described in Errors, and requests are subject to Rate limits.

Authorizations

Authorization
string
header
required

A workspace API key beginning with biqli_.

Path Parameters

pixel
string
required
Pattern: ^biq_pxl_[0-9A-HJKMNP-TV-Z]{26}$

Response

Pixel.

pixel
object
required
status
string
required
Allowed value: "success"