Introduction

Upload your graph and control how the visualization is served:

For Analysts: Use your account to plot your data using the investigator, notebooks, or embedded apps. Use a language client like PyGraphistry to avoid low-level details. Get back a url or see and interact with the result immediately.

For Developers: Upload a graph through our REST API or language bindings and embed an iframe that links to it. Try to use a language client like PyGraphistry so that you can more automatically benefit from protocol upgrades. Likewise, try to use typed columnar formats (pandas, cudf, parquet, orc, arrow) over CSV/JSON for faster loading and more reliable data interpretation (ex: datetimes). Integrate authentication into your software via JWT token HTTP headers. Customize easily using URL parameters and dynamically control using the JavaScript and React APIs.

We support several formats. For programmatic use, our API supports a simple JSON format, accelerated CSV support, and recommended, the safer and faster Apache Parquet and Arrow formats. In all cases, graphs are described by three structures: a set of declarative bindings, a table of edges with optional data and style attributes, and an optional table of nodes and their bindings. Further specify encodings for deeper control. Additional options may be set in the URL used to visualize a graph.

NOTE: This serverside visualization API document does not cover the investigation automation API nor the client-side JavaScript APIs.

Continue on to: