Skip to content
Knowledge APIs
/
/
/
Get Export Job Status

Get Export Job Status

Request

Overview

The Content Export Status API provides real-time status information to monitor job progress and check completion status.

Status Values

  • Pending: Job is pending start of processing
  • In Progress: Job is actively processing content
  • Completed: Job finished successfully
  • Failed: Job encountered errors and could not complete

Response Information

  • Current Status: Real-time job status
  • Progress Metrics: Items processed, total items
  • Error Details: Specific errors encountered during processing
  • Timing Information: Start time, estimated completion, actual completion

Permission

  • Only a client application can invoke this API.

License

  • This API requires a site license (SKU: EG-CL-RTKA-PT).
Security
oAuthClient(Required scopes:
https://api.egain.cloud/auth/.de...
)
Path
jobIDstringrequired

Example Usage:

GET /content/export/7A84B875-6F75-4C7B-B137-0632B62DB0BD/status
Example:7A84B875-6F75-4C7B-B137-0632B62DB0BD
Headers
Accept-Languagestringrequired

The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).

Enum:"en-US""es-ES""fr-FR""it-IT""de-DE""nl-NL""pt-BR""pt-PT""da-DK""ru-RU"
Example:en-US
GET
/content/export/{jobID}/status
curl -i -X GET \
  https://api.egain.cloud/knowledge/portalmgr/v4/content/export/7A84B875-6F75-4C7B-B137-0632B62DB0BD/status \
  -H 'Accept-Language: en-US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Job Status Retrieved Successfully

The current status and progress information for the specified export job.

Response Details:

  • Status: Current job state (Pending, In Progress, Successful, etc.)
  • Progress: Number of items processed vs. total items
  • Timing: Start time and estimated completion time
  • Errors: Any validation or processing errors encountered
Bodyapplication/json
statusstringrequired
Enum:"Pending""In Progress""Successful""Failed"
Example:"In Progress"
progressobject

Details about the job's progress.

startTimestring, (date-time)

The timestamp when the job started.

Example:"2025-09-15T10:00:00.000Z"
estimatedCompletionstring, (date-time)

The estimated timestamp when the job is expected to finish.

Example:"2025-09-15T11:30:00.000Z"
completionTimestring, (date-time)

The timestamp when the job completed.

Example:"2025-09-15T11:25:00.000Z"
failureTimestring, (date-time)

The timestamp when the job failed.

Example:"2025-09-15T10:45:00.000Z"
resultsobject

Breakdown of completed job results.

errorstring

A description of the job failure reason.

Example:"Connection timeout after processing 1500 items."
Response
Shows an export job that is pending start of processing.
{
  "status": "Pending"
}