Skip to main content
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 require name, type, and pixel_id.
Supported provider types are: 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

Use type: "custom" only when you need to supply your own tracking snippet. Provide head_code, body_code, or both.
Do not send pixel_id for a custom pixel. Biqli stores it as null.
Custom code can execute on pages where the tracking configuration is used. Only add code that you understand and trust.

Field rules

A custom pixel must contain at least one non-empty code field. Unknown fields are rejected.

Response and errors

Success returns 201 Created with the complete pixel resource. Its ID starts with biq_pxl_. Pixel names must be unique inside the workspace.
  • 409 pixel_name_taken means another workspace pixel already uses the name.
  • 422 validation_error means the selected type is invalid, a required field is missing, or the request mixes provider and custom fields.
  • 403 insufficient_scope means the API key does not have tracking_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

Authorization
string
header
required

A workspace API key beginning with biqli_.

Body

application/json
name
string
required
Required string length: 3 - 80
type
enum<string>
required
Available options:
facebook,
twitter,
google-tag-manager,
google-analytics,
adwords,
bing,
pinterest,
linkedin,
quora,
adroll,
nexus-segment
pixel_id
string
required

Provider-issued pixel, tag, or account identifier.

Required string length: 1 - 200

Response

Pixel created.

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