Get Ingestion Activity Status

Request Method

GET

Request URL

{{BASE_URL}}/ingestion/elt/activity/status/{{activity_id}}

Request Headers

Parameter	Data Type	Field Validations	Description
x-cleartax-auth-token	String	NA	Mandatory. Access token linked to the workspace and environment.

Request Path Params

Parameter	Data Type	Field Validations	Description
activity_id	String	NA	Mandatory. Ingestion Activity ID from previous API.

Request Query Params

There are no query parameters for this API.

Request Body

There will be no request body for this API.

Response Status Codes

HTTP Status Code	Description
200	OK
400	Bad request
401	Unauthorised
403	Forbidden

Response Schema

Parameter	Data Type	Field Validations	Description
activityId	String	NA	Ingestion activity ID that can be used to check status later.
state	String	NA	End state will be “EXECUTION_COMPLETED” or “EXECUTION_FAILURE”

Sample Request and Response

Sample Request

curl --location 'https://api-sandbox.clear.in/ingestion/elt/activity/status/5bfacece-4bca-41d5-a6e0-09370d1f5fe5' \
--header 'x-cleartax-auth-token: ' \
--data ''

Sample Response

{
    "activityId": "5bfacece-4bca-41d5-a6e0-09370d1f5fe5",
    "state": "EXECUTION_COMPLETED",
    ……. (other parameters that can be ignored)
}

API Validations

Currently there are no known validations.

API Constraints

1. There can be multiple intermediate states. It may take 10-15 mins for an activity to complete based on the size of the files uploaded that need to be processed. Further if there is any error, it will be retried thrice before reaching the end state.

2. Use exponential intervals for polling status.