> For the complete documentation index, see [llms.txt](https://integrations.drivetrain.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.drivetrain.ai/extending-drivetrain/drivetrain-api.md).

# Drivetrain API

Interact with Drivetrain data using APIs and an API key

We provide public APIs to enable our customers to interact programmatically with their Drivetrain account data.

Using the APIs, developers can:

* [**Get metric list API**](/extending-drivetrain/drivetrain-api/get-metric-list-api.md): Get a list of all metrics in your Drivetrain tenant \[GET method]
* [**Get metrics bulk data API**](/extending-drivetrain/drivetrain-api/get-metrics-bulk-data-api.md): Retrieve data for multiple metrics in a single request, across versions, scenarios, time ranges, granularities, and dimensions \[POST method]
* [**Get dimension list API**](/extending-drivetrain/drivetrain-api/get-dimension-list-api.md): Get a list of all dimensions in your Drivetrain tenant \[GET method]
* [**Get dimension values API**](/extending-drivetrain/drivetrain-api/get-dimension-values-api.md): Get all values of a single dimension, along with the attributes attached to each value \[GET method]
* [**Get version list API**](/extending-drivetrain/drivetrain-api/get-version-list-api.md): Get a list of all versions in your Drivetrain tenant \[GET method]
* [**Get scenario list API**](/extending-drivetrain/drivetrain-api/get-scenario-list-api.md): Get a list of all scenarios in your Drivetrain tenant \[GET method]
* [**Get list API**](/extending-drivetrain/drivetrain-api/get-list-api.md): Fetch the contents of a single list in your Drivetrain tenant by its list ID \[GET method]

## API Key (token)

You will need an API key to authenticate and retrieve data from Drivetrain using our Public APIs. To get your API key, follow these steps:

* Navigate to **Settings** > **API Key**
* Click on **Copy**

<figure><img src="https://4220329029-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBZR0D9lq6jrI895OuOU%2Fuploads%2Fgit-blob-5d6ad62a25fd8354f1a4898062e2f018b409df41%2Fdrivetrain-api-01.jpg?alt=media" alt=""><figcaption><p>API key accessible within Settings</p></figcaption></figure>

<figure><img src="https://4220329029-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBZR0D9lq6jrI895OuOU%2Fuploads%2Fgit-blob-c938a90071c2aebf3100fcafcb686870fe323bbc%2Fdrivetrain-api-02.jpg?alt=media" alt=""><figcaption><p>Click on Copy to copy your API key</p></figcaption></figure>

{% hint style="info" %}
You must be added as a **user** in the workspace to view your **API key.**
{% endhint %}

## **Postman Collection Link**

This [Postman collection](https://elements.getpostman.com/redirect?entityId=14817076-fd70b52f-8407-4868-ac39-94a10403162d\&entityType=collection) contains saved examples of request and response for the APIs.

{% embed url="<https://elements.getpostman.com/redirect?entityId=14817076-fd70b52f-8407-4868-ac39-94a10403162d&entityType=collection>" %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://integrations.drivetrain.ai/extending-drivetrain/drivetrain-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.