Request export

post

https://api-exporter.openweb.com/v4/export

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

Body Params

from

string

required

Start date of the export date range in YYYY-MM-DDTHH:MM:SSZ RFC3339 format

until

string

required

End date of the export date range in YYYY-MM-DDTHH:MM:SSZ RFC3339 format

conversation_id

string

ID of the Conversation from which data is requested

Use one of these approaches to obtain this value:

Article Card

From your OpenWeb Admin Panel, click Moderation > Articles.
Search for a comment associated with the Conversation.
On the comment card, click More > Copy conversation ID to clipboard.

Code

Locate the spot ID. Contact your OpenWeb representative if you do not know this value.
Identify the post ID. This is the unique article identifier assigned to the article page when it is created.
Concatenate the spot ID and postID with an underscore

spotID_postID

Comment Card

From your OpenWeb Admin Panel, click Moderation > Comments.
Search for a comment associated with the Conversation.
On the comment card, click More > Copy conversation ID to clipboard.

delimiter

string

enum

Character that separates individual data fields within each row of the .csv file

By default, OpenWeb uses ,.

Allowed:

max_records_in_file

integer

≤ 100000

Number of records per one .csv file

Headers

Authorization

string

required

JWT token to be used for OpenWeb API

You must obtain the JWT token by making a POST /v1/publisher/auth call.

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

Example: Authorization: Bearer JWT_TOKEN

x-spot-id

string

required

Unique OpenWeb identifier for the property from which data is requested

If you do not know your OpenWeb spot ID, please contact your OpenWeb representative.

Responses

409

Same request already in progress

202Example response