---
title: "Request export"
method: POST
path: "/v4/export"
tags: ["v4"]
---

# Request export

`POST /v4/export`

## Request

- Base URL: `https://api-exporter.openweb.com`
- URL: `https://api-exporter.openweb.com/v4/export`
- Auth: none declared. Required headers: `Authorization`, `x-spot-id`

Initiates an export of comments, users, and ranks by Conversation ID or date range.

## Headers

- `Authorization` string, required
- `x-spot-id` string, required

## Request body

- union
  - object
    - `from` string, required: Start date of the export date range in `YYYY-MM-DDTHH:MM:SSZ` <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a> format
    - `until` string, required: End date of the export date range in `YYYY-MM-DDTHH:MM:SSZ` <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a> format
    - `conversation_id` string: ID of the Conversation from which data is requested Use one of these approaches to obtain this value: <strong>Article Card</strong> 1. From your OpenWeb Admin Panel, click **Moderation > Articles**. 2. Search for a comment associated with the Conversation. 3. On the comment card, click **More > Copy conversation ID to clipboard**. <strong>Code</strong> 1. Locate the spot ID. Contact your OpenWeb representative if you do not know this value. 2. Identify the post ID. This is the unique article identifier assigned to the article page when it is created. 3. Concatenate the spot ID and postID with an underscore ``` spotID_postID ``` <strong>Comment Card</strong> 1. From your OpenWeb Admin Panel, click **Moderation > Comments**. 2. Search for a comment associated with the Conversation. 3. On the comment card, click **More > Copy conversation ID to clipboard**. </details>
    - `delimiter` ',' | ';': Character that separates individual data fields within each row of the .csv file By default, OpenWeb uses `,`.
    - `max_records_in_file` integer: Number of records per one .csv file
  - object
    - `conversation_id` string, required: ID of the Conversation from which data is requested Use one of these approaches to obtain this value: <strong>Article Card</strong> 1. From your OpenWeb Admin Panel, click **Moderation > Articles**. 2. Search for a comment associated with the Conversation. 3. On the comment card, click **More > Copy conversation ID to clipboard**. <strong>Code</strong> 1. Locate the spot ID. Contact your OpenWeb representative if you do not know this value. 2. Identify the post ID. This is the unique article identifier assigned to the article page when it is created. 3. Concatenate the spot ID and postID with an underscore ``` spotID_postID ``` <strong>Comment Card</strong> 1. From your OpenWeb Admin Panel, click **Moderation > Comments**. 2. Search for a comment associated with the Conversation. 3. On the comment card, click **More > Copy conversation ID to clipboard**. </details>
    - `delimiter` ',' | ';': Character that separates individual data fields within each row of the .csv file By default, OpenWeb uses `,`.
    - `from` string: Start date of the export date range in `YYYY-MM-DDTHH:MM:SSZ` <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a> format
    - `max_records_in_file` integer: Number of records per one .csv file
    - `until` string: End date of the export date range in `YYYY-MM-DDTHH:MM:SSZ` <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a> format

## Response `202`

Example response

- object
  - `request_id` string: Unique ID of the export request
  - `status` 'pending': State of the export request
  - `status_link` string: Check status endpoint

## Other responses

- `409`: Same request already in progress

---

[API](https://skmtc.dev/openweb/apis/export-api.md) - [All operations](https://skmtc.dev/openweb/apis/export-api/llms.txt) - [OpenAPI document](https://skmtc.dev/openweb/apis/export-api/revisions/7b5ae730b48e?raw)