- 0 minutes to read

Using the Nodinite Web API

All Nodinite data is accessible through a REST API with full Swagger documentation. Export Log Views, Monitor states, Repository configurations, and more as JSON data. Consume this data in your preferred tool: Excel, Power BI, Python, Postman, custom applications, or any HTTP-capable platform.

Why Use the Web API?

  • Universal Access – All Nodinite data exposed via standard REST endpoints
  • Swagger Documentation – Interactive API explorer with request/response examples
  • Tool Agnostic – Use Excel, Power BI, Python, curl, Postman, or custom code
  • Real-Time Data – Query current system state, no exports or file transfers needed
  • Secure – Uses your existing Nodinite credentials and role-based access controls
  • Flexible Formats – JSON responses easy to parse and transform

Getting Started with the Web API

1. Explore the Swagger Documentation

Nodinite includes built-in Swagger UI for interactive API exploration:

  1. Navigate to your Nodinite Web Client
  2. Access the API documentation at: https://your-nodinite-server/swagger
  3. The Swagger UI displays:
    • All available API endpoints (Log, Monitor, Repository, Administration, etc.)
    • Request parameters and query options
    • Response schemas with example JSON
    • Authentication requirements
    • "Try it out" functionality to test endpoints directly in your browser

Tip

Use Swagger's Try it out button to test API calls and see real responses before integrating into your tools.

2. Obtain an API URL

There are two ways to get API endpoints:

  1. Open Nodinite and navigate to Log View, Monitor View, or any data view
  2. Configure your search filters and criteria (date range, application, message type, etc.)
  3. Click Search or Run Query to execute your query
  4. Locate the Actions or More Options menu ()
  5. Select Copy API URL
  6. The URL is copied to your clipboard, including:
    • Base API endpoint
    • All your search parameters (filters, pagination, sorting)
    • Authentication requirements

Example copied URL:

https://your-nodinite-server/api/LogView/Search?startDate=2026-01-01T00:00:00&endDate=2026-01-28T23:59:59&applicationName=SalesforceIntegration&pageSize=100

Option B: Build from Swagger Documentation

  1. Open Swagger UI (https://your-nodinite-server/swagger)
  2. Browse to the desired endpoint (e.g., /api/LogView/Search)
  3. Click Try it out
  4. Fill in parameters (dates, filters, etc.)
  5. Click Execute to see the constructed URL and test the response
  6. Copy the Request URL shown in the response section

3. Authenticate

All API calls require authentication using your Nodinite credentials:

Authentication Methods:

  • Windows Authentication – Automatic if accessing from domain-joined machine
  • Basic Authentication – Username and password (HTTPS required)
  • Bearer Token – For service accounts and automation (contact administrator)

Warning

Always use HTTPS when authenticating to protect credentials in transit.

Common Use Cases

Excel with Power Query

Best for: Business analysts who need ad-hoc reporting and pivot tables.

How to use:

  1. Get Power Query – Included in Excel 2016+ and Microsoft 365. For older versions, download Power Query add-in
  2. Data > Get Data > From Other Sources > From Web
  3. Paste the API URL copied from Nodinite
  4. Authenticate with your Nodinite username/password
  5. Transform JSON – Power Query auto-detects JSON; expand records/arrays as needed
  6. Select fields – Choose only the columns you need (LogTime, ApplicationName, MessageType, etc.)
  7. Load to Excel – Click "Close & Load" to import data

Benefits: No coding required, visual query builder, refresh data on demand.

Power BI

Best for: Executive dashboards, real-time visualizations, and scheduled data refresh.

How to use:

  1. Open Power BI Desktop
  2. Get Data > Web
  3. Paste the Nodinite API URL
  4. Authenticate with Nodinite credentials
  5. Transform JSON using Power Query Editor (same as Excel)
  6. Create visualizations: charts, tables, KPIs
  7. Publish to Power BI Service for sharing and scheduled refresh

Benefits: Real-time dashboards, mobile access, scheduled refresh, sharing with stakeholders.

Python / Custom Scripts

Best for: Automation, integration with SIEM/monitoring tools, custom alerting, data science.

Example using Python requests:

import requests
from requests.auth import HTTPBasicAuth
import json

# API endpoint from Nodinite
url = "https://your-nodinite-server/api/LogView/Search"

# Query parameters
params = {
    "startDate": "2026-01-01T00:00:00",
    "endDate": "2026-01-28T23:59:59",
    "applicationName": "SalesforceIntegration",
    "pageSize": 100
}

# Authenticate
auth = HTTPBasicAuth('your-username', 'your-password')

# Make request
response = requests.get(url, params=params, auth=auth, verify=True)

# Parse JSON
data = response.json()

# Process results
for item in data['items']:
    print(f"{item['logTime']} - {item['messageName']} - {item['state']}")

Benefits: Full automation, integration with existing systems, scheduled jobs, alerting logic.

Postman / API Testing Tools

Best for: Testing API responses, troubleshooting, building custom integrations.

How to use:

  1. Open Postman or similar tool (Insomnia, REST Client)
  2. Create new GET request
  3. Paste Nodinite API URL
  4. Configure Authorization tab (Basic Auth or Windows Auth)
  5. Add query parameters as needed
  6. Click Send to see JSON response
  7. Inspect response schema, test filters, validate data

Benefits: Interactive testing, save request collections, share with team, generate code snippets.

Direct Browser Access

Best for: Quick data checks, URL testing, debugging.

How to use:

  1. Copy API URL from Nodinite
  2. Paste into browser address bar
  3. Authenticate when prompted (if using Windows Auth, automatic)
  4. View raw JSON response in browser
  5. Use browser extensions (JSONView, JSON Formatter) for readable formatting

Benefits: No tools required, instant access, works from any device.

Example: Excel Power Query Step-by-Step

Here's a detailed walkthrough for Excel users (most common scenario):

From Web

Open Excel, go to the Data tab, click Get Data > From Other Sources > From Web.
From the web
Select "From web" to provide the API URL.

Authentication

Choose your authentication method:

  • Windows – If on domain-joined machine
  • Basic – Username and password for Nodinite
  • Organizational account – For cloud/SSO setups

Enter your Nodinite credentials when prompted. Authentication
Select authentication method and enter credentials.

Note

Your Nodinite role determines what data you can access via the API. The same permissions apply as in the Web Client.

Transform JSON

Power Query automatically detects JSON format. In the Power Query Editor:

  1. The response appears as a Record or Table
  2. Click the expand button () next to complex fields
  3. Select which nested fields to include
  4. Power Query converts JSON arrays to table rows

Parse to JSON
Power Query recognizes JSON and offers transformation options.

Select Columns

Choose only the data columns you need to keep your Excel file lightweight:

  1. Right-click column headers and Remove unwanted columns
  2. Or use Choose Columns to select specific fields
  3. Common useful fields:
    • LogTime – When the message was logged
    • ApplicationName – Source application
    • MessageName – Integration/message type
    • State – Success/Error/Warning
    • OriginalMessageId – Unique identifier
    • CustomData – Application-specific metadata

Items
Expand "Items" collection to access individual log entries.

Data
Expand nested "Data" objects to reveal message fields.

Message Type
Select specific fields like MessageType relevant to your analysis.

Tip

Uncheck "Use original column name as prefix" to keep column names short.

Load Data

Once your columns are configured:

  1. Review the preview at the bottom of Power Query Editor
  2. Verify data types are correct (dates, numbers, text)
  3. Click Close & Load to import into Excel
  4. Data appears as an Excel Table on a new worksheet

Ready
Preview transformed data before loading.

Close
Close & Load imports data to Excel worksheet.

Refresh Data

To get updated data from Nodinite:

  1. Right-click the table in Excel
  2. Select Refresh
  3. Power Query re-executes the API call with the same parameters
  4. Data updates automatically

Or set up automatic refresh:

  • Data > Queries & Connections > Query Properties
  • Enable Refresh every X minutes for near-real-time data

Finish
Data is now in Excel, ready for pivot tables, charts, and analysis.

Available API Endpoints

Nodinite exposes multiple API categories (explore in Swagger UI):

Log API

  • /api/LogView/Search – Query log messages with filters
  • /api/LogView/Count – Get message counts without full data
  • /api/LogView/{id} – Retrieve specific log entry by ID
  • /api/LogView/MessageBody – Get full message payload/body

Monitor API

  • /api/Monitor/Resources – Current state of monitored resources
  • /api/Monitor/Alarms – Active alarms and alerts
  • /api/Monitor/History – Historical monitor state changes

Repository API

  • /api/Repository/Applications – Integration applications
  • /api/Repository/Endpoints – Configured endpoints
  • /api/Repository/CustomFields – Metadata definitions

Administration API

  • /api/Administration/Users – User accounts
  • /api/Administration/Roles – Security roles and permissions

Tip

Visit /swagger on your Nodinite server to see all available endpoints with full documentation and "Try it out" functionality.

Best Practices

Security

  • Always use HTTPS for API calls to encrypt credentials
  • Use service accounts with limited permissions for automation
  • Rotate passwords regularly for API access accounts
  • Never hardcode credentials in scripts – use environment variables or secure vaults

Performance

  • Use date range filters to limit response size (don't query all history)
  • Set pageSize parameter to reasonable values (100-1000 records per call)
  • Use pagination for large datasets (combine multiple API calls)
  • Cache responses in your application to avoid repeated identical queries

Query Optimization

  • Apply filters in the API call (via query parameters) rather than filtering after fetching all data
  • Use Count endpoints first to check result size before fetching full data
  • Combine filters: applicationName, state, messageType, customField values

Data Refresh

  • For Excel/Power BI: Set refresh schedules aligned with your SLA needs
  • For automation: Use cron jobs or scheduled tasks to poll API at intervals
  • Consider webhooks or event subscriptions for real-time alerting (contact administrator)

Next Steps

  • Explore Swagger UI – Visit /swagger on your Nodinite server to see all available endpoints
  • Create Custom Log Views – Configure filters and queries for specific scenarios: Log Views
  • Build Dashboards – Use Power BI or custom web apps to visualize Nodinite data
  • Automate Workflows – Integrate Nodinite data into SIEM, ticketing, or monitoring systems
  • Web API Security – Role-based access control and API authentication
  • Log Views – Create custom queries for specific integration scenarios
  • Monitor Alarms – Set up alerting rules and notification workflows
  • Custom Fields – Add metadata to log entries for better filtering

Troubleshooting

Q: I get "401 Unauthorized" errors
A: Verify your Nodinite credentials. Check that your account has permission to access the requested data (Log View, Monitor, etc.).

Q: API returns empty results but I see data in the Web Client
A: Check date range filters – ensure startDate and endDate cover the period you expect. Verify filter parameters match exactly.

Q: JSON response is too large / Excel crashes
A: Reduce pageSize parameter. Add more specific filters (applicationName, state, etc.). Use pagination to fetch data in chunks.

Q: How do I get message body/payload?
A: Use /api/LogView/MessageBody endpoint with the specific log entry ID. The main Search endpoint returns metadata only to improve performance.

Q: Can I use the API for real-time monitoring?
A: Yes – set up scheduled queries (every 1-5 minutes) in Power BI or custom scripts. For true real-time, contact administrator about event subscriptions or webhooks.

Additional Resources

  • Swagger UI – Interactive API documentation: https://your-nodinite-server/swagger
  • Power Query Documentation – Microsoft Learn: Get Data from Web
  • Power BI REST API Connector – Microsoft Docs
  • Python Requests Library – requests.readthedocs.io