Authentication is required prior to accessing the Willow API. Refer to Authentication section above for details.
REST API Reference//
- List insights. Pagination applies only to root elements (ScenarioId == null). When fetching a page, include all children of those roots. Search/filtering applies to both parent and children: If a parent matches, return the parent with all its children. If a child matches, return the child and its parent (even if the parent wouldn’t match by itself).
Retrieve an insight.
List insights.
Pagination...
Willow Public API (v3)
Download OpenAPI description
Languages
Servers
https://{instance}.app.willowinc.com/api/v3/
Time Series
The Time Series endpoints are used for sending or receiving telemetry data. Once a Capability twin has been created that represents the time series, the telemetry associated with that twin can be created using either the twin's dtId (aka twinId) or externalId, a timestamp, and a value. Data is transmitted as an array so time series data can be batched and sent within a single request. Similarly, time series can be retreived for one or more Capability twins at a time using the twinId(s).
Operations
Insights
Insights are issues, opportunities, or knowledge that can help optimize or improve the performance of a building. They can be associated with any twin within Willow and are triggered in real-time by Skills that are running within Willow's Activate Technology and analyzing the incoming time series data.
Operations
List insights. Pagination applies only to root elements (ScenarioId == null). When fetching a page, include all children of those roots. Search/filtering applies to both parent and children: If a parent matches, return the parent with all its children. If a child matches, return the child and its parent (even if the parent wouldn’t match by itself).
- https://{instance}.app.willowinc.com/api/v3/insights
- Payload
- JS
- C#
- Java
- Python
{ "sortSpecifications": [ { … } ], "filterSpecifications": [ { … } ], "page": 0, "pageSize": 0 }
Response
application/json
{ "before": 0, "after": 0, "total": 0, "items": [ { … } ] }
- https://{instance}.app.willowinc.com/api/v3/insights/{insightId}
- Payload
- JS
- C#
- Java
- Python
No request payloadOK
Gets or sets the unique identifier of the customer associated with the insight.
Gets or sets the unique identifier of the equipment associated with the insight.
Gets or sets the type of the insight (standard or scenario).
Enum"standard""scenario"
Gets or sets the category of the insight.
Enum"fault""energy""alert""note""goldenStandard""infrastructure""integrityKpi""energyKpi""edgeDevice""dataQuality"
Gets or sets the impact scores associated with the insight.
Gets or sets the last status of the insight.
Enum"open""ignored""inProgress""resolved""new""deleted""readyToResolve"
Gets or sets the state of the insight.
Enum"inactive""active""disabled""insufficientData""archived"
Gets or sets the unique identifier of the source associated with the insight.
Gets or sets the unique identifier of the user who created the insight.
Gets or sets the count of times the insight was previously resolved.
Gets or sets the unique identifier of the floor associated with the insight.
Gets or sets the location details, including twin ID, name, and model ID.
Gets or sets the secondary twins "secondary components" of the insight.
Gets or sets the recommendations of the insight.
Gets or sets the action status of the insight.
Enum"needsAction""inProgress""unsuccessfullyActioned""successfullyActioned"
Gets or sets the type of the insight.
Enum"fault""energy""alert""note""goldenStandard""infrastructure""integrityKpi""energyKpi""edgeDevice""dataQuality"
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac", "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1", "sequenceNumber": "string", "equipmentId": "d2a795e1-f645-4e24-bc0a-ab1965048fcc", "twinId": "string", "twinName": "string", "type": "fault", "insightType": "standard", "category": "fault", "name": "string", "description": "string", "recommendation": "string", "impactScores": [ { … } ], "priority": 0, "lastStatus": "open", "state": "inactive", "createdDate": "2019-08-24T14:15:22Z", "updatedDate": "2019-08-24T14:15:22Z", "occurredDate": "2019-08-24T14:15:22Z", "detectedDate": "2019-08-24T14:15:22Z", "sourceType": "Adx", "sourceId": "797f5a94-3689-4ac8-82fd-d749511ea2b2", "sourceName": "string", "primaryModelId": "string", "externalId": "string", "externalStatus": "string", "externalMetadata": "string", "occurrenceCount": 0, "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe", "ruleId": "string", "ruleName": "string", "newOccurrence": true, "previouslyIgnored": 0, "previouslyResolved": 0, "floorId": "f4b95b27-8806-47f9-baf2-7b034d2e232f", "reported": true, "commentCount": 0, "lastResolvedDate": "2019-08-24T14:15:22Z", "lastIgnoredDate": "2019-08-24T14:15:22Z", "locations": [ "string" ], "locationDetails": [ { … } ], "tags": [ "string" ], "isDiagnosticsData": true, "ignoreUntil": "2019-08-24T14:15:22Z", "openTicketCount": 0, "completedTicketCount": 0, "closedTicketCount": 0, "ticketClosedDate": "2019-08-24T14:15:22Z", "ticketCompletedDate": "2019-08-24T14:15:22Z", "secondaryTwins": [ { … } ], "recommendations": [ { … } ], "dependencyCount": 0, "actionStatus": "needsAction", "scenarioId": "e28e2f4c-7202-4457-b0d8-c4c537f7bff6", "scenarioName": "string" }