API Documentation
ExportComments.com Official API 2.0.0
[ Base URL: exportcomments.com/api/v2 ]/data/pages/swagger-v2.yaml
Introduction
Welcome to the ExportComments.com API documentation. EXPORT COMMENTS API enables you to programatically manage and run your exports and retrieve extracted data.
You can find sample code in a variety of languages. By default curl is selected so that you can try out the commands in your terminal.
You may also be interested by our Github account, a place where you can find api clients ready to use.
Authentication
Each request must include your API Key for authentication.
You can find your API Key on your account page
Requests
POST requests must have a form-encoded body and the Content-Type: application/x-www-form-urlencoded; charset=utf-8 header.
GET requests must be url-encoded
All requests must be made over HTTPS. Any HTTP requests are responded to with a HTTP 302 to the equivalent HTTPS address.
If you are using the curl examples, make sure that any data you replace is properly shell-escaped.
ExportComments.com limits API usage to 5 requests per second, with any requests thereafter being queued up to a maximum of 5 requests. Requests thereafter will return a 429 status code.
Responses
Unless explicitly mentioned, JSON will be returned in all responses.
Errors
ExportComments returns standard HTTP errors when possible.
Objects
There is one primary type of object that the ExportComments API operates with.
Export
This object represents an instance of export that was run with a given set of parameters. It has the following properties:
| Property | Description |
|---|---|
| url | The url that this export was sterted on. |
| guid | A globally unique id representing this export |
| status | The status of the export. It can be queueing, requeuing, progress, done, error |
| replies | Wehther export is with nested included |
| repliesCount | Number of nested comments exported |
| createdAt | The time that this export was started at, in UTC +0000. |
| exportedAt | The time that this export was stopped. This field will be null if the export is not done. Time is in UTC +0000. |
| error | Whether the export have problems |
| total | The number of comments available |
| totalExported | The number of comments that have been exported this run. |
| downloadUrl | The relative url for this export ready to download |
| rawUrl | The relative url with JSON-stringified representation of all comments for this export |
Methods
This section describes all of the HTTP endpoints that can be used to manipulate exports.
The typical way to use the ExportComments API is the following:
Start an export
This is done using the
PUT /api/v2/exportmethod belowWait for the export to finish
You can use one of:
1. Webhooks (recommended)
2. Polling theGET /api/v2/export/{UUID}method below. Note there are rate limits on this method.Get the data from the export
Once the export
statusisdone, you can download the data from either the ExportComments website or API.
ExportsEverything about your exports
Everything about your exports