Retrieve an insight.

REST API Reference/

Request

Security

oauth2

Path

insightIdstring, (uuid)required

Id of the insight.

Query

ignoreQueryFiltersboolean

Ignore global filter.

Default:true

const query = new URLSearchParams({
  ignoreQueryFilters: 'true'
}).toString();

const insightId = 'YOUR_insightId_PARAMETER';
const instance = 'YOUR_instance_PARAMETER';
const resp = await fetch(
  `https://${instance}.app.willowinc.com/api/v3/insights/${insightId}?${query}`,
  {
    method: 'GET',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

Bodyapplication/json

idstring, (uuid)

Gets or sets the unique identifier of the insight.

customerIdstring, (uuid)

Gets or sets the unique identifier of the customer associated with the insight.

twinIdnull or string

Gets or sets the twin identifier of the insight.

twinNamenull or string

Gets or sets the name of the twin associated with the insight.

insightTypeany(InsightType)

Gets or sets the type of the insight (standard or scenario).

Enum:"standard""scenario"

categoryany(InsightCategory)

Gets or sets the category of the insight.

Enum:"fault""energy""alert""note""goldenStandard""infrastructure""integrityKpi""energyKpi""edgeDevice""dataQuality"

namenull or string

Gets or sets the name of the insight.

descriptionnull or string

Gets or sets the description of the insight.

recommendationnull or string

Gets or sets the recommendation for the insight.

impactScoresArray of objects or null(ImpactScore)

Gets or sets the impact scores associated with the insight.

priorityinteger, (int32)

Gets or sets the priority of the insight.

lastStatusany(InsightStatus)

Gets or sets the last status of the insight.

Enum:"open""ignored""inProgress""resolved""new""deleted""readyToResolve"

stateany(InsightState)

Gets or sets the state of the insight.

Enum:"inactive""active""disabled""insufficientData""archived"

createdDatestring, (date-time)

Gets or sets the date when the insight was created.

updatedDatestring, (date-time)

Gets or sets the date when the insight was last updated.

occurredDatestring, (date-time)

Gets or sets the date when the insight occurred.

detectedDatestring, (date-time)

Gets or sets the date when the insight was detected.

sourceTypeany(SourceType1)

Gets or sets the source type of the insight.

Enum:"willow""app""inspection"

sourceIdnull or string, (uuid)

Gets or sets the unique identifier of the source associated with the insight.

sourceNamenull or string

Gets or sets the name of the source associated with the insight.

primaryModelIdnull or string

Gets or sets the primary model identifier of the insight.

externalIdnull or string

Gets or sets the external identifier of the insight.

externalStatusnull or string

Gets or sets the external status of the insight.

externalMetadatanull or string

Gets or sets the external metadata of the insight.

occurrenceCountinteger, (int32)

Gets or sets the occurrence count of the insight.

createdUserIdnull or string, (uuid)

Gets or sets the unique identifier of the user who created the insight.

ruleIdnull or string

Gets or sets the rule identifier associated with the insight.

ruleNamenull or string

Gets or sets the rule name associated with the insight.

newOccurrenceboolean

Gets or sets a value indicating whether the insight is a new occurrence.

previouslyIgnoredinteger, (int32)

Gets or sets the count of times the insight was previously ignored.

previouslyResolvedinteger, (int32)

Gets or sets the count of times the insight was previously resolved.

reportedboolean

Gets or sets a value indicating whether the insight has been reported.

commentCountinteger, (int32)

Gets or sets the comment count for the insight.

lastResolvedDatenull or string, (date-time)

Gets or sets the date when the insight was last resolved.

lastIgnoredDatenull or string, (date-time)

Gets or sets the date when the insight was last ignored.

locationDetailsArray of objects or null(Location)

Gets or sets the location details, including twin ID, name, and model ID.

tagsArray of strings or null

Gets or sets the tags associated with the insight.

ignoreUntilnull or string, (date-time)

Gets or sets the ignore expiry date for the insight.

openTicketCountinteger, (int32)

Gets or sets the number of open tickets for the insight.

completedTicketCountinteger, (int32)

Gets or sets the number of Completed tickets for the insight.

closedTicketCountinteger, (int32)

Gets or sets the number of closed tickets for the insight.

ticketClosedDatenull or string, (date-time)

Gets or sets the ticket closed date.

ticketCompletedDatenull or string, (date-time)

Gets or sets the ticket completed date.

secondaryTwinsArray of objects or null(TwinSummary)

Gets or sets the secondary twins "secondary components" of the insight.

recommendationsArray of objects or null(InsightRecommendation)

Gets or sets the recommendations of the insight.

dependencyCountinteger, (int32)

Gets or sets the number of insight's dependencies.

actionStatusV2any(InsightActionStatusV2)

Gets or sets the action status of the insight, using InsightActionStatusV2.None when the insight matches no category (rather than coercing to InsightActionStatusV2.NeedsAction as the deprecated InsightActionStatus InsightDto.ActionStatus does).

Enum:"none""needsAction""inProgress""unsuccessfullyActioned""successfullyActioned"

scenarioIdnull or string, (uuid)

Gets or sets the insights parent scenario id.

scenarioNamenull or string

Gets or sets the insights parent scenario name.

firstExecutedCommandDatenull or string, (date-time)

Gets or sets the first executed command date for the insight.

descriptionUpdatedDatenull or string, (date-time)

Gets or sets the date when the insight description was last updated.

twinsIncludedCountnull or integer, (int32)

Gets or sets the number of twins included in the scenario insight.

groupedInsightsCountnull or integer, (int32)

Gets or sets the number of grouped insights in the scenario insight.

sequenceNumbernull or stringdeprecated

Gets or sets the sequence number of the insight.

equipmentIdnull or string, (uuid)deprecated

Gets or sets the unique identifier of the equipment associated with the insight.

typeany(InsightCategory)deprecated

Gets or sets the type of the insight.

Enum:"fault""energy""alert""note""goldenStandard""infrastructure""integrityKpi""energyKpi""edgeDevice""dataQuality"

floorIdnull or string, (uuid)deprecated

Gets or sets the unique identifier of the floor associated with the insight.

locationsArray of strings or nulldeprecated

Gets or sets the locations associated with the insight.

isDiagnosticsDatabooleandeprecated

Gets or sets a value indicating whether the insight contains diagnostics data.

actionStatusany(InsightActionStatus)deprecated

Gets or sets the action status of the insight.

Enum:"needsAction""inProgress""unsuccessfullyActioned""successfullyActioned"

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  "sequenceNumber": null,
  "equipmentId": null,
  "twinId": null,
  "twinName": null,
  "type": "fault",
  "insightType": "standard",
  "category": "fault",
  "name": null,
  "description": null,
  "recommendation": null,
  "impactScores": null,
  "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": "willow",
  "sourceId": null,
  "sourceName": null,
  "primaryModelId": null,
  "externalId": null,
  "externalStatus": null,
  "externalMetadata": null,
  "occurrenceCount": 0,
  "createdUserId": null,
  "ruleId": null,
  "ruleName": null,
  "newOccurrence": true,
  "previouslyIgnored": 0,
  "previouslyResolved": 0,
  "floorId": null,
  "reported": true,
  "commentCount": 0,
  "lastResolvedDate": null,
  "lastIgnoredDate": null,
  "locations": null,
  "locationDetails": null,
  "tags": null,
  "isDiagnosticsData": true,
  "ignoreUntil": null,
  "openTicketCount": 0,
  "completedTicketCount": 0,
  "closedTicketCount": 0,
  "ticketClosedDate": null,
  "ticketCompletedDate": null,
  "secondaryTwins": null,
  "recommendations": null,
  "dependencyCount": 0,
  "actionStatus": "needsAction",
  "actionStatusV2": "none",
  "scenarioId": null,
  "scenarioName": null,
  "firstExecutedCommandDate": null,
  "descriptionUpdatedDate": null,
  "twinsIncludedCount": null,
  "groupedInsightsCount": null
}