OPopenweb
v2

Check export status

Retrieves the status of the export

get/v2/export/comments/status

Request

  • Base URL
    https://api-exporter.openweb.com
  • URL
    https://api-exporter.openweb.com/v2/export/comments/status
  • Auth
    none declared. Required headers: apikey

Query parameters

idstring

Unique ID of an export request<br /><br /> This value is returned in the API response to a POST /v2/export/comments call.

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>

Response

Example response

linksstring[]

Secured URLs to an export download, present only when "status": "done"

status'aborted' | 'done' | 'failed' | 'in_progress' | 'pending'

State of the export request

Changes

No recorded changes to this operation across all 1 revision of this API.