> 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.

# List lineage for a data model

GET https://api.sigmacomputing.com/v2/dataModels/{dataModelId}/lineage

This endpoint lists the elements, data sources, and upstream lineage for those data sources in a data model, providing a detailed view of how data is interconnected within a data model.

  ### Usage notes
  - Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.

  ### Usage scenarios
  - **Data governance:** Allows data managers to track how information is used and propagated through different data model elements.
  - **Debugging and optimization:** Helps with identifying and resolving issues in data processing or data model structure.
  - **Data source management**: Identify the dependencies of data sources in use in a specific data model.

  ### Best practices
  - Integrate this information into documentation or data dictionaries to enhance transparency and understanding across teams.
  - Use this endpoint to regularly audit data model structures, ensuring that all data connections and transformations are correct and optimized.

Reference: https://help.sigmacomputing.com/reference/list-data-model-lineage-tree

## 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

- `dataModelId` (string, required)

### Query parameters

- `page` (string, optional)
- `limit` (double, optional)

## Response

### 200

The response body.

- `entries` (list of object or object or object or object or object or object or object or object, required)
  - Element details
    - `type` (enum, required)
      - Allowed values: `table`, `dataset`, `data-model`, `element`, `customSQL`, `csv-upload`, `semantic-view`, `sql-document`, `worksheet`
    - `sourceIds` (list of string, required, nullable) — List of direct sources for the element. Either element IDs or data source IDs.
    - `elementId` (string, required) — Unique identifier of the element
    - `dataSourceIds` (list of string, required, nullable) — List of root sources for the element as data source IDs.
  - Source data model details
    - `type` (enum, required)
      - Allowed values: `table`, `dataset`, `data-model`, `element`, `customSQL`, `csv-upload`, `semantic-view`, `sql-document`, `worksheet`
    - `connectionId` (string, required, nullable)
    - `name` (string, required, nullable)
    - `dataModelId` (string, required)
  - Source table or dataset (deprecated) details
    - `type` (enum, required)
      - Allowed values: `table`, `dataset`, `data-model`, `element`, `customSQL`, `csv-upload`, `semantic-view`, `sql-document`, `worksheet`
    - `connectionId` (string, required, nullable)
    - `name` (string, required, nullable)
    - `inodeId` (string, required)
  - Source custom SQL details
    - `type` (enum, required)
      - Allowed values: `table`, `dataset`, `data-model`, `element`, `customSQL`, `csv-upload`, `semantic-view`, `sql-document`, `worksheet`
    - `connectionId` (string, required, nullable)
    - `name` (string, required, nullable)
    - `definition` (string, required)
  - Source CSV upload details
    - `type` (enum, required)
      - Allowed values: `table`, `dataset`, `data-model`, `element`, `customSQL`, `csv-upload`, `semantic-view`, `sql-document`, `worksheet`
    - `connectionId` (string, required, nullable)
    - `name` (string, required, nullable)
    - `csvId` (string, required) — Unique identifier of the uploaded CSV file
  - Source semantic view details
    - `type` (enum, required)
      - Allowed values: `table`, `dataset`, `data-model`, `element`, `customSQL`, `csv-upload`, `semantic-view`, `sql-document`, `worksheet`
    - `connectionId` (string, required, nullable)
    - `name` (string, required, nullable)
    - `semanticViewId` (string, required) — Unique identifier of the semantic view
    - `semanticViewTable` (string, required) — Name of the table within the semantic view
  - Source SQL document details (deprecated)
    - `type` (enum, required)
      - Allowed values: `table`, `dataset`, `data-model`, `element`, `customSQL`, `csv-upload`, `semantic-view`, `sql-document`, `worksheet`
    - `connectionId` (string, required, nullable)
    - `name` (string, required, nullable)
    - `sqlDocumentId` (string, required)
  - Source worksheet details (deprecated)
    - `type` (enum, required)
      - Allowed values: `table`, `dataset`, `data-model`, `element`, `customSQL`, `csv-upload`, `semantic-view`, `sql-document`, `worksheet`
    - `connectionId` (string, required, nullable)
    - `name` (string, required, nullable)
    - `worksheetId` (string, required) — Unique identifier of the worksheet
- `nextPage` (string, required, nullable)
- `total` (double, optional)

## Examples

**Response**

```json
{
  "entries": [
    {
      "dataSourceIds": [
        "string"
      ],
      "elementId": "string",
      "sourceIds": [
        "string"
      ],
      "type": "table"
    }
  ],
  "nextPage": "string",
  "total": 1.1
}
```

**SDK Code**

```python
import requests

url = "https://api.sigmacomputing.com/v2/dataModels/dataModelId/lineage"

headers = {"Authorization": "<token>."}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.sigmacomputing.com/v2/dataModels/dataModelId/lineage';
const options = {method: 'GET', headers: {Authorization: '<token>.'}};

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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sigmacomputing.com/v2/dataModels/dataModelId/lineage"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<token>.")

	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/dataModels/dataModelId/lineage")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<token>.'

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.get("https://api.sigmacomputing.com/v2/dataModels/dataModelId/lineage")
  .header("Authorization", "<token>.")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.sigmacomputing.com/v2/dataModels/dataModelId/lineage', [
  'headers' => [
    'Authorization' => '<token>.',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.sigmacomputing.com/v2/dataModels/dataModelId/lineage");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "<token>.");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "<token>."]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sigmacomputing.com/v2/dataModels/dataModelId/lineage")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

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()
```