Documentation > Data Ingestion

API - Ingestion progress of an index (ingest_queue_core_progress)

Data Ingestion

The progress of the Data Ingestion of one index in a light answer, made to be asked again every few seconds.

Endpointhttps://api.opensolr.com/solr_manager/api/ingest_queue_core_progress
MethodGET or POST
Authemail and api_key of your account, as GET or POST parameters: Authentication. Never rate limited.

01 · Parameters

core_nameRequired

The name of your index.

02 · Example

curl -s "https://api.opensolr.com/solr_manager/api/ingest_queue_core_progress?email=YOUR_EMAIL&api_key=YOUR_API_KEY&core_name=my_index"

03 · Answer

totals

Jobs pending, processing, completed and failed (failed_count), and the documents of the active jobs: total, processed, success, failed.

wave

The current wave: the active jobs and the ones finished since the oldest active job was queued.

any_active

true while a job is pending or running.

jobs

Up to 50 active jobs: the running ones first, then the waiting ones in the order they will run.

jobs_hidden

Active jobs beyond those 50.

04 · Errors

ERROR_INVALID_PARAMETERSHTTP 200

No core_name.

ERROR_QUEUE_UNAVAILABLE_TRY_AGAINHTTP 200

The queue did not answer. Ask again.

WRONG_API_HOSTHTTP 404

Called on opensolr.com. The answer carries the right URL.

ERROR_AUTHENTICATION_FAILEDHTTP 403

The email and API key do not match.

05 · Related

Every error code and HTTP status of the API: API errors. Calls per minute and per hour: Rate limits.