> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://www.comet.com/docs/opik/llms.txt.

# Start dataset CSV export

POST http://localhost:5173/api/v1/private/datasets/{id}/export

Initiates an asynchronous CSV export job for the dataset. Returns immediately with job details for polling.

Reference: https://www.comet.com/docs/opik/reference/rest-api/datasets/start-dataset-export

## Servers

- `http://localhost:5173/api` (Local server, default)
- `https://www.comet.com/opik/api` (Opik Cloud)

## Request

### Path parameters

- `id` (string, required)

## Response

### 200

Existing export job in progress

- `id` (string, optional)
- `dataset_id` (string, optional)
- `dataset_name` (string, optional)
- `status` (enum, optional)
  - Allowed values: `PENDING`, `PROCESSING`, `COMPLETED`, `FAILED`
- `file_path` (string, optional)
- `error_message` (string, optional)
- `created_at` (datetime, optional)
- `last_updated_at` (datetime, optional)
- `expires_at` (datetime, optional)
- `viewed_at` (datetime, optional)
- `created_by` (string, optional)
- `last_updated_by` (string, optional)

### 202

Export job created

- `id` (string, optional)
- `dataset_id` (string, optional)
- `dataset_name` (string, optional)
- `status` (enum, optional)
  - Allowed values: `PENDING`, `PROCESSING`, `COMPLETED`, `FAILED`
- `file_path` (string, optional)
- `error_message` (string, optional)
- `created_at` (datetime, optional)
- `last_updated_at` (datetime, optional)
- `expires_at` (datetime, optional)
- `viewed_at` (datetime, optional)
- `created_by` (string, optional)
- `last_updated_by` (string, optional)

## Examples

### Example 1

**Response**

```json
{
  "id": "string",
  "dataset_id": "string",
  "dataset_name": "string",
  "status": "PENDING",
  "file_path": "string",
  "error_message": "string",
  "created_at": "2024-01-15T09:30:00Z",
  "last_updated_at": "2024-01-15T09:30:00Z",
  "expires_at": "2024-01-15T09:30:00Z",
  "viewed_at": "2024-01-15T09:30:00Z",
  "created_by": "string",
  "last_updated_by": "string"
}
```

**SDK Code**

```python
import requests

url = "http://localhost:5173/api/v1/private/datasets/id/export"

response = requests.post(url)

print(response.json())
```

```javascript
const url = 'http://localhost:5173/api/v1/private/datasets/id/export';
const options = {method: 'POST'};

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 := "http://localhost:5173/api/v1/private/datasets/id/export"

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

	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("http://localhost:5173/api/v1/private/datasets/id/export")

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

request = Net::HTTP::Post.new(url)

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("http://localhost:5173/api/v1/private/datasets/id/export")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'http://localhost:5173/api/v1/private/datasets/id/export');

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

```csharp
using RestSharp;

var client = new RestClient("http://localhost:5173/api/v1/private/datasets/id/export");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:5173/api/v1/private/datasets/id/export")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

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

### Example 2

**Response**

```json
{
  "id": "string",
  "dataset_id": "string",
  "dataset_name": "string",
  "status": "PENDING",
  "file_path": "string",
  "error_message": "string",
  "created_at": "2024-01-15T09:30:00Z",
  "last_updated_at": "2024-01-15T09:30:00Z",
  "expires_at": "2024-01-15T09:30:00Z",
  "viewed_at": "2024-01-15T09:30:00Z",
  "created_by": "string",
  "last_updated_by": "string"
}
```

**SDK Code**

```python
import requests

url = "http://localhost:5173/api/v1/private/datasets/id/export"

response = requests.post(url)

print(response.json())
```

```javascript
const url = 'http://localhost:5173/api/v1/private/datasets/id/export';
const options = {method: 'POST'};

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 := "http://localhost:5173/api/v1/private/datasets/id/export"

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

	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("http://localhost:5173/api/v1/private/datasets/id/export")

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

request = Net::HTTP::Post.new(url)

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("http://localhost:5173/api/v1/private/datasets/id/export")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'http://localhost:5173/api/v1/private/datasets/id/export');

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

```csharp
using RestSharp;

var client = new RestClient("http://localhost:5173/api/v1/private/datasets/id/export");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:5173/api/v1/private/datasets/id/export")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

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