Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Acceldata Alerts API

Monitor and manage data quality and pipeline alerts

Acceldata Alerts API is one of 7 APIs that Acceldata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 28 JSON Schema definitions.

Tagged areas include Alerts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 28 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.acceldata.app/v1.

2 operations 2 paths 4 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.acceldata.app/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Acceldata Alerts API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (apiKey). By default, every request must be authenticated.

  • apiKey — Acceldata API key for authentication

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Alerts 2

Monitor and manage data quality and pipeline alerts

GET
/alerts
Acceldata List Alerts
listAlerts 7 params → 200401
POST
/alerts/{id}/acknowledge
Acceldata Acknowledge Alert
acknowledgeAlert 1 param body → 200404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Alert (10 properties), AlertList (4 properties), ErrorResponse (3 properties), AcknowledgeAlertRequest (1 property). Each schema is shown below with its type and property counts.

AlertList
object
Paginated list of alerts
4 properties
ErrorResponse
object
Error response
3 properties
Alert
object
A data quality or pipeline monitoring alert
10 properties
AcknowledgeAlertRequest
object
Request body for acknowledging an alert
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

acceldata-alerts-api-openapi.yml Raw ↑

Other APIs Acceldata publishes across the network.

Acceldata Data Quality Rules API
Acceldata Datasets API
Acceldata Lineage API
Acceldata Pipeline Jobs API
Acceldata Roles API
Acceldata Users API