All versions of this manual
X
 

Deep link

Deep link

Using query-string parameters, you can create visualizations on the go to integrate Linkurious Enterprise in your workflow.

Sandbox

To open a visualization pre-filled with data, you need to use the /workspace/new URL.

Then, by adding query-string parameters, you can fill your visualization with a specific nodes & edges:

e.g. http://localhost:3000/workspace/new?populate=nodeId&item_id=45869

This URL will open a visualization containing the node with ID 45869.

Please find below the list of supported parameters.

Parameter Description Accepted values
key Key of the data-source. A valid source key (default is the first connected data source)
populate Describes how the sandbox should be populated. visualizationId, expandNodeId, nodeId, edgeId, queryId, searchNodes, searchEdges, pattern, caseId
item_id ID of the node, edge, query, pattern or visualization to load (required when populate is one of visualizationId, queryId, nodeId, edgeId, expandNodeId). The ID of the resource to load
case_id ID of alert case to load (required when populate is caseId). An existing alert case ID
search_query Search query to search for nodes or edges (required when populate is one of searchNodes or searchEdges). Any string of characters
search_fuzziness Search query fuzziness (when populate is one of searchNodes or searchEdges). Any number between 0 and 1 (default is 0.1)
pattern_query Pattern query to match nodes and/or edges (required when populate is pattern). Any valid Cypher or Gremlin query (depending of the datasource query language)
pattern_dialect Query dialect to use (required when populate is pattern). cypher or gremlin
query_parameters Template query parameters (required when populate is queryId and the query is a template). Any valid template query parameters in JSON format (e.g. {"param1": "abc", "param2": 123}
geo_mode Whether the sandbox should be opened with geo mode activated true or false (default is false)

Visualization

You can also open a visualization by using the /workspace/:id URL.

You can use specific parameters to customize it.

e.g. http://localhost:3000/workspace/5

This URL will open the visualization with ID 5.

Parameter Description Accepted values
id ID of the visualization. An existing visualization ID
geo_mode Whether the visualization should be opened with geo mode activated true or false (default is false)