TV Squared Destination

Segment makes it easy to send your data to TV Squared (and lots of other destinations). Once you've tracked your data through our open source libraries we'll translate and route your data to TV Squared in the format they understand. Learn more about how to use TV Squared with Segment.

Getting Started

When you toggle on TV Squared in Segment, this is what happens:

  • Our CDN is updated within 5-10 minutes. Then our snippet will start asynchronously loading TV Squared’s JavaScript onto your page. This means you should remove TV Squared’s snippet from your page.
  • TV Squared will start automatically recording events.


When you call page in Analytics.js, we call TV Squared’s Basic Hit Tracker. This should be fired on every page.


When you call track in Analytics.js, we call TV Squared’s Action Tracker. Along with the event name, you can specify a dictionary of properties that will get sent to TV Squared. TV Squared requires revenue, productType, orderId, and promo passed through each call. An example call will look like:

analytics.track('Completed Purchase', {
  revenue: 42.99,
  promo: 'COUPON1',
  orderId: '12345',
  productType: 'Clothing'

Since TV Squared requires revenue, promo, orderId, and productType on each call, you can pass in an empty string to send in an event that may not have a value for the aforementioned properties.

Custom Track Properties

In addition, you can set up your destination to pass in any number of custom properties with your call! For example, you could expand the above example to also look like the following:

analytics.track('Completed Purchase', {
  revenue: 42.99,
  promo: 'COUPON1',
  orderId: '12345',
  productType: 'Clothing',
  listViewed: 'Fashion',
  browser: 'Chrome'

In order to take advantage of this ability, there are two Custom Settings in your TV Squared settings: ‘Custom Metrics’ and ‘Send All Properties’.

Selecting ‘Custom Metrics’ will let you put in the specific additional metrics you want to send (the required properties are already sent automatically). For example, you could input listViewed and browser.

Selecting ‘Send All Properties’ will send all properties from your track call. This is overwritten if you have any Custom Metrics defined, so make sure that your Custom Metric whitelist is empty and saved, if you wish to use this option!

Supported Sources and Connection Modes

📱 Device-based
☁️ Cloud-based

To learn more about about Connection Modes and what dictates which we support, see here.


Segment lets you change these destination settings via your Segment dashboard without having to touch any code.

Brand Id

Enter your TV Squared brand id

Client ID

Your TV-Squared client ID. This is used to load the TVSquared script onto your page.

Custom Metrics

Add any additional custom properties you’d like to check, separated by a line break.

Event Whitelist

This is where you will define which specific events, when sent via analytics.track(your_event_name, …) will be sent to TVSquared. For example, if you want analytics.track(‘Order Completed’) and analytics.track(‘Sale’) events to be sent, then add Order Completed and Sale to this list.

If you have any questions or see anywhere we can improve our documentation, please let us know or kick off a conversation in the Segment Community!