API change log

A change log of additions and changes to the Sigma REST API, in reverse chronological order.

May 14, 2024

New translations API endpoints

A new collection of endpoints allows admins to manage organization translation files to support localized content.

• The GET /v2/translations/organization lists all the translation files that have been defined at the organization level.
• The POST /v2/translations/organization creates a new organization translation file.
• The GET /v2/translations/organization/{lng} retrieves the translations for the specified locale without a custom variant.
• The PUT /v2/translations/organization/{lng} updates the translation file for a specified locale without a custom variant.
• The DELETE /v2/translations/organization/{lng} deletes the translation file for the specified locale without a custom variant.
• The GET v2/translations/organization/{lng}/{lng_variant} retrieves the translations for the specified custom translation for a locale.
• The PUT v2/translations/organization/{lng}/{lng_variant} updates the translations file for the specified custom translation for a locale.
• The DELETE /v2/translations/organization/{lng}/{lng_variant} deletes the translation file for the specified custom translation for a locale.

May 7, 2024

Improved API reference documentation is now available, including interactive functionality for making an API call and retrieving a response from the documentation page.

September 29th, 2023

New teams API endpoint

The GET /v2/teams/{teamId}/members returns a list of team members and can be used to identify team admins.

For more information, see List team members.

September 8th, 2023

New response field for List Embeds endpoint

The GET/v2/workbooks/{workbookId}/embeds endpoint now includes a public response field. If the embed is public, the response returns true.

JSON

{
  "entries": [
    {
      "embedId": "a18971af-0b31-436e-b05e-c333f8a95f36",
      "embedUrl": "https://app.sigmacomputing.com/embed/1-4UOzL4W7lr04Lz5op9DlWu",
      "public": false
    }
  ],
  "hasMore": false,
  "total": 1,
  "nextPage": null
}

See Get embeds for a workbook.

September 1st, 2023

New workbooks endpoint

A new workbooks endpoint is available that returns the list of controls in a workbook.

See GET /v2/workbooks/{workbookId}/controls

July 14th, 2023

Members

You can now use the PATCH /v2/members/{memberId} endpoint to reassign documents when you archive a member. In the request body, set isArchived to true and set newOwnerId to the member who will receive the documents from the archived member.

Workbooks

When you create a workbook using POST /v2/workbooks endpoint, you can assign an owner by passing ownerId in the request body. If you don't include this, the owner is the user whose token was used to call the API.

Connections

The /v2/connections endpoint now returns the following Connection metadata fields:

JSON

{
  "account": "string",
  "warehouse": "string",
  "user": "string",
  "role": "string",
  "timeout": {
    "default": 0,
    "worksheet": 0,
    "dashboard": 0,
    "download": 0
  },
  "poolSizes": {
    "adhocPoolSize": 0,
    "catalogPoolSize": 0,
    "resultPoolSize": 0,
    "schedulePoolSize": 0
  },
  "writeAccess": boolean,
  "friendlyName": boolean,
  "writeDatabase": "string",
  "writeSchema": "string",
  "materializationWarehouse": "string"
}

May 19, 2023

A new parameter is available for the **PATCH** /v2/members/{memberId} endpoint on the Organization Members API. The userKind parameter defines the type of user. The three possible values are guest, internal, or embed. See Update member.

November 30, 2022

Added a new API endpoint that lets you assign a user attribute to a team. Before you use this endpoint, you must create user attributes in the UI. For more information, see User Attributes and Set a user attribute for teams.

POST /v2/user-attributes/{userAttributeId}/teams

August 25, 2022

Fixed: Teams APIs didn’t return Members field in Swagger.

August 23, 2022

Fixed: In some cases, a CSV uploaded to Databricks from Sigma rendered incorrectly.

July 28, 2022

Added 5 new endpoints to the Connection API. You can now create a connection, update a connection, test a connection, list active connections, and delete a connection with this API. See the following:

• Test a connection
• Update or restore a connection
• Create a connection
• Delete a connection
• List connections

July 1, 2022

Fixed: Attempts to export a workbook to JSON, if using the CurrentUserInTeam function, returned an error. See Export a workbook API endpoint.

June 22, 2022

Fixed: Admins couldn’t see all of their organization’s workspaces using the Workspaces API.

May 23, 2022

Custom plugin developers can now see a warning message in the dev console if you should upgrade to a new version of the @sigmacomputing/plugin.

May 19, 2022

• Custom plugins support two new hooks: useLoadingState and useEditorPanelConfig.

  • useLoadingState allows you to override the plugin’s ready state, giving you more control over the loading laser beam.
  • useEditorPanelConfig allows you to dynamically set the editor panel during React runtime.

• Fixed: Loading laser beams were left hanging on custom plugins. This was due to a lack of state change.

May 9, 2022

• The workbook schema API can now return element names. The displayName value is only returned if the request has includeSql set to true.
• Fixed: The Plugins useConfig function expected a key argument but was marked optional in documentation.

May 5, 2022

Fixed: The workbook export API did not respect filter and parameter values when exporting as PDF or PNG.

April 27, 2022

Custom plugins support a new boolean config parameter: screenshot. When true, this parameter notifies the plugin that it should support screenshots for PDF exports.

April 26, 2022

Fixed: Some authorized users encountered an "Access Denied" error when calling Sigma’s workbook export API.

April 15, 2022

Fixed: Custom plugins did not display correctly in application embedded workbooks running on AWS.

April 11, 2022

Fixed: A plugin user hit the following error: "Could not find package required by '@sigmacomputing/plugin'". This issue has been resolved.

March 15, 2022

Plugins now support two new config type options: radio and dropdown; see Plugin Development API.

March 11, 2022

A new set of API endpoints are available. These endpoints primarily serve to automate onboarding and management of users and teams in your organization. See Get Started with the Sigma REST API.

Organization Members

• POST /members. See Create a member.
• PATCH /v2/members/{memberId}. See Update member.
• DELETE /v2/members/{memberId}. See Delete member.

Teams

• POST /v2/teams. See Create a team.
• GET /v2/teams/{teamId}. See Get a team.
• PATCH /v2/teams/{teamId}. See Update a team.
• DELETE /v2/teams/{teamId}. See Delete a team.

Team members

• PATCH /v2/teams/{teamId}/members. See List team members.

Connections

• GET /v2/connections/{connectionId}. See Get connection details.
• PATCH /v2/connections/{connectionId}. See Update a connection.

Connection Paths

• GET /v2/connections/paths. See List connection paths.

Connection Grants

• POST /v2/connections/{connectionId}/grants. See Grant permissions to a connection.
• GET /v2/connections/{connectionId}/grants. See List permissions for a connection.
• DELETE /v2/connections/{connectionId}/grants/{grantId}. See Delete a permission for a connection.

Workspaces

• POST /v2/workspaces. See Update a workspace.
• GET /v2/workspaces. See Get workspaces.
• GET /v2/workspaces/{workspaceId}. See Get a workspace.
• PATCH /v2/workspaces/{workspaceId}. See Update a workspace.
• DELETE /v2/workspaces/{workspaceId}. See Delete a workspace.

Workspace Grants

• POST /v2/workspaces/{workspaceId}/grants. See Grant permissions to the workspace for users or teams.
• GET /v2/workspaces/{workspaceId}/grants. See List grants for a workspace.
• DELETE /v2/workspaces/{workspaceId}/grants/{grantId}. See Delete a workspace grant.

March 4, 2022

Plugins now support two new config type options: toggle and checkbox. See Plugin Development API.

December 8, 2021

The Team object returned from a request to the GET v2/teams/{teamId} endpoint now includes a list of team member ids. See Get a team.

November 22, 2021

Workbook schema requests now accept an optional includeSql URL query (boolean). The API response only includes SQL if this value is true.

GET v2/workbooks/{workbookId}/schema

November 12, 2021

• (Beta) Workbooks now support custom plugins. Use Sigma’s Plugin API to build custom visualizations for your team to use directly in Sigma. See Get started with custom plugins.

November 2, 2021

Sigma’s public API is now available. See Get Started with the Sigma REST API.