OPopenweb
v4

Check export status

Retrieves the status of the export

get/v4/export/status

Request

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

Query parameters

idstring required

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

Headers

Authorizationstring required
Example:Authorization: Bearer JWT_TOKEN

JWT token to be used for OpenWeb API

You must obtain the JWT token by making a <a href="https://developers.openweb.com/reference/post_v1-publisher-auth" target="_blank">POST /v1/publisher/auth</a> call.

In the API call, the JWT token must be preceded by the word Bearer.

Example: Authorization: Bearer JWT_TOKEN

x-spot-idstring required

Unique OpenWeb identifier for the property from which data is requested<br /><br />If you do not know your OpenWeb spot ID, please contact your OpenWeb representative.

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.