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

Sessions

A session is used for managing a live visualization. It links users to a shareable dataset revision. Sessions are similar to shared live documents. A user might start a session, open it in another tab, and share it with another user: as long as they have the same session ID, Graphistry tries to share live updates across all users (experimental.)

Currently, sessions are created by a user visiting a page (graph.html?dataset=...), which will redirect to a new page with the session ID appended (graph.html?dataset=...&session=...). The dataset revision is initialized to the dataset.

Viewers can inspect their own session and administrators can list all sessions.

Route Method Headers Parameters Return
api/experimental/viz/sessions/ GET Content-Type: application/json
Authorization: Bearer YOUR_JWT_TOKEN
{
  "results": [ { 
      "session_id": str,
      "revision": {
        "revision_id": str,
        "dataset": {
          "dataset_id": str 
}}}] }
        
Input:

  curl -s -L -X GET \
    -H "Authorization: Bearer my_generated_token" \
    -H "Content-Type: application/json" \
    http://localhost/api/experimental/viz/sessions/
  
api/experimental/viz/sessions/<session_id>/ GET Content-Type: application/json
Authorization: Bearer YOUR_JWT_TOKEN
{ 
    "session_id": str,
    "revision": {
      "revision_id": str,
      "dataset": {
        "dataset_id": str 
}}}
          
Input:

    curl -s -L -X GET \
      -H "Authorization: Bearer my_generated_token" \
      -H "Content-Type: application/json" \
      http://localhost/api/experimental/viz/sessions/1234/