Deep Linking - Share with Formant users

You can share specific time slots with users who already have Formant login using deep links. Deep Linking allows a user to craft a URL that links to a dynamically-specified channel view.

This is useful for manually or programmatically linking to a view of your organization’s data without creating a channel beforehand.

Base URL
https://app.formant.io/channel

With no parameters present, the app will automatically redirect to the "all" channel.

The following parameters are supported:

Query String Parameters

Parameter

Required?

Description

channelName

No

Links to a channel by name (default is #all)

agentId

No

Adds an agent ID to the channel filter

agentId/ deviceId/ deviceName

No

Load the named device channel, or add this parameter to the ad-hoc channel filter

streamType

No

Adds a stream type to the channel filter

streamName

No

Adds a stream name to the channel filter

tags[key]

No

Adds a tag key/value pair to the channel filter

time

Yes, if time zone is provided

Sets the timeline to the specified time.

                   Represented as an ISO-8601 timestamp without time zone.   

May be a prefix such as 2019-03 or 2019-03-09T15.

timeZone

Yes, if time is provided

An IANA/Olson timezone identifier, such as US/Pacific

interval

No

Specifies the timeline’s resolution as minute, hour, day, or month

Query string parameters must be URL encoded.

If no query string parameters are provided, the base URL will link to the #all channel in live mode.

Examples

Linking to a device channel

https://app.formant.io/channel?deviceName=device01
This URL links to the #device01 channel.

Linking to a regular channel

https://app.formant.io/channel?channelName=batterystates&streamType=numeric&time=2019-03-09&timeZone=US/Pacific&tags%5Bmodel%5D=rosie&tags%5Blocation%5D=sf
This URL links to the #batterystates channel with:

a filter to display only numeric telemetry streams from the robot model rosie in the location sf

the timeline set to Saturday, 09-Mar-2019 00:00:00 GMT-0700


Did this page help you?