APIs used by Task Mining Desktop Application
The Task Mining Desktop Application uses the following APIs to communicate with the Celonis Platform.
Task Mining Desktop Application version ≥ 2.17.0
Client Authentication: Clients are authenticated in the Celonis team using client specific OAuth credentials.
Communication Encryption: Protocol: HTTPS using TLS 1.2 or higher on default port 443.
Target URL | Description |
|---|---|
https://{team}.{realm}.celonis.cloud/task-mining/api/public/v2/activation/{activationCode} | This endpoint is used to activate, i.e. connect a client to a specific project in the Celonis team. |
https://{team}.{realm}.celonis.cloud/task-mining/api/clients/{clientId}/configuration | This endpoint is used to retrieve the configurations for the client from the connected Task Mining project. Periodic request to update configuration, which expires after 24 hours. |
https://{team}.{realm}.celonis.cloud/task-mining/api/clients/{clientId}/log | This endpoint is used to send log messages e.g. to identify client errors in the overview in the Celonis team. |
https://{team}.{realm}.celonis.cloud/task-mining/api/clients/{clientId}/status | This endpoint is used to send client status updates to see an overview in the Celonis team, e.g. running or paused. |
https://{team}.{realm}.celonis.cloud/task-mining/api/clients/{clientId}/heartbeat | This endpoint is used to send signals to the Celonis team to show an overview of “online” clients. |
https://{team}.{realm}.celonis.cloud/task-mining/api/clients/{clientId}/metrics | This endpoint is used to send non-personalised usage metrics e.g. to identify potential client issues. |
https://{team}.{realm}.celonis.cloud/continuous-batch-processing/api/v1/{PoolId}/items | This endpoint is used to upload parquet files containing the User Interaction events to the Celonis team using the continuous batch processing API. |
https://{team}.{realm}.celonis.cloud/image-collector/api/v3/upload/{userId}?bucketId={bucketId} | This endpoint is used to upload screenshots (if enabled) to the Celonis team into the Image Storage (storage bucket). |
https://{team}.{realm}.celonis.cloud/integration/api/v1/data-push/{PoolId}/jobs/{jobId}/chunks/upserted | This endpoint is used to upload parquet files to Celonis cloud, if Use Old Data Push API is activated. (deprecated, see Task Mining Configuration Editor). |
https://{team}.{realm}.celonis.cloud/image-collector/api/v2/upload/{userId}/ | This endpoint is used to upload image files to Celonis cloud, if Use Old Image Upload API. (deprecated, see Task Mining Configuration Editor). |
Task Mining Desktop Application version < 2.17.0
Client Authentication: Clients are authenticated in the Celonis team using an API key.
Communication Encryption: Protocol: HTTPS using TLS 1.2 or higher on default port 443.
Target URL | Description |
|---|---|
https://{team}.{realm}.celonis.cloud/task-mining/api/public/activation/{activationCode} | This endpoint is used to activate, i.e. connect a client to a specific project in the Celonis team. |
https://{team}.{realm}.celonis.cloud/task-mining/api/public/configuration | This endpoint is used to retrieve the configurations for the client from the connected Task Mining project. Periodic request to update configuration, which expires after 24 hours. |
https://{team}.{realm}.celonis.cloud/task-mining/api/public/logs | This endpoint is used to send log messages e.g. to identify client errors in the overview in the Celonis team. |
https://{team}.{realm}.celonis.cloud/task-mining/api/public/update-status | This endpoint is used to send client status updates to see an overview in the Celonis team, e.g. running or paused. |
https://{team}.{realm}.celonis.cloud/task-mining/api/public/clients/{clientId}/states | This endpoint is used to send signals to the Celonis team to show an overview of “online” clients. |
https://{team}.{realm}.celonis.cloud/continuous-batch-processing/api/v1/{PoolId}/items | This endpoint is used to upload parquet files containing the User Interaction events to the Celonis team using the continuous batch processing API. |
https://{team}.{realm}.celonis.cloud/image-collector/api/v3/upload/{userId}?bucketId={bucketId} | This endpoint is used to upload screenshots (if enabled) to the Celonis team into the Image Storage (storage bucket). |
https://{team}.{realm}.celonis.cloud/integration/api/v1/data-push/{PoolId}/jobs/{jobId}/chunks/upserted | This endpoint is used to upload parquet files to Celonis cloud, if Use Old Data Push API is activated. (deprecated, see Task Mining Configuration Editor). |
https://{team}.{realm}.celonis.cloud/image-collector/api/v2/upload/{userId}/ | This endpoint is used to upload image files to Celonis cloud, if Use Old Image Upload API. (deprecated, see Task Mining Configuration Editor). |