GraphQL API Overview
The SensorUp platform provides a comprehensive GraphQL API built on Apollo Federation, allowing you to query and manipulate data across assets, emissions, issues, workflows, and more through a unified graph interface.
Architecture
The SensorUp GraphQL API uses Apollo Federation v2.3 to compose 15 specialized subgraphs into a single, unified API. This architecture enables:
- Domain separation: Each subgraph owns a specific business domain
- Independent deployment: Subgraphs can be updated independently
- Type composition: Entities can be extended across multiple subgraphs
- Optimized queries: The gateway intelligently routes and batches requests
Subgraphs by Domain
| Domain | Subgraphs | Purpose |
|---|
| Connected Asset Management (CAM) | su-cam-assets | Asset types, properties, and hierarchy for connected operations |
| Field Service Management | su-assets, su-issues, su-workflow, su-forms | Form subjects for mobile workflows, issue tracking, workflow orchestration |
| Emissions/LDAR | su-methane-ldar-backend, su-methane-reconcile-backend, su-detections-ingress | LDAR operations, reconciliation, detection ingestion |
| Core Platform | su-backend, su-auth, su-user, su-maps, su-catalog, su-eventhub | Authentication, user management, geospatial services, catalogs, events, core infrastructure |
| Deprecated | su-sites | Site management (deprecated - use su-maps for geospatial features) |
Available Environments
The GraphQL API is available in multiple environments:
| Environment | Gateway URL | Purpose |
|---|
| Demo | https://customer-demo.sensorup.com/api/graphql | Demo and POC environment |
| Staging | Contact your account team | Pre-production testing |
| Production | Contact your account team | Production workloads |
Staging and production URLs are tenant-specific. Contact your SensorUp account team for your organization’s endpoints.
API Capabilities
Queries
- Asset management and profiles
- Emission observations and LDAR workflows
- Issue tracking and templates
- Site and geospatial data
- User and authentication information
- Workflow definitions and tasks
- Dynamic forms and catalogs
Mutations
- Create and update assets
- Manage emission events and observations
- Create and modify issues
- Update workflow states
- User authentication and session management
- Configure asset profiles and views
Common Features
- Relay-style pagination: Cursor-based pagination with
edges, nodes, and PageInfo
- GeoJSON support: Full GeoJSON type system for geospatial data
- Audit trails: Automatic tracking of creation and modification metadata
- Error handling: Consistent
MutationError interface across all mutations
- Entity references: Cross-subgraph entity resolution via Apollo Federation
Getting Started
- Quickstart Guide - Make your first GraphQL query
- Authentication - Learn how to authenticate API requests
- Common Patterns - Understand pagination, filtering, and error handling
- Domain Guides - Explore specific use cases by domain:
You can interact with the API using:
- Apollo Explorer (Recommended): Built-in interactive explorer available as an application plugin
- Demo environment:
https://customer-demo.sensorup.com/plugins/sr/apolloGraphql
- Authentication handled automatically when accessed within the application
- Full schema documentation, query building, and testing capabilities
- Apollo Studio: View the federated schema and query planning (requires credentials)
- HTTP Clients: Any GraphQL client library (Apollo Client, urql, graphql-request, etc.)
- curl: Direct HTTP requests to the gateway endpoint
Schema Reference
For detailed type definitions and technical reference:
Support
Need help with the GraphQL API?
- Review the Domain Guides for common use cases
- Check the Common Patterns for best practices
- Contact your SensorUp account team for technical support
