### Getting Started Guides
Source: https://help.sigmacomputing.com/sigma-computing/reference/listworkbooksfortag
Guides to help you get started with the Sigma REST API.
```APIDOC
## Getting Started with the Sigma REST API
### Description
This guide provides an overview of how to begin using the Sigma REST API. It covers initial setup and basic concepts.
### Endpoint
/reference/get-started-sigma-api
### Related Topics
- [Generate Sigma API client credentials](/reference/generate-client-credentials)
- [Identify unique IDs in Sigma](/reference/identify-unique-ids-in-sigma)
- [Use OAuth override tokens](/reference/use-oauth-override-tokens)
```
```APIDOC
## Generate Sigma API client credentials
### Description
Instructions on how to generate the necessary client ID and client secret for authenticating with the Sigma API.
### Endpoint
/reference/generate-client-credentials
```
```APIDOC
## Identify unique IDs in Sigma
### Description
Learn how to identify and work with unique identifiers within the Sigma platform when using the API.
### Endpoint
/reference/identify-unique-ids-in-sigma
```
```APIDOC
## Use OAuth override tokens
### Description
Details on how to utilize OAuth override tokens for specific authentication scenarios in the Sigma API.
### Endpoint
/reference/use-oauth-override-tokens
```
--------------------------------
### Getting Started Guides
Source: https://help.sigmacomputing.com/sigma-computing/reference/createworkspacegrant
Guides to help you get started with the Sigma API, including generating credentials and understanding unique IDs.
```APIDOC
## Get started with the Sigma REST API
### Description
This section covers essential information to begin using the Sigma REST API, including generating client credentials and understanding unique identifiers.
### Related Endpoints
- **Generate Sigma API client credentials**: Use this endpoint to create credentials for accessing the API.
- **Identify unique IDs in Sigma**: Learn how unique IDs are structured and used within the Sigma platform.
- **Use OAuth override tokens**: Understand how to utilize OAuth override tokens for specific authentication scenarios.
```
--------------------------------
### Getting Started Guides
Source: https://help.sigmacomputing.com/sigma-computing/reference/createworkspace
Information related to getting started with the Sigma API, including generating credentials and identifying unique IDs.
```APIDOC
## Generate Sigma API client credentials
### Description
Instructions and information on how to generate client credentials for accessing the Sigma API.
### Method
Not specified (likely involves a UI or a separate process).
### Endpoint
Not specified.
### Parameters
None explicitly defined for this documentation entry.
### Request Example
None provided.
### Response
Details on the generated credentials would be provided upon successful generation.
## Identify unique IDs in Sigma
### Description
Guidance on how to identify and work with unique identifiers within the Sigma platform.
### Method
Not specified.
### Endpoint
Not specified.
### Parameters
None explicitly defined for this documentation entry.
### Request Example
None provided.
### Response
Information or methods for identifying unique IDs.
## Use OAuth override tokens
### Description
Information on utilizing OAuth override tokens for specific authentication scenarios.
### Method
Not specified.
### Endpoint
Not specified.
### Parameters
None explicitly defined for this documentation entry.
### Request Example
None provided.
### Response
Details on how to use OAuth override tokens.
```
--------------------------------
### Getting Started
Source: https://help.sigmacomputing.com/sigma-computing/reference/syncconnectionpath
General information and introductory guides for using the Sigma API.
```APIDOC
## GET /branches/1.0/reference/generate-client-credentials
### Description
Generates client credentials for programmatic access to the Sigma API.
### Method
GET
### Endpoint
/branches/1.0/reference/generate-client-credentials
### Parameters
#### Query Parameters
None
#### Request Body
None (This endpoint is marked as isBodyEmpty: true)
### Request Example
```json
{
"example": "No request body needed for this endpoint."
}
```
### Response
#### Success Response (200)
- **clientId** (string) - The client ID for your application.
- **clientSecret** (string) - The client secret for your application.
#### Response Example
```json
{
"example": "{\n \"clientId\": \"your_client_id\",\n \"clientSecret\": \"your_client_secret\"\n}"
}
```
```
```APIDOC
## GET /branches/1.0/reference/identify-unique-ids-in-sigma
### Description
Provides guidance on how to identify and work with unique identifiers within Sigma.
### Method
GET
### Endpoint
/branches/1.0/reference/identify-unique-ids-in-sigma
### Parameters
#### Query Parameters
None
#### Request Body
None (This endpoint is marked as isBodyEmpty: true)
### Request Example
```json
{
"example": "No request body needed for this endpoint."
}
```
### Response
#### Success Response (200)
- **documentation** (string) - Detailed explanation and examples on identifying unique IDs.
#### Response Example
```json
{
"example": "{\n \"documentation\": \"Unique IDs in Sigma are crucial for data integrity. Refer to the data model or use specific query functions to retrieve them...\"\n}"
}
```
```
```APIDOC
## GET /branches/1.0/reference/use-oauth-override-tokens
### Description
Explains how to use OAuth override tokens for specific authentication scenarios.
### Method
GET
### Endpoint
/branches/1.0/reference/use-oauth-override-tokens
### Parameters
#### Query Parameters
None
#### Request Body
None (This endpoint is marked as isBodyEmpty: true)
### Request Example
```json
{
"example": "No request body needed for this endpoint."
}
```
### Response
#### Success Response (200)
- **documentation** (string) - Instructions and examples for utilizing OAuth override tokens.
#### Response Example
```json
{
"example": "{\n \"documentation\": \"OAuth override tokens allow for more granular control over API access. Follow these steps to implement them...\"\n}"
}
```
```
--------------------------------
### Getting Started
Source: https://help.sigmacomputing.com/sigma-computing/reference/deleteworkbookbookmarks
Guides and initial steps for using the Sigma API.
```APIDOC
## Get started with the Sigma REST API
### Description
This guide provides an overview of how to get started with the Sigma REST API, including setting up authentication and making your first requests.
### More Info
- [Generate Sigma API client credentials](/reference/generate-client-credentials)
- [Identify unique IDs in Sigma](/reference/identify-unique-ids-in-sigma)
- [Use OAuth override tokens](/reference/use-oauth-override-tokens)
```
--------------------------------
### Getting Started API
Source: https://help.sigmacomputing.com/sigma-computing/reference/deletedatasetgrant
Guides and endpoints for getting started with the Sigma REST API.
```APIDOC
## GET /reference/get-started-sigma-api
### Description
This section provides general information and steps for getting started with the Sigma REST API.
### Method
GET
### Endpoint
/reference/get-started-sigma-api
### Parameters
None
### Request Example
None
### Response
(Content is introductory text and links, not structured API response data)
```
```APIDOC
## GET /reference/generate-client-credentials
### Description
Instructions on how to generate client credentials for accessing the Sigma API.
### Method
GET
### Endpoint
/reference/generate-client-credentials
### Parameters
None
### Request Example
None
### Response
(Content is introductory text and instructions, not structured API response data)
```
```APIDOC
## GET /reference/identify-unique-ids-in-sigma
### Description
Guidance on how to identify unique identifiers within Sigma data.
### Method
GET
### Endpoint
/reference/identify-unique-ids-in-sigma
### Parameters
None
### Request Example
None
### Response
(Content is introductory text and instructions, not structured API response data)
```
```APIDOC
## GET /reference/use-oauth-override-tokens
### Description
Information on utilizing OAuth override tokens for specific use cases.
### Method
GET
### Endpoint
/reference/use-oauth-override-tokens
### Parameters
None
### Request Example
None
### Response
(Content is introductory text and instructions, not structured API response data)
```
--------------------------------
### Getting Started
Source: https://help.sigmacomputing.com/sigma-computing/reference/setuserattributeforusers
General information and guides for getting started with the Sigma API.
```APIDOC
## Use OAuth override tokens
### Description
Information on how to use OAuth override tokens for enhanced authentication control.
### Method
(Not applicable - this is a guide)
### Endpoint
(Not applicable - this is a guide)
### Parameters
(Not applicable - this is a guide)
### Request Example
(Not applicable - this is a guide)
### Response
(Not applicable - this is a guide)
```
--------------------------------
### Example Scripts and Recipes
Source: https://help.sigmacomputing.com/sigma-computing/reference/get-started-sigma-api
Access example scripts and recipes to help you get started with integrating with the Sigma API.
```APIDOC
## Example scripts and recipes
### Description
This section provides access to example scripts and recipes that can assist you in utilizing the Sigma API effectively.
### Method
N/A (Informational)
### Endpoint
N/A (Informational)
### Parameters
N/A
### Request Example
N/A
### Response
#### Success Response (200)
N/A
#### Response Example
N/A
```
--------------------------------
### Displaying Sigma Computing API Getting Started Link
Source: https://help.sigmacomputing.com/sigma-computing/reference/listmembers
This HTML snippet displays a link to the 'Get Started' guide for the Sigma API. It includes a paragraph for the link text and an image for a visual indicator. This is a static display element.
```html
Customize your workflow
```
--------------------------------
### Sigma Computing Get Started Example (HTML)
Source: https://help.sigmacomputing.com/sigma-computing/docs/trunc
An HTML snippet representing a 'Get started' card in Sigma Computing. It includes an SVG icon, title, description, and a link to build with data. This serves as a visual representation of a starting point for users.
```html
```
--------------------------------
### GETTING STARTED
Source: https://help.sigmacomputing.com/sigma-computing/reference/filesdelete
Information on how to get started with the Sigma Computing API.
```APIDOC
## GET STARTED API
### Description
Provides introductory information for using the Sigma Computing API.
### Method
GET
### Endpoint
/branches/1.0/reference/get-started-sigma-api
### Parameters
#### Path Parameters
None
#### Query Parameters
None
#### Request Body
None
```
--------------------------------
### Getting Started with Sigma API
Source: https://help.sigmacomputing.com/sigma-computing/reference/updateteam
Guides and information to help you start using the Sigma REST API.
```APIDOC
## Guides for Getting Started
### Description
Resources to help you get started with the Sigma API, including generating credentials and understanding unique IDs.
### Pages
- **Get started with the Sigma REST API**: An overview of how to begin using the API.
- **Generate Sigma API client credentials**: Instructions on how to generate the necessary credentials for API access.
- **Identify unique IDs in Sigma**: Guidance on identifying and utilizing unique identifiers within Sigma.
- **Use OAuth override tokens**: Information on how to use OAuth override tokens for authentication.
```
--------------------------------
### Sigma Computing Get Started Example
Source: https://help.sigmacomputing.com/sigma-computing/docs/replace
This snippet displays a card component for the 'Get started' section, encouraging users to explore data possibilities. It includes an SVG icon and a link to the documentation.
```html
```
--------------------------------
### Getting Started
Source: https://help.sigmacomputing.com/sigma-computing/reference/deleteworkspacegrant
General information and guides for getting started with the Sigma API.
```APIDOC
## Use OAuth override tokens
### Description
Information on how to use OAuth override tokens for specific authentication scenarios.
### Method
N/A (Informational)
### Endpoint
/branches/1.0/reference/use-oauth-override-tokens
### Parameters
None
### Request Example
N/A
### Response
N/A (This is a documentation page, not an API endpoint.)
```
--------------------------------
### Get started with the Sigma REST API
Source: https://help.sigmacomputing.com/sigma-computing/reference/listconnectionpathgrants
Introduction to the Sigma REST API, covering initial setup and core concepts.
```APIDOC
## Get started with the Sigma REST API
This section provides an overview of the Sigma REST API, including how to get started with authentication and making your first API calls.
### Related Topics
- **Generate Sigma API client credentials**: Learn how to generate the necessary credentials to authenticate with the Sigma API.
- **Identify unique IDs in Sigma**: Understand how to find and use unique identifiers within the Sigma platform.
```
--------------------------------
### Sigma Computing 'Get Started' Card
Source: https://help.sigmacomputing.com/sigma-computing/docs/build-if-else-control-flow-in-an-action-sequence
Presents the 'Get Started' section, encouraging users to explore data possibilities. It includes a title, description, and a link to the 'About Sigma' documentation, featuring an arrow icon. This card is designed to guide new users.
```html
```
--------------------------------
### GET /branches/1.0/reference/get-started-sigma-api
Source: https://help.sigmacomputing.com/sigma-computing/reference/listlineage
Provides foundational information and guidance for getting started with the Sigma API. Includes links to related resources.
```APIDOC
## GET /branches/1.0/reference/get-started-sigma-api
### Description
Provides introductory information and guidance on how to get started with the Sigma API. Includes links to relevant documentation and resources.
### Method
GET
### Endpoint
/branches/1.0/reference/get-started-sigma-api
### Parameters
(No parameters specified in the provided data)
### Request Example
(No request example provided)
### Response
#### Success Response (200)
(No success response details provided)
#### Response Example
(No response example provided)
```
--------------------------------
### Sigma Computing Get Started Card (HTML)
Source: https://help.sigmacomputing.com/sigma-computing/docs/configure-custom-sort
An HTML structure for a 'Get started' card, featuring an SVG icon, title, description, and a call-to-action link with an arrow icon. This card is designed to guide users on exploring data possibilities.
```html
```
--------------------------------
### Get started with the Sigma REST API
Source: https://help.sigmacomputing.com/sigma-computing/reference/createconnection
Information on how to begin using the Sigma API, including generating client credentials and identifying unique IDs.
```APIDOC
## Get started with the Sigma REST API
### Description
This section provides guidance on initial steps for using the Sigma API.
### Endpoints
- **Generate Sigma API client credentials**: Learn how to create and manage credentials for accessing the API.
- **Identify unique IDs in Sigma**: Understand how to work with unique identifiers within the Sigma platform.
- **Use OAuth override tokens**: Details on utilizing OAuth tokens for authentication.
```
--------------------------------
### Get started with the Sigma REST API
Source: https://help.sigmacomputing.com/sigma-computing/reference/getteammembers
This section provides an overview and guides for getting started with the Sigma REST API, including generating client credentials and understanding authentication mechanisms.
```APIDOC
## Get started with the Sigma REST API
### Description
Guides and essential information for initiating your work with the Sigma REST API.
### Method
N/A
### Endpoint
N/A
### Parameters
N/A
### Request Example
N/A
### Response
N/A
## Generate Sigma API client credentials
### Description
Instructions on how to generate the necessary client credentials to authenticate and authorize your API requests to Sigma.
### Method
N/A
### Endpoint
N/A
### Parameters
N/A
### Request Example
N/A
### Response
N/A
## Identify unique IDs in Sigma
### Description
Details on how to identify and utilize unique identifiers within the Sigma platform for various operations.
### Method
N/A
### Endpoint
N/A
### Parameters
N/A
### Request Example
N/A
### Response
N/A
## Use OAuth override tokens
### Description
Information on how to use OAuth override tokens for specific authentication scenarios within the Sigma API.
### Method
N/A
### Endpoint
N/A
### Parameters
N/A
### Request Example
N/A
### Response
N/A
```
--------------------------------
### Get started with the Sigma REST API
Source: https://help.sigmacomputing.com/sigma-computing/reference/materializedataset
This section provides an overview of how to begin using the Sigma REST API, including essential setup and introductory information.
```APIDOC
## GET /api/docs/get-started-sigma-api
### Description
Provides an overview of how to begin using the Sigma REST API, including essential setup and introductory information.
### Method
GET
### Endpoint
/api/docs/get-started-sigma-api
### Parameters
#### Path Parameters
None
#### Query Parameters
None
#### Request Body
None
### Request Example
None
### Response
#### Success Response (200)
- **content** (string) - The documentation content for getting started with the Sigma REST API.
```
--------------------------------
### GETTING STARTED
Source: https://help.sigmacomputing.com/sigma-computing/reference/deleteworkbookembeds
Guides to help developers begin using the Sigma REST API, including generating API credentials and identifying unique IDs.
```APIDOC
## GETTING STARTED
### Description
Guides to help developers begin using the Sigma REST API, including generating API credentials and identifying unique IDs.
### Endpoints
- /reference/get-started-sigma-api
- /reference/generate-client-credentials
- /reference/identify-unique-ids-in-sigma
- /reference/use-oauth-override-tokens
```
--------------------------------
### Get Started with the Sigma REST API
Source: https://help.sigmacomputing.com/sigma-computing/reference/gettaggedworkbookbookmarks
This document provides an introduction to the Sigma REST API and guides users through the initial steps.
```APIDOC
## Get Started with the Sigma REST API
This section covers the basics of using the Sigma REST API, including setup and authentication.
### Generate Sigma API Client Credentials
To interact with the Sigma API, you need to generate API client credentials. This process involves authenticating and obtaining the necessary tokens.
- **Endpoint**: `/branches/1.0/reference/generate-client-credentials`
- **Method**: GET (Assumed based on typical credential generation flows, but not explicitly stated in the provided text)
### Identify Unique IDs in Sigma
Learn how to identify unique identifiers within Sigma, which can be useful for various API operations and data manipulation tasks.
- **Endpoint**: `/branches/1.0/reference/identify-unique-ids-in-sigma`
- **Method**: GET (Assumed based on typical data retrieval flows, but not explicitly stated in the provided text)
```
--------------------------------
### Get Started with Sigma Computing
Source: https://help.sigmacomputing.com/sigma-computing/reference/postworkbookbookmarks
This section provides a starting point for users to explore the possibilities with their data using Sigma Computing. It includes a link to the 'About Sigma' documentation.
```html
```
--------------------------------
### Get started with the Sigma REST API
Source: https://help.sigmacomputing.com/sigma-computing/reference/get-started-sigma-api
This section provides an overview of the Sigma REST API, its capabilities, prerequisites, and how to get started with API calls. It covers user management, data export, and more.
```APIDOC
## GET /
### Description
This is the root endpoint for the Sigma REST API. It provides general information and links to other resources. Specific details about available API endpoints are documented separately.
### Method
GET
### Endpoint
/
### Parameters
None
### Request Example
None
### Response
#### Success Response (200)
- **message** (string) - A welcome message or information about the API.
- **documentation_url** (string) - A URL to the main API documentation.
#### Response Example
{
"message": "Welcome to the Sigma REST API!",
"documentation_url": "/docs"
}
## About the API
The Sigma API is built around REST principles, leveraging the [OpenAPI specification](https://swagger.io/specification/). It is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. It uses built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients.
It supports cross-origin resource sharing, allowing you to interact securely with the API from a client-side web application, although you should never expose your secret API key in any public website’s client-side code.
Endpoints accept JSON in the request body and can include JSON in the response body.
Responses from the [Download an exported file](downloadquery) endpoint for files requested with the [Export data from a workbook](exportworkbook) endpoint can include CSV, XLSX, PDF, PNG, and JSON formats as the response body.
Use of the API is governed by the legal agreement governing your use of the Sigma Service.
## Prerequisites
* [Identify the URL to use](#identify-your-api-request-url) for your API calls.
* [Generate API client ID and secret](generate-sigma-api-client-credentials). You can also have an organization admin generate credentials for you.
* [Use your credentials to generate a bearer token](token).
### Identify your API request URL
The URL you use to send API requests depends o
```
--------------------------------
### Get started with the Sigma REST API
Source: https://help.sigmacomputing.com/sigma-computing/reference/tagworkbook
This section provides an overview of the Sigma REST API and how to get started.
```APIDOC
## GET /branches/1.0/reference/get-started-sigma-api
### Description
Provides an overview of the Sigma REST API and guidance on initial setup.
### Method
GET
### Endpoint
/branches/1.0/reference/get-started-sigma-api
### Parameters
#### Path Parameters
None
#### Query Parameters
None
#### Request Body
None
### Request Example
None
### Response
#### Success Response (200)
- **content** (string) - The documentation content for getting started with the Sigma API.
#### Response Example
```json
{
"content": "Overview of Sigma API..."
}
```
```
--------------------------------
### HTML Link to Sigma API Getting Started
Source: https://help.sigmacomputing.com/sigma-computing/docs/build-a-sankey-diagram
This HTML snippet provides a link to the 'Get Started' section of the Sigma API documentation. It includes descriptive text and an arrow icon for visual appeal, indicating a navigation element.
```html
Customize your workflow
```
--------------------------------
### Get Started with Sigma Computing
Source: https://help.sigmacomputing.com/sigma-computing/docs/create-actions-that-send-notifications-and-export-data
This section guides users on how to begin using Sigma Computing and explore its data capabilities. It directs users to the 'About Sigma' documentation for more information.
```html
```
--------------------------------
### Get Started Card HTML Structure
Source: https://help.sigmacomputing.com/sigma-computing/docs/basic-explore-vs-full-explore
Defines the HTML structure for a 'Get Started' card, featuring a colored background SVG icon and a placeholder for content. This card likely serves as an entry point for new users.
```html
```
--------------------------------
### Sigma API - Get Started
Source: https://help.sigmacomputing.com/sigma-computing/reference/shareworkbookcrossorg
Information on how to get started with the Sigma REST API, including generating API client credentials.
```APIDOC
## Get started with the Sigma REST API
### Description
This guide provides an introduction to the Sigma REST API and outlines the steps required to begin using it. It covers the process of generating API client credentials necessary for authentication.
### Endpoint
`/branches/1.0/reference/get-started-sigma-api`
### Related Topics
- **Generate Sigma API client credentials**: Learn how to generate the necessary credentials for API access.
- **Identify unique IDs in Sigma**: Understand how to identify unique identifiers within Sigma for various operations.
```
--------------------------------
### Sigma REST API - Get Started
Source: https://help.sigmacomputing.com/sigma-computing/docs/makeline
Provides an overview and guidance on how to get started with the Sigma REST API.
```APIDOC
## GET /api/v1/docs/sigma-api
### Description
Retrieves information about the Sigma REST API.
### Method
GET
### Endpoint
/api/v1/docs/sigma-api
### Parameters
#### Path Parameters
None
#### Query Parameters
None
### Request Example
GET /api/v1/docs/sigma-api
### Response
#### Success Response (200)
- **documentation_url** (string) - URL to the detailed Sigma REST API documentation.
#### Response Example
{
"documentation_url": "/branches/1.0/guides/get-started-with-sigmas-api"
}
```
--------------------------------
### Sigma Computing Footer Link - Get Started
Source: https://help.sigmacomputing.com/sigma-computing/docs/choose
Renders a link to a 'Get Started' or similar section within the footer. This snippet includes SVG for an icon and an anchor tag with styling, intended for HTML integration.
```html