UI Guides


Graphistry Setup


REST APIs

Introduction

2.0 REST API Tutorial (cURL)


URL API to Embed & Control

- HTML

- URL Options

- IFrame CSS Style Tips


Authentication (2.0 API)

- Concepts

- Create token

- Refresh token

- Verify token

- Modes: Password, Personal Key, & SSO


Computation

- GFQL Query Endpoint

    - GFQL Operations

    - GFQL Predicates

- Python Query Endpoint

- GFQL UDF Endpoint

- Python UDF Endpoint


Upload Data (2.0 API)

- Concepts

- List Files

- Create File

- Delete File

- Upload File Data

- List Visualization Datasets

- Create Visualization Dataset with Bindings

    - Hypergraphs

- Delete Visualization

- Schema

Basic Bindings

    - Color

    - Color Palettes

    - Edge Weight Bindings

Complex Bindings

    - Colors and Sizes

    - Icons

    - Badges

    - Radial & Horizontal Axis

    - Field Controls Overview

        - Field Inclusion

        - Field Exclusion

        - Computed Fields

- Branding Metadata: Logos, title, backgrounds, & effects

- Upload Node & Edge Data

   - json

   - csv

   - parquet

   - orc

   - arrow


Live Sessions (experimental)

- View


Health Checks


Python Notebooks & API

- PyGraphistry Homepage (GitHub)

- PyGraphistry API (ReadTheDocs)

- Jupyter Notebook Examples (GitHub)

- Pygraphistry Databricks Examples (GitHub)

- Graph Algorithms


Visual Playbooks

- Connectors

- Pivots

- Templates


JavaScript Libraries

- React - Storybook

- React - API

- Browser JS - Storybook

- Browser JS - Example

- Browser JS - API

- Node.js - API

Introduction

Upload your graph and control how the visualization is served:

For Analysts: Use your account to plot your data using the investigator, file uploader, notebooks, or a custom embedded app/dashboard. Use the file uploader or 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: