Pixel API
Detailed technical description of the RudderStack Pixel API to track and capture event data efficiently.
The RudderStack Pixel API allows you to track your customer event data from anywhere and route it to your desired destinations.
This API is very useful in scenarios where making a POST request is not possible. Some examples include tracking email addresses and page views where POST requests don't add or append any value.
Sending a page
call to RudderStack
page
call to RudderStackURL
/pixel/v1/page
Method
GET
URL Parameters:
Required
Optional
context.library.name
context.library.version
context.platform
context.locale
context.userAgent
context.screen.width
context.screen.height
context.page.path
context.page.url
context.page.referrer
context.page.title
properties. ...
Data Parameters
None
Success Response
Code:
200
Content:
OK
Error Response
Code:
400 Bad Request
Content:
error string
A sample call is as shown below:
For this endpoint, RudderStack expects that the basic page view properties like path
, url
, referrer
, title
be passed either with context.page.<page_basic_properties>
or with properties.<page_basic_properties>
.
The dot (.
) separated query parameters are mapped by RudderStack to a familiar page
payload before sending them to the destinations.
Note that for this endpoint, RudderStack does not currently support overriding the integration
key for sending data to selective destinations.
Sending a track
call to RudderStack
track
call to RudderStackURL
/pixel/v1/track
Method
GET
URL Parameters:
Required
Optional
context.library.name
context.library.version
context.platform
context.locale
context.userAgent
context.screen.width
context.screen.height
context.page.path
context.page.url
context.page.referrer
context.page.title
properties. ...
Data Parameters
None
Success Response
Code:
200
Content:
OK
Error Response
Code:
400 Bad Request
Content:
error string
A sample call is as shown below:
For this endpoint, RudderStack expects the basic page
view properties like path
, url
, referrer
, and title
to be passed with context.page.<page_basic_properties>
. The event-related properties should be sent as properties.<
key1
>=${value}
.
The dot (.
) separated query parameters are mapped by RudderStack to a familiar track
payload before being sent to destinations.
Note that for this endpoint, RudderStack currently does not support overriding the integration
key for sending the data to selective destination.
Contact Us
To know more about the Pixel API spec, please feel free to contact us. You can also start a conversation in our Slack community. We will be happy to help you.
Last updated
Was this helpful?