Siteplore Documentation
Build, connect and operate with confidence.
Product and integration documentation for customer workspaces, edge gateways, device provisioning, telemetry, APIs, dashboards, alerting, security and operations.
Send a telemetry observation
Illustrative request envelope
POST /api/v1/telemetry Authorization: Bearer <device-token> Content-Type: application/json { "timestamp": "2026-09-28T04:30:00Z", "device_id": "RS-GW-001", "measurements": { "motor_current_a": 18.6, "bearing_temp_c": 62.4 }, "quality": "good" }
Quick Start
From a new customer workspace to trusted live data.
Use the onboarding sequence to preserve ownership, naming, access control and data quality from the first device.
Create the customer environment
Define the customer, tenant, sites, user roles and dedicated monitoring workspace.
Register the site and assets
Build an asset hierarchy with stable IDs, equipment names and operating context.
Provision device identity
Issue scoped credentials, map the gateway and define permitted data operations.
Send and validate telemetry
Verify timestamp, unit, scaling, quality, data gaps and end-to-end communication.
Enable dashboards and alerts
Invite users, confirm visibility, test notifications and document response ownership.
Integration preview
One measurement envelope, several transport options.
Use issued tenant and device configuration as the authoritative source. The examples shown here are structural placeholders, not a final public API contract.
{
"schema_version": "<issued-version>",
"timestamp": "2026-09-28T04:30:00Z",
"tenant_id": "<tenant-id>",
"device_id": "<device-id>",
"measurements": {
"parameter_name": {
"value": 0.0,
"unit": "<canonical-unit>",
"quality": "good"
}
}
}
Topic: <issued-prefix>/<tenant-id>/<device-id>/telemetry Recommended client behaviour: • Use TLS and issued device credentials • Publish the approved payload schema • Buffer observations during connection loss • Preserve the original observation timestamp • Retry with bounded backoff
POST https://<issued-api-host>/api/<version>/telemetry Authorization: Bearer <device-token> Content-Type: application/json Idempotency-Key: <unique-observation-id> <approved telemetry payload>
Documentation library
Find documentation by implementation task.
Search by device, protocol, platform function, user role or operating workflow.
Platform overview
Understand Siteplore products, system boundaries, user roles and the flow from field measurement to operational action.
- Products and components
- Reference architecture
- Ownership and responsibilities
Customer, site and asset setup
Create a scalable tenant structure before onboarding devices and measurements.
- Customer and site hierarchy
- Asset IDs and naming
- Deployment ownership
Device provisioning and identity
Register gateways securely and associate each device with the correct customer, site and allowed scope.
- Device registration
- Scoped credentials
- Rotation and deactivation
Field protocol and register mapping
Document addresses, data types, scaling, byte order, polling interval and invalid-value handling.
- RS485 and Modbus mapping
- IO-Link process data
- Scaling and validation
Telemetry data model
Structure observations with stable identifiers, UTC timestamps, canonical units, metadata and quality states.
- Measurement envelope
- Units and timestamps
- Quality and missing data
MQTT telemetry integration
Configure approved topics, payloads, TLS identity, reconnect behaviour and local buffering.
- Topic structure
- Authentication and TLS
- Reconnect and delivery behaviour
HTTPS and REST API integration
Send authorized, idempotent requests and handle validation, retry, rate and response conditions safely.
- Authentication headers
- Request and response lifecycle
- Idempotency and retry
Customer dashboards and analytics
Navigate the dedicated customer stack, dashboards, time ranges, variables, annotations and investigations.
- Dashboard navigation
- Variables and time ranges
- Analysis and investigation workflow
Alerting and incident workflow
Understand severity, notification routing, acknowledgement, escalation, investigation and closure records.
- Alert rules and contact points
- Escalation and ownership
- Evidence and closure
User, role and access management
Invite customer users and grant only the dashboards, data and administrative capabilities needed.
- User invitation
- Role and permission boundaries
- Access review and removal
Security and data governance
Apply scoped credentials, encrypted transport, key rotation, retention, backup and auditable administration.
- Credential lifecycle
- Encryption and segregation
- Retention and auditability
Operations and troubleshooting
Diagnose offline gateways, missing observations, stale timestamps, scaling errors and duplicate data.
- Connectivity diagnostics
- Data-quality troubleshooting
- Support evidence checklist
Customer monitoring workspace
A dedicated observability stack for each customer.
Siteplore can provide a customer-specific Grafana Cloud environment and invite approved users into the stack assigned to their organization.
<customer><customer>.grafana.netauthorized servicesread / publishNeed implementation-specific documentation?
Customer deployments should receive an approved device list, measurement map, issued credentials, endpoint configuration, commissioning records, dashboard ownership and support route.