> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://help.sigmacomputing.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://help.sigmacomputing.com/_mcp/server.

# Migrate a dataset to a data model (Beta)

POST https://api.sigmacomputing.com/v2/datasets/{datasetId}/migrate
Content-Type: application/json

Migrate a dataset (deprecated) to a data model. The response always includes the dataset's link details and its link and reference counts. For more information on how datasets are migrated to data models, see [Migrate a dataset to a data model](https://help.sigmacomputing.com/docs/migrate-a-dataset-to-a-data-model).

**Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.

### Usage notes
- Retrieve the **datasetId** by calling the [/v2/datasets](https://help.sigmacomputing.com/reference/list-datasets) endpoint.
- To skip the migration and return only the dataset's link details and its link and reference counts, pass `dryRun: true`.

### Usage scenarios
- **Plan dataset migration**: Pass `dryRun: true` to review the datasets and connection tables linked to the dataset, and how many documents reference it, before you migrate.
- **Migrate datasets in bulk**: If you want to migrate several datasets, you can use this endpoint to programmatically migrate the datasets returned by [/v2/datasets](https://help.sigmacomputing.com/reference/list-datasets) with a `migrationStatus` of `not-migrated`.


Reference: https://help.sigmacomputing.com/reference/migrate-dataset-to-data-model

## Authentication

- OAuth2 — send the obtained token as `Authorization: Bearer <token>`

## Servers

- `https://api.sigmacomputing.com` (Server for GCP (US) hosted organizations, default)
- `https://api.sa.gcp.sigmacomputing.com` (Server for GCP (KSA) hosted organizations)
- `https://aws-api.sigmacomputing.com` (Server for AWS US (West) hosted organizations)
- `https://api.us-a.aws.sigmacomputing.com` (Server for AWS US (East) hosted organizations)
- `https://api.ca.aws.sigmacomputing.com` (Server for AWS Canada hosted organizations)
- `https://api.eu.aws.sigmacomputing.com` (Server for AWS Europe hosted organizations)
- `https://api.au.aws.sigmacomputing.com` (Server for AWS Australia and APAC hosted organizations)
- `https://api.uk.aws.sigmacomputing.com` (Server for AWS UK hosted organizations)
- `https://api.us.azure.sigmacomputing.com` (Server for Azure US hosted organizations)
- `https://api.eu.azure.sigmacomputing.com` (Server for Azure Europe hosted organizations)
- `https://api.ca.azure.sigmacomputing.com` (Server for Azure Canada hosted organizations)
- `https://api.uk.azure.sigmacomputing.com` (Server for Azure United Kingdom hosted organizations)
- `https://api.au.azure.sigmacomputing.com` (Server for Azure Australia hosted organizations)

## Request

### Path parameters

- `datasetId` (string, required)

### Body (application/json)

This endpoint expects an object.

- `shouldUpdateReferences` (boolean, required) — Whether to update references in workbooks that use this dataset to point to the new data model.
- `destFolderId` (string, optional) — Optional destination folder ID where the data model should be created. If not provided, the data model will be created in the same folder as the dataset.
- `dryRun` (boolean, optional) — If true, do not perform the migration. Only return the link details and the link and reference counts. Defaults to false.

## Response

### 200

The response body.

- `dataModelId` (string, required, nullable) — ID of the newly-created data model. Null when `dryRun` is true.
- `links` (list of object, required) — All datasets or connection tables linked to this dataset. Each can be a source, target, or part of a series of links.
  - `source` (object or object, required) — The dataset or table that is the source of the link.
    - Dataset
      - `type` (enum, required)
        - Allowed values: `dataset`
      - `datasetId` (string, required) — ID of the dataset.
    - Table
      - `type` (enum, required)
        - Allowed values: `table`
      - `tableId` (string, required) — ID of the connection table.
  - `target` (object or object, required) — The dataset or table the link targets.
    - Dataset
      - `type` (enum, required)
        - Allowed values: `dataset`
      - `datasetId` (string, required) — ID of the dataset.
    - Table
      - `type` (enum, required)
        - Allowed values: `table`
      - `tableId` (string, required) — ID of the connection table.
- `linkCount` (double, required) — Number of links the dataset has to other datasets.
- `referenceCount` (double, required) — Number of references from other datasets to this dataset.

## Examples

**Request**

```json
{
  "shouldUpdateReferences": true
}
```

**Response**

```json
{
  "dataModelId": "string",
  "links": [
    {
      "source": {
        "datasetId": "string",
        "type": "dataset"
      },
      "target": {
        "datasetId": "string",
        "type": "dataset"
      }
    }
  ],
  "linkCount": 1.1,
  "referenceCount": 1.1
}
```

**SDK Code**

```python
import requests

url = "https://api.sigmacomputing.com/v2/datasets/datasetId/migrate"

payload = { "shouldUpdateReferences": True }
headers = {
    "Authorization": "<token>.",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.sigmacomputing.com/v2/datasets/datasetId/migrate';
const options = {
  method: 'POST',
  headers: {Authorization: '<token>.', 'Content-Type': 'application/json'},
  body: '{"shouldUpdateReferences":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sigmacomputing.com/v2/datasets/datasetId/migrate"

	payload := strings.NewReader("{\n  \"shouldUpdateReferences\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<token>.")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.sigmacomputing.com/v2/datasets/datasetId/migrate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<token>.'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"shouldUpdateReferences\": true\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.sigmacomputing.com/v2/datasets/datasetId/migrate")
  .header("Authorization", "<token>.")
  .header("Content-Type", "application/json")
  .body("{\n  \"shouldUpdateReferences\": true\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.sigmacomputing.com/v2/datasets/datasetId/migrate', [
  'body' => '{
  "shouldUpdateReferences": true
}',
  'headers' => [
    'Authorization' => '<token>.',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.sigmacomputing.com/v2/datasets/datasetId/migrate");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "<token>.");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"shouldUpdateReferences\": true\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "<token>.",
  "Content-Type": "application/json"
]
let parameters = ["shouldUpdateReferences": true] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sigmacomputing.com/v2/datasets/datasetId/migrate")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```