About Analytic Ingestion Services
Application Analytics provides specific REST API services to upload or ingest your analytic logic, template definitions, and deployments simultaneously.
You can use either the Analytic UI or any REST client such as Postman to perform the ingestion. However, before you can prepare the .zip file for upload, it is important to understand the configuration, schema definitions, and structure for the expected file for upload or ingestion.
Predix Essentials Analytics has three API endpoints, facilitating three different methods of analytic data ingestion.
| Service Endpoint | Description |
|---|---|
| /analytics/ingestions | This facilitates ingesting all analytic-related data to run deployments. This method requires you to ingest the analytic template, template configurations including supporting files, input, output, and output event definitions. This also requires you to ingest deployment configurations required to run the deployment in the specified analytic runtime. Note: Currently this method is only available through the service endpoint. Ingesting through the Analytic UI does not use this endpoint. |
| /analyticEntries/ingestions | This facilitates ingesting the following files:
|
/deployments/ingestions | This facilitates ingesting deployment configurations only. This assumes that you have already pre-ingested at least one analytic template for which you can add and configure deployments. This requires you to ingest deployment configurations required to run the deployment in the specified analytic runtime. Note: Currently this method is only available through the service endpoint. Ingesting through the Analytic UI does not use this endpoint. |
Expected Folder Structure
The following diagram represents the expected file and folder structure for an analytic ingestion .zip file. All folders and files indicated below are required for ingestion through the /analytics/ingestions endpoint. The diagram indicates the required folders and files for ingestion through the /analyticEntries/ingestions endpoints in blue. It indicates required folders and files for ingestion through the /deployments/ingestions endpoint in teal.
