Export Comments v4

OpenWeb enables you to export comments with their authors and ranks. You can export comments based on a Conversation ID.

When initiating an export, be mindful of the following:

• Each time an export is initiated, a new data set is generated.
• The duration of the export process depends upon the size of the data set.
• The Export API is not meant for incremental or repetitive queries.

---

Prerequisite

---

Create an export

Use the following steps to create an export:

1. Make a POST /v4/export call. The API returns the check status endpoint populated with the export request ID as the value of status_link.

   cURL

   curl -L -X POST 'https://api-exporter.openweb.com/v4/export' \
        -H 'Authorization: Bearer JWT_TOKEN' \
        -H 'accept: application/json' \
        -H 'apikey: EXPORT_TOKEN' \
        -H 'Content-Type: application/json' \
        -H 'x-spot-id: SPOT_ID' \
        -d '{"from": "2022-07-30T00:00:00Z", "until": "2022-07-30T23:59:00Z","conversation_id": "CONVERSATION_ID"}'
   

   
   

2. Use the status_link value to make a GET /v4/export/status call. The API returns secured URLs to download the export in a links array. If the export download is not ready, the API returns "status": "Processing".

   cURL

   curl -L GET 'https://api-exporter.openweb.com/v4/export/status?id=EXPORT_REQUEST_ID' \
        -H 'Authorization: Bearer JWT_TOKEN' \
        -H 'apikey: EXPORT_TOKEN' \
        -H 'Content-Type: application/json'
   

   
   

3. Copy and paste the links into a web browser to download the .csv.zip file. Each .csv file will contain at most 100,000 comments.

   ⚠️

   The links secure links are only available for one week after being generated.

---

Export Field Reference

This section lists and defines each field returned in the exported data.

Comments

Users

Ranks

---