Tracking pixels
Create a tracking pixel
Create a provider tracking pixel or a custom tracking-code configuration.
POST
Create a tracking pixel
POST /v1/tracking-pixel creates a reusable tracking configuration in the
workspace bound to your API key. It requires Tracking pixels: Write
(tracking_pixels.create).
Choose one of the two request types in the API playground. Provider pixels and
custom code deliberately expose different fields.
custom does not appear in the provider type dropdown. Select the
Custom code tab above the request fields to create one.Create a provider pixel
Provider pixels requirename, type, and pixel_id.
For these types, send the provider value in
pixel_id. Do not send
head_code or body_code. Biqli handles the provider integration and stores
both code fields as null.
Create custom code
Usetype: "custom" only when you need to supply your own tracking snippet.
Provide head_code, body_code, or both.
pixel_id for a custom pixel. Biqli stores it as null.
Field rules
A custom pixel must contain at least one non-empty code field. Unknown fields
are rejected.
Response and errors
Success returns201 Created with the complete pixel resource. Its ID starts
with biq_pxl_. Pixel names must be unique inside the workspace.
409 pixel_name_takenmeans another workspace pixel already uses the name.422 validation_errormeans the selected type is invalid, a required field is missing, or the request mixes provider and custom fields.403 insufficient_scopemeans the API key does not havetracking_pixels.create.
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
A workspace API key beginning with biqli_.
Body
application/json
- Provider pixel
- Custom code
Required string length:
3 - 80Available options:
facebook, twitter, google-tag-manager, google-analytics, adwords, bing, pinterest, linkedin, quora, adroll, nexus-segment Provider-issued pixel, tag, or account identifier.
Required string length:
1 - 200
