rocketkind
Analytics

Hex

Hex is a collaborative data workspace: SQL and Python notebooks that publish as interactive apps.

Authentication

  • API token

Actions

Generic API request. Call any Hex API endpoint on this connection, for the case where no shipped action covers it yet. The connection supplies the base URL, the authentication and the egress route, so only the path, query and body are yours to fill.

  • Cancel runDestructiveCancel a pending or running Hex project run, for example one that has run too long or was started with the wrong inputs.
  • Get data connectionFetch one Hex data connection's configuration - warehouse type, non-secret connection details (host, database, warehouse, username), SSH and writeback settings, schema filters, schema refresh schedule and sharing.
  • Get projectFetch one Hex project's metadata - title, owner, status, categories, schedules, last published time and view analytics.
  • Get run statusCheck the status of one Hex project run - PENDING, RUNNING, COMPLETED, ERRORED, KILLED or UNABLETOALLOCATEKERNEL - with its start and end times and elapsed milliseconds.
  • List collectionsList the Hex collections the token can see - the folders projects are organised into - with creator and sharing.
  • List data connectionsList the Hex workspace's data connections (Snowflake, BigQuery, Postgres, ...) with their id, name and warehouse type.
  • List groupsList the Hex workspace's user groups with their ids and creation time.
  • List project runsList the runs of one Hex project - API-triggered, scheduled and app-refresh runs - with status and timing, newest first.
  • List projectsList the Hex projects the token can view, newest first, with owner, status, categories, schedules and view analytics.
  • List usersList the members of the Hex workspace with their email, role and last login.
  • Run projectDestructiveStart a run of the latest published version of a Hex project, optionally with input parameter values, and get back its runId.

Product names, logos and brands are the property of their respective owners and are used here for identification only. Their use does not imply endorsement by, or affiliation with, those owners.