Introduction

Acceldata provides a comprehensive set of REST APIs that allow you to programmatically interact with your data observability platform. These APIs enable you to:

• Discover data assets – explore datasets, view metadata, and understand schema details.
• Preview & validate data – retrieve sample rows to confirm data correctness without scanning entire datasets.
• Monitor reliability – access pipeline health, anomalies, and reliability metrics.
• Enforce governance – manage policies, rules, and enforcement counts across assets.
• Control access – configure users, groups, and roles for secure data operations.

How to Use These APIs

1. Authentication

   • Every API call requires an accessKey and secretKey.
   • Provide them as headers in your request.
   • See Authentication & Headers.

2. Request Format

   • Use standard REST conventions (GET, POST, PUT, DELETE).
   • Send and receive data in application/json.

3. Response Codes

Acceldata APIs return standard HTTP status codes to indicate whether an API request was successful or failed.

4. Error Handling

   • Errors are returned in a structured JSON format: { "error": { "code": 401, "message": "Invalid or missing authentication token." } }

5. Best Practices

   • Always test with smaller datasets or sample rows before running bulk operations.
   • Use pagination (limit, offset) to avoid retrieving very large results in one request.
   • Organize API usage according to workflows: Discover assets → Preview data → Monitor reliability → Enforce policies.

API Sections

The API documentation is organized by business workflows:

• Assets → Discover, retrieve metadata, preview sample data
• Reliability → Monitor data health, anomalies, and quality rules
• Governance → Policies, rules, and enforcement counts
• Access Management → Users, groups, and roles
• Lineage & Advanced Use Cases → Trace data flow and dependencies