Hypertrack, Inc

Customize ops dashboard views

HyperTrack offers you a number of options that allow you to create customizations for ops dashboard views and actively continues to add many more in the future.

Customize ops dashboards with url query parameters

The ops dashboard URL experience can be modified with the following query parameters appended to the embed URL listed as follows:

https://embed.hypertrack.com/devices?publishable_key=...&<query_param_name>=<value>

Custom layer

This parameter offers you options to customize map layer used to render the ops view experience. The custom layer denotes an encoded raster tile layer that you can create and inject into the ops view.

For example:

https://embed.hypertrack.com/devices?publishable_key=...&custom_layer=<my_raster_tyle>

Layer

This parameter offers you options to customize map layer used to render the share URL experience. The layer parameter can have the following values:

  • base - default choice for the share URL
  • street - additional street detail is shown in the map
  • satellite - satellite view is used as shown in an example below

For example:

https://embed.hypertrack.com/devices?publishable_key=...&layer=street

Icon

This parameter offers you options to customize how your tracked device appears on the map. The icon parameter can have the following values:

  • car
  • bus
https://embed.hypertrack.com/devices?publishable_key=...&icon=car

Publishable key

You should use publishable_key value associated with your account that can be retrieved from the Setup page.

Metadata filter

https://embed.hypertrack.com/devices?publishable_key=...&metadata=<metadata_filter>

Device metadata can be used to create restricted views for subsets of tracked devices.

Please refer to this guide for more information on this topic.

Select trips by their metadata

Trip metadata can be used to create restricted views for subsets of tracked devices and matching trips.

https://embed.hypertrack.com/devices?publishable_key=...&trip_metadata_filter=car

Trip card metadata key

Replaces replaces geofence name with tripcard_metadata_key value in the trip view

https://embed.hypertrack.com/devices?publishable_key=...&tripcard_metadata_key=<value>

Geotag sequence key

This parameter replaces geotag squence number with geotag_sequence_key value.

https://embed.hypertrack.com/devices?publishable_key=...&geotag_sequence_key=car

Trip sequence key

This parameter replaces trip sequence number with trip_sequence_key value.

https://embed.hypertrack.com/devices?publishable_key=...&trip_sequence_key=<trip_sequence_key>

Marker metadata

This parameter limits geotag marker popup content to metadata.

https://embed.hypertrack.com/devices?publishable_key=...&marker_metadata_only=true

Map only

This parameter hides timeline card by default.

https://embed.hypertrack.com/devices?publishable_key=...&map_only=true

Disable history and date selector

This parameter disables device history and date selector as shown below.

https://embed.hypertrack.com/devices?publishable_key=...&history=false

Hide back navigation button

This option removes the back button in the embed view.

https://embed.hypertrack.com/devices?publishable_key=...&back=car

Set the date selection for the ops view

Sets the date of choice for the ops view.

https://embed.hypertrack.com/devices?publishable_key=...&from_date=<date>

For example:

https://dashboard.hypertrack.com/devices?from_date=2020-09-01

Set timezone

Sets the timezone for the ops view.

https://embed.hypertrack.com/devices?publishable_key=...&timezone=<timezone_value>

For example:

https://embed.hypertrack.com/devices?from_date=2020-09-01&timezone=America__Los_Angeles&layer=street

Hide search button

Hides search button from the devices view.

https://embed.hypertrack.com/devices?publishable_key=...&hide_search=true

Auto select a trip view

Automatically selects a trip based on the lastest started_at date.

https://embed.hypertrack.com/devices?publishable_key=...&auto_select

Trip complete

This parameter will remove an option to complete a trip via a button on the ops dashboard page for an active trip view.

https://embed.hypertrack.com/devices?publishable_key=...&trip_complete=false

Export option

This parameter will remove export button for device history data from ops dashboards.

https://embed.hypertrack.com/devices?publishable_key=...&export=false

Hide rating

This parameter will hide star rating in the leaderboard page.

https://embed.hypertrack.com/leaderboard?publishable_key=...&hide_rating

Questions?

If you have any questions or comments about customizations, please do not hesitate to contact us.