Data Source Ingestion Monitoring API

The Data Source Ingestion Monitoring (DSIM) API endpoint provides you with greater visibility into the status of your Data Source ingestion jobs. This API allows you to programmatically check the execution status and key metrics for your configured data sources.

This API uses the /dsexecution endpoint. Make a call to this endpoint to retrieve the latest ingestion job status for a specific data source associated with your tenant.

This API provides you with:

• Increased Transparency: Get clear insight into whether your data ingestion jobs are succeeding, failing, or currently running.

• Proactive Monitoring: Programmatically monitor your critical data pipelines to quickly identify and troubleshoot ingestion issues.

• Improved Control: Stay informed about the duration and success rate of your connector and overall ingestion processes.

How to Access the API:

You can access this API using a GET request to the following endpoint:

https://[your-aisera-platform-url]/dsexecution

Example:

https://abc.api.aisera.cloud/dsexecution?tenantId=123&datasourceId=456

Authentication:

Authenticate your request using Basic Authentication with your Aisera platform credentials (the same username and password you use to log in to the Aisera platform).

Request Parameters:

• tenantId: Your unique tenant ID.

• datasourceId: The ID of the specific data source associated with your bot.

You can find the data source ID on the right side of your Data Source Details window.

Finding the Data Source ID

Example Request (Conceptual - replace with your actual details):

GET https://[your-aisera-platform-url]/dsexecution?tenantId=YOUR_TENANT_ID&datasourceId=YOUR_DATA_SOURCE_ID

Authorization: Basic [Your Base64 Encoded Credentials]

Example: curl --location 'https://abc.api.aisera.cloud/dsexecution?tenantId=123&datasourceId=456' \

--header 'Authorization: Basic dGVzdEB0ZXN0LmNvbTpwYXNzd29yZGhlcmUK' \

--header 'Cookie: stickynesscookie=ed8de418g924f508'

Replace [your-aisera-platform-url], YOUR_TENANT_ID, YOUR_DATA_SOURCE_ID, and [Your Base64 Encoded Credentials] with your specific configuration.

API Response Details:

The API will return a JSON object containing the ingestionStatus for the specified data source's latest run.

The key fields you will find in the response include:

• jobName: The internal name given to the job executed for this data source.

• connectorDurationSecs: The time, in seconds, that the connector part of the ingestion job took to run.

• kbIngestionfailures: The number of Knowledge Base articles or documents that failed specifically at the connector level during this run.

• dataSourceId: The internal ID of the data source.

• ingestionPipelineStatus: The overall status of the entire ingestion pipeline for this job execution. Common values include SUCCEEDED, PENDING, RUNNING, FAILED, or KILLED.

• lastRunStatus: The status of the most recent run. (Note: There is a minor fix pending, so this value might not always be accurate in the very short term.)

• jobDurationSecs: The total time, in seconds, that the entire ingestion pipeline job took to complete.

• ingestionJobExecutionId: The unique internal ID for this specific execution of the ingestion job.

• jobStartedAtTimestamp: The timestamp indicating when this ingestion job execution began.

• kbIngestionCount: The total number of Knowledge Base articles or documents processed during this run (includes both successful and failed items at the connector level).

• ingestionRunMessage: An optional message related to the ingestion run, usually empty for successful runs.

• ingestionRunError: Contains an error message if the ingestion process encountered an error.