Skip Main Navigation
Page Content

Tracking Beacons

POST /tracking_beacons/

Makes a new tracking beacon. Returns an tracking_beacon as tracking_beacon. Either event_id or user_id is required for each tracking beacon. If the event_id is provided, the tracking pixel will fire only for that event. If the user_id is provided, the tracking pixel will fire for all events organized by that user.

Parameters

Name Type Required Description
tracking_type string Yes The tracking pixel third party type. Allowed types are: Facebook Pixel, Twitter Ads, AdWords, Google Analytics, Simple Image Pixel, Adroll iPixel
event_id string No The Event ID of the event that this tracking beacon will fire in
user_id string No The User ID wherein the tracking beacon will be assigned to all of this user’s events
pixel_id string No The Pixel ID given by the third party that will fire when a attendee lands on the page you are tracking
triggers dict No The additional pixel data needed to determine which page to fire the tracking pixel on

Errors

No endpoint-specific errors

Argument Errors

  • tracking_beacon.event_id - INVALID: This is not a valid event.
  • tracking_beacon.user_id - INVALID: This is not a valid user.

GET /tracking_beacons/:tracking_beacons_id/

Returns the tracking_beacon with the specified :tracking_beacons_id.

Parameters

Name Type Required Description
return_fmt string No returned format

Errors

No endpoint-specific errors

POST /tracking_beacons/:tracking_beacons_id/

Updates the tracking_beacons with the specified :tracking_beacons_id. Though event_id and user_id are not individually required, it is a requirement to have a tracking beacon where either one must exist. Returns an tracking_beacon as tracking_beacon.

Parameters

Name Type Required Description
tracking_type string Yes The tracking pixel third party type. Allowed types are: Facebook Pixel, Twitter Ads, AdWords, Google Analytics, Simple Image Pixel, Adroll iPixel
event_id string No The Event ID of the event that this tracking beacon will fire in
user_id string No The User ID wherein the tracking beacon will be assigned to all of this user’s events
pixel_id string No The Pixel ID given by the third party that will fire when a attendee lands on the page you are tracking
triggers dict No The additional pixel data needed to determine which page to fire the tracking pixel on

Errors

No endpoint-specific errors

DELETE /tracking_beacons/:tracking_beacons_id/

Delete the tracking_beacons with the specified :tracking_beacons_id.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

GET /events/:event_id/tracking_beacons/

Returns the list of tracking_beacon for the event :event_id

Parameters

Name Type Required Description
return_fmt string No returned format

Errors

No endpoint-specific errors

GET /users/:user_id/tracking_beacons/

Returns the list of tracking_beacon for the user :user_id

Parameters

Name Type Required Description
return_fmt string No returned format

Errors

No endpoint-specific errors