Get the status of an incremental update

You can get the status of a request to create, edit, or delete an index document made though the Ingestion API. To do this, make a GET call to {base-URL}/ingestion/v1/domains/{domain}/sources/{source}/entities/{entity}/status/{incrementalUpdateId}. You can check the status of one index document in one request.

View the swagger reference to see the detailed data model,

Note

Get the value of incrementalUpdateId from the response to a create, edit, or delete request to the Ingestion API.

Here's a sample cURL to get the status of an index document you just created:

RequestResponse
curl --location '{base-URL}/ingestion/v1/domains/{domain}/sources/{source}/entities/{entity}/status/2529ecba-efce-1726-3021-7d6911a962ac' \
--header 'Content-Type: application/json' \
--header 'Authorization: <API_KEY>'

Here's a sample response when a index document was successfully created:

RequestResponse
{"status":"finished"}

Here's a sample response when an index document wasn't created:

RequestResponse
{"status":"failed"}

States of an incremental update

When you send a request to add, edit, or delete an index document, it can be in any of the following states:

  • failed - the request has failed and the index document was not created, updated, or deleted. Retry the request.

  • running - the request is ongoing. Check the status after some time.

  • finished - the request was successful. The index document has been created, updated, or deleted.

Do you have some feedback for us?

If you have suggestions for improving this article,