Use Cases/Guides
Configuration Audit
The SitePro API enables you to retrieve full site configurations and compare them against a defined master standard. This allows teams to perform automated configuration audits, ensuring consistency across sites and preventing drift over time.
By regularly validating configurations, organizations can maintain standardized deployments, reduce errors, and ensure compliance with internal or regulatory requirements.
Endpoint: /v1/config/site
Request
curl -X GET
-H "Authorization: <JWT_Token>"
"https://platform.sitepro.com/v1/config/site?siteId={siteId}"
Response
Returns a single object with five arrays. Each array contains fully detailed objects for that equipment type, including hardware register mappings.
| Array | Contains |
|---|---|
| devices | Hardware I/O devices and their Modbus register definitions. |
| sensors | All sensors on the site - units, conversion settings, min/max ranges, and register references. Typically the largest array (50-150+ items). |
| meters | Flow meters linked to their sensors and flow register mappings. |
| pumps | Pumps with linked sensors (head pressure, suction, vibration) and VFD register mappings. |
| tankGroups | Tank groups with capacity, height limits, oil/water layer settings, and linked sensor IDs. |
Note: Objects across the five arrays link to each other via ID fields - for example, a pump references its sensors by SiteSensorID and its meter by SiteFlowMeterID. Use these to build your equipment relationships after loading the config.
Lighter Alternatives
| Endpoint | Use when... |
|---|---|
| GET /v1/config/site/light | You need equipment config but not full register-level detail. |
| GET /v1/config/site/compact | You only need basic equipment identity and linkage. |
| GET /v1/config/updates/site | You want only what has changed since a given date (requires startDate query param). |
How It Works
- Retrieve Site Configurations
Pull current configuration data for your sites using the API - Define a Master Configuration
Establish a baseline configuration to compare against - Compare Configurations
Programmatically identify differences between site configs and the master - Flag or Report Drift
Highlight mismatches, missing components, or unexpected changes - Take Action
Update configurations manually or trigger automated correction workflows
What to Compare
Site Structure
- Site IDs and naming conventions
- Device and edge configurations
- Enabled features or modules
Sensor Configuration
- Sensor IDs and types
- Units of measurement
- Sensor-to-device mappings
Asset & Hierarchy Mapping
- Equipment structure and relationships
- Sensor alignment to assets
- Organizational consistency across sites
Other Ways to Use this Endpoint
Standardization Across Sites
- Ensure all sites follow the same configuration template
- Quickly identify outliers or misconfigured locations
Automated Audit Reports
- Generate reports highlighting configuration drift
- Track changes over time for audit history
Deployment Validation
- Verify new site setups match expected configurations
- Catch setup issues early before impacting operations
Compliance & Governance
- Ensure configurations meet internal standards
- Support regulatory or operational audits with documented consistency