OpenAPI specification

We use OpenAPI specification to describe all DataClarity‘s APIs. Each OpenAPI file is visualized with Swagger, a fully interactive documentation tool that allows you to:

  • Visualize and interact with the API resources using your data.

  • Try out the API before integrating it into your code.

  • Download the API documentation (OpenAPI definition files version 3.0.3)

For more information on how to test APIs, see Testing the APIs.

API reference documentation per each component is provided with the Platform’s installation, where “localhost” is the name or IP address that was configured for the Platform.

Data Preparation API
  • Swagger: https://localhost/dp/swagger-ui/index.html

  • Additional documentation with usage and SDK samples: https://localhost/dp

Storyboards API

  • Swagger: https://localhost/sb/swagger-ui/index.html

  • Additional documentation with usage and SDK samples: https://localhost/sb

Scheduler API

  • Swagger: https://localhost/scheduler/swagger-ui/index.html

  • Additional documentation with usage and SDK samples: https://localhost/scheduler

Notification API

  • Swagger: https://localhost/notification/swagger-ui/index.html

  • Additional documentation with usage and SDK samples: https://localhost/notification

API entry points

The base URL points to the root API resources that you can use to interact with the API. The Swagger endpoint reference shows the method, path, resource, and parameters that must be appended to the base URL to form a request.

The following are the examples of well-formed REST URLs:



The base URLs for each component are the following.


Base URL

Storyboards API


Data Preparation API


Notification API


Scheduler API


Was this article helpful?
0 out of 0 found this helpful



Please sign in to leave a comment.