REST API
The IMS REST API gives you programmatic access to all IMS platform data — sensors, assets, timeseries readings, events, and more. Everything in the Insights UI is backed by this API.
Base URL
https://api.data.everactive.com
API Versions
| Version | Base Path | Best For |
|---|---|---|
| v2020-07 | /v2020-07/ | Full platform access — same API the Insights UI uses |
| Data Services v1 | /ds/v1/ | External integrations — focused endpoint set with a published OpenAPI 3.0 spec |
If you are building a new integration, start with Data Services v1. It has a stable, versioned OpenAPI spec and is designed for M2M (machine-to-machine) use.
Authentication
All API requests require an OAuth 2.0 Bearer token in the Authorization header:
Authorization: Bearer <your-token>
Getting credentials:
- Log into Shoplogix IMS
- Go to API Credentials (requires the Developer role)
- Generate a client ID and secret
See API Credentials for step-by-step instructions on creating, rotating, and managing credentials. 4. Exchange your credentials for a Bearer token via the Auth0 token endpoint
Tokens are scoped to your account. M2M credentials do not expire unless rotated.
Rate Limits
| Limit | Value |
|---|---|
| Default | 10 requests per second |
| Health check endpoints | Exempt |
If you exceed the rate limit, the API returns 429 Too Many Requests. Build exponential backoff into your client.
Data Limits Per Request
| Resource | Max Range / Result Set |
|---|---|
| Machine timeseries | 180-day date range |
| Steam trap timeseries | 365-day date range |
| Gateway timeseries | 365-day date range |
| Readings per call | 5,000 readings maximum |
Available Resources (v2020-07)
| Resource | Description |
|---|---|
| Customers | Account management |
| Sensors (Eversensors) | Sensor data, readings, timeseries, configuration |
| Gateways (Evergateways) | Gateway management, status, offline events |
| Machines | Machine data, alarm states, threshold crossings, timeseries |
| Steam Traps | Trap data, conditions, events, unexpected cold, cost analytics |
| Users | User account and profile management |
| Privileges | Role and permission management |
| Notifications | Notification preferences and subscriptions |
| Files | Upload and download |
| API Credentials | Generate and manage API keys |
| Webhooks | Webhook subscription management |
| MQTT Subscriptions | MQTT outbound stream management |
| Data Brokers | MQTT broker connection details |
Available Resources (Data Services v1)
| Resource | Description |
|---|---|
| Eversensors | Sensor data for external integrations |
| Gateways | Gateway data for external integrations |
| Customers | Customer data for external integrations |
| Webhooks | Webhook subscription management |
| MQTT | MQTT outbound subscription management |
| Virtual Hosts (VHosts) | Broker virtual host access |
OpenAPI Specification
The Data Services v1 OpenAPI 3.0 spec is available from your Shoplogix account team. The v2020-07 API does not have a separately published spec file.
Data Retention
| Data Type | Retention Period |
|---|---|
| Raw sensor readings | ~1.5 years (548 days) |
| Sensor aggregates | ~6 months (180 days) |
| Event log (CDC events) | ~3 months (90 days) |
| Gateway status | ~1.5 years (548 days) |
Next Steps
- Webhooks — receive event data pushed to your endpoint in real time
- MQTT Streaming — subscribe to a high-throughput sensor data stream