Sign in

v1

latestOpenAPI 3.0.02026-07-24191334.4 KB
v2

Request export

post/v2/export/comments

Headers

apikeystring required

Unique OpenWeb export token<br /><br />Follow these steps to obtain the export token:<ol><li>From your OpenWeb Admin Dashboard, click <strong>Settings</strong>.</li><li>Under <strong>Authentication Tokens</strong>, click <strong>ApiKey</strong>.</li><li>Copy the key.</li></ol>

Request body

sincestring 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

tostring 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

If not set, the default value is the current date and time.

Example request

{
  "since": "2018-12-01T00:00:00Z",
  "to": "2018-12-02T00:00:00Z"
}

Response

Example response

request_idstring

Unique ID of the export request

status'pending'

State of the export request

status_linkstring

Check status endpoint