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

Authentication
- Every API call requires an accessKey and secretKey.
- Provide them as headers in your request.
- See Authentication & Headers.
Request Format
- Use standard REST conventions (GET, POST, PUT, DELETE).
- Send and receive data in application/json.
Response Codes

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

Status Code	Description
`200` OK	The request has succeeded. The information returned with the response depends on the method used in the request.
`201` Created	The request has been fulfilled and has resulted in one or more new resources being created.
`204` No Content	The server successfully processed the request and is not returning any content.
`400` Bad Request	The server cannot or will not process the request due to a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
`401` Unauthorized	Authentication is required and has either failed or not been provided. Similar to 403 but specific to authentication.
`403`Forbidden	The server understood the request but refuses to authorize it.
`404` Not Found	The server cannot find the requested resource. Indicates that the resource does not exist.
`405` Method Not Allowed	A request method is not supported for the requested resource. Example: using GET on a resource that requires POST.
`408` Request Timeout	The client did not produce a request within the time that the server was prepared to wait. The client may repeat the request without modification.
`409` Conflict	The request could not be completed due to a conflict with the current state of the resource.
`415` Unsupported Media Type	The request entity has a media type that the server or resource does not support.
`422` Unprocessable Entity	The request was well-formed but was unable to be followed due to semantic errors.
`429` Too Many Requests	The server cannot handle the current level of concurrent API calls. This happens when rate limits are exceeded.
`500` Internal Server Error	A generic error message given when an unexpected condition was encountered.
`503` Service Unavailable	The server is not ready to handle the request. This often happens if the server is down for maintenance or overloaded.
`504` Gateway Timeout	The server, acting as a gateway or proxy, did not receive a timely response from an upstream server.

Error Handling
- Errors are returned in a structured JSON format: { "error": { "code": 401, "message": "Invalid or missing authentication token." } }
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

Last updated on

Was this page helpful?