Several URL parameters can be passed to a blank graph visualization created with the /visualization service. The parameters load the initial set of nodes and relationships into the visualization. After that, the user can explore the graph as needed.

The URL consists of several parts:

  • the base path of the Graphlytic instance, e.g., https://graphlytic.instance

  • the visualization service /visualization

  • URL parameters, e.g. ?p=1&vis=14&nodes=23

Parameter

Description

Example

p

Specifies the project ID. Has to be defined in every usage of URL parameters. If used without any other URL parameter, then a blank visualization in the specified project is opened.

https://graphlytic.instance/visualization?p=1

nodes

Adds nodes defined by internal ID to a blank graph visualization created in the project specified by the "p" parameter. Values in the "nodes" parameter are separated with commas (","). It can be combined with the "vis" parameter to add nodes to an existing visualization.

https://graphlytic.instance/visualization?p=1&nodes=23,653,9713

vis

Opens an existing visualization identified by the ID passed in the "vis" parameter and the project ID passed in the "p" parameter. It can be combined with the "nodes" parameter to add nodes to an existing visualization.

https://graphlytic.instance/visualization?p=1&vis=14

https://graphlytic.instance/visualization?p=1&vis=14&nodes=23,69,420

cq

Custom Query passed with the "cq" parameter will be requested from the server right after a blank visualization in the project identified by the "p" parameter is created. Pass any cypher or gremlin URL encoded query (based on the connected graph DB), but don't forget that the URL length limit is around 2000 characters.

https://graphlytic.instance/visualization?p=1&cq=MATCH%28n%3ALabel%29RETURN%20n%20LIMIT%2025

qt

Query Template identified by the ID passed with the "qt" parameter will be used to create the visualization. The Query Template needs to be published in the Query API. See Query API for details on how to assign an API ID to a Query Template.

Dynamic parameters of the Query Template are passed as separate URL parameters. If an array value needs to be passed, every array element is added to the URL as a separate key=value pair (see the example).

https://graphlytic.instance/visualization?p=1&qt=test&entityIds=12&entityIds=23