Deep Linking API

Applications connecting to Imago can use well-formed URLs to deep link into the Imago web portal using a known hole or sample name/id at a known depth. The Imago demo site can be a great starting point to get to know Imago before integrating with the Deep Linking API.

Example

https://imago.seequent.com/api/display?de=AA222&ds=Core%20Boxes&im=Dry&dp=35

This example searches for a collection/drillhole named AA222 and finds all images of image type Dry in the Core Boxes imagery type. These images are then displayed on the Imago light table at a depth of 35m.

Alternatively, it can search by collection/drillhole only. The light table will show the first available image type listed for the matching collection.

https://imago.seequent.com/api/display?de=AA222&dp=35

Constructing the URL

Base URL: https://imago.seequent.com/api/display?

The Imago deep links uses URL query parameters to filter the images down until it can uniquely identify an image at a depth. Available parameters:

Parameter	Description	Required
pj	Workspace name	optional
da	Dataset name	optional
de	Collection name	mandatory
ds	Imagery type name	optional
im	Image type name	optional
dp	Display at this depth	optional
ig	Display at image with this name	optional

Appending parameters

Parameters are appended to the URL using a standard URL query parameter structure.

• Multiple parameters - multiple parameters are appended to the url using an & e.g. de=AA222&dp=35
• URL escaping - all parameters must be URL escaped, e.g. Chile Exploration must become pj=Chile%20Exploration

Data Hierarchy

The Imago help site provides a good reference of the data hierarchy back to the Imago user interface.

Deep Linking Logic

Imago does a best attempt to find images using the parameters provided in the URL. If the workspace or dataset parameters are provided then they will restrict the search for the collection. Without these parameters, Imago will search across all workspaces/datasets until it finds a collection that matches. If no imagery type or image type is specified then it will display the first available imagery/image type for the collection.

Unlike the integration API, no GUID identifiers are used to search for data. Instead, the linking option uses data names. Where duplicate collection names exists across multiple workspaces all collections matching the name will be shown. All data names are case-sensitive.