Guides

Legacy Customization Options

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/tracking?publishable_key=...&<query_param_name>=<value>

:::tip
You may find it helpful when building URL params to use a browser extension such as Search API Query String Parser (Chrome).
NOTE: Use caution when installing browser extensions. In Chrome, you may use an isolated or guest profile to safegaurd your data.
:::

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/tracking?publishable_key=...&custom_layer=<my_raster_tile>

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/tracking?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
  • bike
  • bus
https://embed.hypertrack.com/tracking?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/tracking?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/tracking?publishable_key=...&trip_metadata_filter=<url_encoded_trip_metadata_filter>

trip_metadata_filter can either be a JSON object or a JSONPath expression.
The parameter needs to be url encoded to avoid breaking the URL.

JSON

The JSON of the trip_metadata_filter needs to be a subset of the trip metadata to pass the filter.

For example, a trip with metadata {"business": "ACME", "driver_id":"12345-678"} passes trip_metadata_filter of {"business": "ACME"}. This filter would show you all the trips that have "business": "ACME" in their metadata in your account.

JSONPath

To support more complex operations, JSONPath expressions can be used. The JSONPath expression needs to return an item at this path to pass the filter.

A use case is to filter trip that have business name ACME or Wonka with trip metadata like {"business": "ACME", "driver_id":"12345-678"}.
This can be implemented by this JSONPath expression: $.business ? (@=="ACME" || @=="Wonka").

Trip card metadata key

Replaces geofence name with tripcard_metadata_key value in the trip view

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

Geotag sequence key

This parameter replaces geotag squence number with geotag_sequence_key value.

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

Trip sequence key

This parameter replaces trip sequence number with trip_sequence_key value.

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

Tooltip key

This parameter adds values of comma separated user profile keys to the app user marker tooltip.

https://embed.hypertrack.com/tracking?publishable_key=...&tooltip_key=<tooltip_key>

For example:

https://embed.hypertrack.com/tracking?publishable_key=...&tooltip_key=id.city.vehicle_type

Marker metadata

This parameter limits geotag marker popup content to metadata.

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

Map only

This parameter hides timeline card by default.

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

Hide controls

(Map list view only) When used in combination with map_only and the oher hide flags, this parameter hides the remaining UI control elements to produce a simplified map list view.

https://embed.hypertrack.com/tracking?publishable_key=...&hide_controls=true

Default map center

This parameter sets the default map center and zoom level(1 to 21) with comma separated values(lat,long,zoom) for aggregate views by default.

https://embed.hypertrack.com/tracking?publishable_key=...&default_map_center=37.794993,-122.4008685,13

Hide back navigation button

This option removes the back button in the embed view.

https://embed.hypertrack.com/tracking?publishable_key=...&back=false

Hide trip metadata tag

This option hides trip metadata tags shown in aggregate view.

https://embed.hypertrack.com/tracking?publishable_key=...&hide_trip_metadata_tag=true

Set the date selection for the ops view

Sets the date of choice for the ops view.

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

For example:

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

Set timezone

Sets the timezone for the ops view.

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

For example:

https://embed.hypertrack.com/tracking?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/tracking?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/tracking?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/tracking?publishable_key=...&trip_complete=false

Export option

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

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

Hide nav

This parameter will hide the controls for navigating between ops views.

https://embed.hypertrack.com/insights?publishable_key=...&hide_nav=true

Hide rating

This parameter will hide star rating in the insights page.

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

Hide fences

Hide geofences in the customer live tracking view (https://trck.at/{code}).
This can be used to reduce fraudulent driver activity, by hiding the boundary of the destination.

https://trck.at/abcdef?hide_fences=true

Hide sharing

Hides the share button for operations views and customer tracking view.

https://trck.at/abcdef?hide_sharing=true

Disable selector

Disable the user filter control (user profile / region filtering).

https://embed.hypertrack.com/scoreboard?publishable_key=...&disable_selector=true

Hide selector

Hide the user filter control (user profile / region filtering).

https://embed.hypertrack.com/scoreboard?publishable_key=...&hide_selector=true

Hide timezone selector

This parameter will hide timezone selector completely.

https://embed.hypertrack.com/scoreboard?publishable_key=...&hide_timezone_selector=true

Disable entity selector

Disable the feature selector (App Users, Orders, Geofences, etc). The user will be constrained to the current feature.

https://embed.hypertrack.com/scoreboard?publishable_key=...&disable_entity_selector=true

Hide entity selector

Hide the feature selector (App Users, Orders, Geofences, etc). The user will be constrained to the current feature.

https://embed.hypertrack.com/scoreboard?publishable_key=...&hide_entity_selector=true

Disable dates

This parameter will disable date controls for all operations views. The user will be constrained to the date parameter provided, or the default date for the view.

https://embed.hypertrack.com/tracking?publishable_key=...&disable_dates=true

Updated 3 months ago