Delpha Data Quality
Last updated March 27, 2025
The Delpha Data Quality add-on is currently in beta.
Table of Contents
The Delpha Data Quality add-on integrates advanced data-quality services into your Heroku applications. It helps detect and address issues such as incomplete, inconsistent, or invalid data, ensuring your application’s data remains accurate and reliable. This add-on is for:
- Heroku app owners and developers aiming to enhance and maintain high-quality data within their Heroku-hosted applications.
- Development teams seeking to integrate continuous data-quality management and reporting solutions.
Prerequisites
Before provisioning the add-on, you must have:
- An active Heroku account with a deployed application.
- Basic understanding of RESTful API calls to interact with add-on endpoints.
Provisioning the Add-on
Reference the Delpha Data Quality Elements page for a list of available plans and regions.
Attach Delpha Data Quality to a Heroku application via the CLI:
$ heroku addons:create delpha-data-quality -a <your-app-name>
Configuration
📊 Dashboard Interface
The add-on provides a web-based dashboard interface for managing your Delpha Data Quality instance. You can access it by clicking on the addon in your app ressources.
The dashboard currently provides: - Overview of your current usage and limits - Basic configuration management - Usage statistics and history - Resource status monitoring
The dashboard is currently in its initial phase and provides basic functionality. More features will be added in future updates, including advanced configuration options, detailed analytics, and interactive data quality reports.
🔎 Getting Your Resource ID
Before using any of the Delpha Data Quality API endpoints, you’ll need your add-on’s resource_id
(UUID). This ID is required for all API calls to identify your specific add-on instance.
Run this command:
heroku addons --json -a <your-app-name>
Look for the Delpha Data Quality add-on and copy the "id"
field — that’s your resource_id
.
Example:
{
"created_at": "2025-03-24T13:22:18Z",
"id": "d70ccee2-db1b-481e-86cf-cf0994d22b3f",
"name": "delpha-data-quality-xyz",
}
You’ll need this ID for all API calls, for example:
curl "https://delpha-heroku.delpha.io/usage/d70ccee2-db1b-481e-86cf-cf0994d22b3f"
Usage
Retrieve Usage
The Delpha Data Quality add-on provides an endpoint to retrieve your application’s token & credit usage. This will return the exact same info than on the dashboard but can be used internally in your app for any custom integration.
Endpoint
GET https://delpha-heroku.delpha.io/usage/{resource_id}
Path Parameter
resource_id
(string): The ID of the resource for which you want to retrieve token & credit usage.
Response
- 200 OK: Successfully retrieved usage information.
- 422 Unprocessable Entity: Validation error due to invalid or missing
resource_id
. - 500 Internal Server Error: An error occurred while retrieving usage information.
Example Request
Replace {resource_id}
with your actual resource ID.
curl -X GET "https://delpha-heroku.delpha.io/usage/{resource_id}"
Example Response
{
"status": "success",
"message": "Usage retrieved successfully.",
"results": {
"max_token": 1000,
"max_credit": 10000,
"start_date": "2025-03-01T00:00:00Z",
"end_date": "2025-03-31T23:59:59Z",
"history": [
{
"date": "2025-03-02T12:34:56Z",
"credits": 50,
"tokens": 100,
"description": "Data enrichment operation"
}
],
"total_tokens": 78,
"total_credits": 900,
}
}
Removing the Add-on
Remove Delpha Data Quality via the CLI:
This action deprovisions the add-on and removes associated configurations. You can’t undo it!
$ heroku addons:destroy delpha-data-quality
Additional Resources
Complete API Reference
The complete API reference is available through our interactive documentation here.
Support
Submit all Delpha Data Quality support and runtime issues via one of the Heroku Support channels. Any non-support-related issues or product feedback is welcome at support@delpha.io
Future Developments
The Delpha Data Quality add-on is under active development. Upcoming features include:
- Data Quality Assessment Endpoints: Evaluate the quality of your data directly through the add-on.
- Data Enrichment Services: Enhance your datasets with additional information, such as validating phone numbers or enriching LinkedIn profiles.
- Plan Upgrades: Flexible plans to accommodate varying data-quality needs.
- Enhanced Dashboard Features:
- Advanced configuration management
- Interactive data quality reports
- Usage analytics and forecasting
- Team management and access control
Stay tuned for updates and new features in future releases.