3.10 API Documentation

Noction Flow Analyzer API provides a wide range of capabilities to access NFA data. It lets users read all the resources including dashboards, widgets, devices, alerts, filters, reports, and more. Some of these resources are read-only and some can also be created/edited/deleted via the API. The API documentation is available via the NFA’s frontend under the Management > API Documentation section.

All endpoints in the NFA are thoroughly documented and displayed with comprehensive details. Each endpoint includes a clear description of its functionality, a detailed request body specifying the required parameters, the content type expected in the request, a schema outlining the structure of the request data, the expected response format, and the corresponding response codes that signify the outcome of the request.

Below is represented a POST request for login functionality in Postman.

Upon successful authentication, the server responds with a token. This token grants access to additional functionalities and endpoints within the application.

Additionally, Postman provides a cURL command, enabling us to make requests directly from the terminal.

Below is an example of an endpoint used to extract flow data for a specified time range, with the start time set to 2024-06-11T06:17:29Z and the end time set to 2024-06-11T10:17:29Z. The request utilizes query parameters and a JSON object in the request body.

Presented here are the request body and response body for our request.

All the result regarding this request are displaying in response body.