Reference

Create Cell

Add a new code or SQL cell to your Hex project to expand its functionality with custom logic or database queries. This lets you build out your analytics and data processing workflows without leaving the platform.

Delete Cell

Remove a cell from your Hex project draft to clean up analysis or eliminate outdated content. This helps you maintain a focused, organized project as your analysis evolves.

Get Cell

Retrieve detailed information about a specific cell from a Hex project, including its contents and metadata, to access code, SQL queries, or other cell data.

List Cells

Retrieve all cells from a Hex project draft to access their source code, configurations, and metadata in a paginated format. Use this to audit your project structure, understand cell dependencies, or extract code for documentation.

Update Cell

Modify the code or data connection settings within a Hex cell to update your project's logic or data sources. This lets you refine calculations, fix queries, or change how data flows through your project without recreating the entire cell.

Create Collection

Organize your Hex projects and resources by creating a new collection to group related work together. This helps keep your workspace structured and makes it easier to find and manage related items.

Edit Collection

Update a collection's name, description, and sharing settings to keep your Hex projects organized and control who can access them.

Get collection

Retrieve detailed information about a specific collection in Hex, including its name, description, creator, and sharing settings. Use this to understand collection structure and permissions before accessing or modifying its contents.

List Collections

Retrieve all collections in your workspace to discover and browse available projects and data sources. This helps you find collections you need to work with or manage.

List Data Connections

Retrieve all data connections configured in your Hex workspace to see what databases, APIs, and data sources are available for your projects. This helps you understand what data resources your team can access and use in analyses.

Get Run Status

Check the current status and progress of a Hex project run, including whether it's completed, in progress, or failed, along with timing details. This helps you monitor the execution of your data projects and respond quickly to any issues.

Run Project

Executes the latest published version of a Hex project on-demand, allowing you to automate data analysis, reporting, or computation workflows without manual intervention.

Cancel Run

Stops a currently executing Hex project run that is in progress, allowing you to halt long-running computations or data processes without waiting for completion.

Get Project Runs

Retrieve the execution status and history of your Hex project runs to track data processing jobs and monitor when analyses complete.

Get Run Chart Image

Retrieve a visual chart image from a completed Hex project run to embed in reports, dashboards, or presentations. This allows you to extract and reuse data visualizations programmatically.

Create Group

Organize your team members into groups within your Hex workspace to streamline collaboration, manage permissions, and control who can access specific projects and data.

Delete Group

Permanently remove a group from your Hex workspace when it's no longer needed. This is useful for cleaning up after team reorganizations or closing completed projects.

Edit Group

Update a group's name, description, or manage its members by adding or removing users to control access and organization within your Hex workspace.

Get Group

Retrieve detailed information about a specific Hex group, including its ID, name, and creation date. Use this to access group details for organizational and collaboration purposes.

List groups

Retrieve all groups in your Hex workspace with filtering and pagination options to manage team access and collaboration structures. Useful for organizing and viewing how your projects and data are grouped for different teams or departments.

Delete Guide Draft

Permanently removes a draft guide from your Hex workspace when you no longer need it or want to start fresh with a new version.

Publish Guide Drafts

Makes your draft guides publicly available so readers can access them, either publishing all drafts at once or selecting specific guides by ID.

Upsert Guide Draft

Create or update guide drafts in Hex by file path, automatically managing new guides and draft versions without manual intervention.

Get Project

Retrieve detailed information about a Hex project including its title, description, creator, owner, status, and sharing settings. Use this to access project metadata and understand project configurations without opening the Hex interface.

List Hex Projects

Retrieve all your Hex projects with the ability to filter by status, categories, creator, or owner to find specific projects quickly. This helps you organize and manage your data projects in one place.

Update Project Status

Update or remove project status and endorsements in Hex to keep your project information current and accurately reflect its state or progress.

Edit Project Sharing Collections

Organize and control project access by adding or removing projects from shared collections, making it easier to manage who can view specific work across your team.

Edit Project Sharing Groups

Manage which groups of people have access to your Hex projects and control their permissions. Use this when you need to grant or update group access to keep your data and analytics secure.

Edit Project Sharing Settings

Control who can access your Hex project by adjusting sharing permissions for team members and public web access.

Edit Project Sharing Users

Manage individual user access permissions to Hex projects by granting or modifying access levels from view-only to full control. Use this when you need to quickly adjust who can interact with your analytics and data projects.

Deactivate User

Disables a user account in your Hex workspace, preventing them from accessing projects and data while preserving their historical contributions and audit trails.

List Users

Retrieve all users in your Hex workspace along with their details like names, emails, and roles, with pagination support for managing large teams.