Empower Data API Documentation

Data Flows
Data flows deal with managing the state and status of ongoing jobs and processes in the platform. The following endpoints are provided for retrieving processing status and job lists based on load groups.

1. GET /processing-status/
   • Endpoint: /processing-status/
   • URL Example: https://neo.empoweranalytics.io/data/dv/v1/processing-status?loadGroup=1
   • Parameters:
   • loadGroup (optional)
   • Stored Procedure Executor: generic_processing_status_sproc_executor
   • Stored Procedure Name: state.GetGenericProcessingStatus
   • Description: Retrieves the processing status based on the specified load group. This endpoint allows you to monitor the status of a given load group.
2. GET /job-list/{loadGroupId}
   • Endpoint: /job-list/{loadGroupId}
   • URL Example: https://neo.empoweranalytics.io/data/dv/v1/job-list/{loadGroupId}
   • Parameters:
   • Path: loadGroupId
   • Stored Procedure Executor: job_list_sproc_executor
   • Stored Procedure Name: state.GetJobList
   • Description: Retrieves the job list associated with a specified load group ID, helping developers track jobs within the group.

---

Extraction
Extraction endpoints handle extracting data from the database or Data Factory and updating the extraction statuses.

1. PUT /datafactory-extraction
   • Endpoint: /datafactory-extraction
   • URL Example: https://neo.empoweranalytics.io/data/dv/v1/database-extraction
   • Parameters:
   • Body: databaseId, status
   • Stored Procedure Executor: data_factory_extraction_sproc_executor
   • Stored Procedure Name: state.AddUpdateObjectExtractStatusGeneric
   • Description: Updates the extraction status of an object in Data Factory based on the given databaseId and status.
2. PUT /database-extraction
   • Endpoint: /database-extraction
   • URL Example: https://neo.empoweranalytics.io/data/dv/v1/datafactory-extraction
   • Parameters:
   • Body: objectId, status
   • Stored Procedure Executor: database_extract_status_sproc_executor
   • Stored Procedure Name: state.AddUpdateDatabaseExtractStatus
   • Description: Updates the extraction status of a database using the object ID and status provided in the request body.

---

Ingestion
Ingestion endpoints are used for queuing, retrieving, and updating file objects and ingestion processes.

1. GET /dropbox-file-object
   • Endpoint: /dropbox-file-object
   • URL Example: https://neo.empoweranalytics.io/data/dv/v1/dropbox-file-object?queueId=1
   • Parameters:
   • queueId (optional)
   • Stored Procedure Executor: dropbox_get_sproc_executor
   • Stored Procedure Name: exec state.GetFileObjectToCopy
   • Description: Retrieves Dropbox file objects based on the specified queue ID. This endpoint is useful for file retrieval operations in a Dropbox queue.
2. POST /dropbox-queue
   • Endpoint: /dropbox-queue
   • URL Example: https://neo.empoweranalytics.io/data/dv/v1/dropbox-queue
   • Parameters:
   • Body: folderName, fileName
   • Stored Procedure Executor: dropbox_post_sproc_executor
   • Stored Procedure Name: state.AddDropboxQueue
   • Description: Adds a new file to the Dropbox processing queue using the folder and file name in the request body.
3. PUT /dropbox-queue
   • Endpoint: /dropbox-queue
   • URL Example: https://neo.empoweranalytics.io/data/dv/v1/dropbox-queue
   • Parameters:
   • Body: queueId, processedTimeUtc
   • Stored Procedure Executor: dropbox_put_sproc_executor
   • Stored Procedure Name: state.UpdateDropboxQueue
   • Description: Updates the status of a Dropbox queue item based on the provided parameters.
4. GET /object-ingest-delta
   • Endpoint: /object-ingest-delta
   • URL Example: https://neo.empoweranalytics.io/data/dv/v1/object-ingest-delta?databaseId=96&phase=DELTA&limit=1
   • Parameters:
   • databaseId, phase, limit (optional)
   • Stored Procedure Executor: object_ingest_delta_sproc_executor
   • Stored Procedure Name: state.TryGetObjectIngestDelta
   • Description: Retrieves delta ingest information based on specified parameters.

---

Metadata
Metadata management endpoints allow for inserting and retrieving metadata for different models and batch IDs.

1. POST /metadata/{batch_id}
   • Endpoint: /metadata/{batch_id}
   • URL Example: https://neo.empoweranalytics.io/data/dv/v1/metadata/{batch_id}
   • Parameters:
   • Path: batch_id
   • Stored Procedure Executor: insert_metadata_sproc_executor
   • Stored Procedure Name: state.InsertMetadata
   • Description: Closes a batch based on the provided batch ID, enabling finalization of metadata-related processes.

---

Models
Model endpoints are designed to retrieve entities and metadata related to specific models.

1. GET /models/{model_name}/entities
   • Endpoint: /models/{model_name}/entities
   • URL Example: https://neo.empoweranalytics.io/data/dv/v1/models/{model_name}/entities
   • Parameters:
   • Path: model_name
   • Stored Procedure Executor: model_entities_sproc_executor
   • Stored Procedure Name: model.GetModelEntity
   • Description: Retrieves entities associated with a specified model, providing insight into the components of that model.
2. GET /models/{model_name}/metadata
   • Endpoint: /models/{model_name}/metadata
   • URL Example: https://neo.empoweranalytics.io/data/dv/v1/models/{model_name}/metadata
   • Parameters:
   • Path: model_name
   • Stored Procedure Executor: model_metadata_sproc_executor
   • Stored Procedure Name: model.GetModelMetaData
   • Description: Retrieves metadata for a specified model, offering details about the model's structure and characteristics.

---

Objects
Object endpoints are focused on retrieving and managing database objects and models.

1. GET /object-lookup
   • Endpoint: /object-lookup
   • URL Example: https://neo.empoweranalytics.io/data/dv/v1/object-lookup?databaseId=96&loadGroup=1&flowId=f3e3a4c7-4f1e-4e3b-8e6b-6f5d6e5e4d6d
   • Parameters:
   • databaseId, loadGroup, flowId (optional) • Stored Procedure Executor: object_lookup_sproc_executor
   • Stored Procedure Name: state.GetObjectListById
   • Description: Retrieves object lookup information based on database ID, load group, and flow ID, helping in tracking specific objects across workflows.
2. GET /object
   • Endpoint: /object
   • URL Example: https://neo.empoweranalytics.io/data/dv/v1/object?databaseId=96&objectSchema=dbo&objectName=DimAccount
   • Parameters:
   • databaseId, objectSchema, objectName (optional) • Stored Procedure Executor: object_sproc_executor
   • Stored Procedure Name: state.GetObjectToCopy
   • Description: Retrieves a list of objects to copy based on the specified parameters, supporting replication or backup processes.

Category	Endpoint	URL Structure Example	Parameters	Stored Procedure Executor	Stored Procedure Name	Description
Data Flows	GET /processing-status/	https://neo.empoweranalytics.io/data/dv/v1/processing-status?loadGroup=1	loadGroup (optional)	generic_processing_status_sproc_executor	state.GetGenericProcessingStatus	Retrieves the processing status based on the specified load group.
Data Flows	GET /job-list/{loadGroupId}	https://neo.empoweranalytics.io/data/dv/v1/job-list/{loadGroupId}	Path: loadGroupId	job_list_sproc_executor	state.GetJobList	Retrieves the job list associated with a specified load group ID.
Extraction	PUT /datafactory-extraction	https://neo.empoweranalytics.io/data/dv/v1/database-extraction	Body: databaseId, status	data_factory_extraction_sproc_executor	state.AddUpdateObjectExtractStatusGeneric	Updates the extraction status of an object in Data Factory.
Extraction	PUT /database-extraction	https://neo.empoweranalytics.io/data/dv/v1/datafactory-extraction	Body: objectId, status	database_extract_status_sproc_executor	state.AddUpdateDatabaseExtractStatus	Updates the extraction status of a database.
Ingestion	GET /dropbox-file-object	https://neo.empoweranalytics.io/data/dv/v1/dropbox-file-object?queueId=1	queueId (optional)	dropbox_get_sproc_executor	exec state.GetFileObjectToCopy	Retrieves Dropbox file objects based on the specified queue ID.
Ingestion	POST /dropbox-queue	https://neo.empoweranalytics.io/data/dv/v1/dropbox-queue	Body: folderName, fileName	dropbox_post_sproc_executor	state.AddDropboxQueue	Adds a new file to the Dropbox processing queue.
Ingestion	PUT /dropbox-queue	https://neo.empoweranalytics.io/data/dv/v1/dropbox-queue	Body: queueId, processedTimeUtc	dropbox_put_sproc_executor	state.UpdateDropboxQueue	Updates the status of a Dropbox queue item based on the provided parameters.
Ingestion	GET /object-ingest-delta	https://neo.empoweranalytics.io/data/dv/v1/object-ingest-delta?databaseId=96&phase=DELTA&limit=1	databaseId, phase, limit (optional)	object_ingest_delta_sproc_executor	state.TryGetObjectIngestDelta	Retrieves delta ingest information based on specified parameters.
Ingestion	GET /object-ingest-list	https://neo.empoweranalytics.io/data/dv/v1/object-ingest-list?databaseId=96&phase=DELTA&phaseStatus=QUEUED&loadGroup=1	databaseId, phase, phaseStatus, loadGroup (optional)	object_ingest_list_sproc_executor	state.GetObjectIngestListGeneric	Retrieves a list of ingests filtered by various parameters.
Ingestion	PUT /object-ingest-delta-synapse/{ingestionId}	https://neo.empoweranalytics.io/data/dv/v1/object-ingest-delta-synapse/{ingestionId}	Body: status	object_ingest_status_sproc_executor	state.UpdateObjectIngestStatusGeneric	Updates the status of an ingest operation based on the provided ingestion ID.
Ingestion	GET /object-load-group-ingest	https://neo.empoweranalytics.io/data/dv/v1/object-load-group-ingest?objectId=1&databaseId=96&phase=DELTA&phaseStatus=QUEUED&limit=1&loadGroup=1	objectId, databaseId, phase, phaseStatus, limit, loadGroup (optional)	object_load_group_ingest_sproc_executor	state.GetObjectLoadGroupIngestListGeneric	Retrieves a list of load group ingests based on specified filters.
Metadata	POST /metadata/{batch_id}	https://neo.empoweranalytics.io/data/dv/v1/metadata/{batch_id}	Path: batch_id	insert_metadata_sproc_executor	state.InsertMetadata	Closes a batch based on the provided batch ID.
Models	GET /models/{model_name}/entities	https://neo.empoweranalytics.io/data/dv/v1/models/{model_name}/entities	Path: model_name	model_entities_sproc_executor	model.GetModelEntity	Retrieves entities associated with a specified model.
Models	GET /models/{model_name}/metadata	https://neo.empoweranalytics.io/data/dv/v1/models/{model_name}/metadata	Path: model_name	model_metadata_sproc_executor	model.GetModelMetaData	Retrieves metadata for a specified model.
Models	PUT /object-model-status	https://neo.empoweranalytics.io/data/dv/v1/object-model-status	Body: modelId, status	object_model_status_sproc_executor	state.AddUpdateObjectModelStatusGeneric	Updates the status of an object model based on the provided parameters.
Objects	GET /object-lookup	https://neo.empoweranalytics.io/data/dv/v1/object-lookup?databaseId=96&loadGroup=1&flowId=f3e3a4c7-4f1e-4e3b-8e6b-6f5d6e5e4d6d	databaseId, loadGroup, flowId (optional)	object_lookup_sproc_executor	state.GetObjectListById	Retrieves object lookup information based on database ID, load group, and flow ID.
Objects	GET /object	https://neo.empoweranalytics.io/data/dv/v1/object?databaseId=96&objectSchema=dbo&objectName=DimAccount	databaseId, objectSchema, objectName (optional)	object_sproc_executor	state.GetObjectToCopy	Retrieves a list of objects to copy based on the specified parameters.