Export Jobs

Export jobs are the core of the ExportComments API. Create a job to export comments, reviews, or other data from any supported platform. The API automatically detects the platform from the URL you provide and begins processing.

The Job Object

Field	Type	Description
`id`	integer	Numeric job ID
`guid`	string (uuid)	Unique job identifier used in API requests
`status`	string	Current job status
`url`	string	Source URL being exported
`options`	object	Export options applied to this job
`locked`	boolean	Whether the job is locked
`json_url`	string	URL to the JSON export file (when done)
`download_link`	string	Direct download link for the XLSX file (when done)
`rawFile`	string	Raw file name

Job Statuses

Status	Description
`queueing`	Job is queued and waiting to be processed
`progress`	Job is actively exporting data
`done`	Job completed successfully
`error`	Job failed - can be retried
`stopped`	Job was manually stopped

Status Lifecycle

bash

queueing → progress → done
                    → error (retryable)
                    → stopped

Endpoints

Method	Path	Description
`POST`	`/api/v3/job`	Create a new export job
`GET`	`/api/v3/job/{guid}`	Retrieve a specific job
`GET`	`/api/v3/jobs`	List all jobs
`PATCH`	`/api/v3/job/{guid}/retry`	Retry a failed job
`PATCH`	`/api/v3/job/{guid}/stop`	Stop a running job

Polling vs WebSocket vs Webhooks

💡

Use real-time updates for production

For production integrations, use WebSocket real-time updates for instant progress tracking or webhooks for server-side event processing. Polling consumes rate limit quota and introduces unnecessary latency.

Method	Best For
WebSocket	Dashboards, live progress bars, interactive UIs
Webhooks	Server-to-server integrations, background processing
Polling	Simple scripts, environments without WebSocket support

When polling, check job status every 5-10 seconds. A job transitions from queueing to progress to done (or error). Once status is done, the json_url and download_link fields will be populated.