Get Customer Insights drawer summary.
post
/sia/v1/impact/event/{eventId}/customerInsights/summary
Returns chart-ready summary data for Customer Insights, including monetary value by customer category and services by specification. The topLocations field contains all coordinate-bearing impacted locations for the event and is not restricted to the current customer page or active Customer Insights filters.
Request
Path Parameters
-
eventId(required): string
The event document id.Example:
UELINK5003
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
filters: array
filters
Applied smart search filters for customer insights.
-
searchTerms: string
Free-text search terms for customer insights.
Nested Schema : FilterChip
Type:
Show Source
object-
filter: string
Name of the smart search filter.
-
value:
value
Filter value. Send one scalar value for a single selection or an array of values for a multi-select filter.
Nested Schema : value
Filter value. Send one scalar value for a single selection or an array of values for a multi-select filter.
Match One Schema
Show Source
Examples
Back to Top
Response
Supported Media Types
- application/json
200 Response
Customer insights summary retrieved successfully.
Root Schema : CustomerInsightsSummaryResponse
Type:
objectSummary data for Customer Insights drawer charts.
Show Source
-
customersByTier: array
customersByTier
Customer count grouped by tier for all customers matching the active search and filters.
-
eventId: string
Event document id.
-
monetaryValueByCustomerCategory: array
monetaryValueByCustomerCategory
Bill amount grouped by customer category for all customers matching the active search and filters.
-
resourcesByEntityTypeAndSpecification: array
resourcesByEntityTypeAndSpecification
Impacted services grouped by entity type and specification for customers matching the active search and filters.
-
sortMode: string
Configured customer priority mode. Supported values are billAmount and tier.
-
topLocations: object
HeatMapResponse
Nested Schema : customersByTier
Type:
arrayCustomer count grouped by tier for all customers matching the active search and filters.
Show Source
-
Array of:
object CustomerInsightSummaryItem
One Customer Insights summary chart item.
Nested Schema : monetaryValueByCustomerCategory
Type:
arrayBill amount grouped by customer category for all customers matching the active search and filters.
Show Source
-
Array of:
object CustomerInsightSummaryItem
One Customer Insights summary chart item.
Nested Schema : resourcesByEntityTypeAndSpecification
Type:
arrayImpacted services grouped by entity type and specification for customers matching the active search and filters.
Show Source
-
Array of:
object CustomerInsightSummaryItem
One Customer Insights summary chart item.
Nested Schema : HeatMapResponse
Type:
Show Source
object-
count: integer
(int32)
Number of returned heat-map points.
-
eventId: string
Event document id.
-
items: array
items
Heat-map points.
Nested Schema : CustomerInsightSummaryItem
Type:
objectOne Customer Insights summary chart item.
Show Source
-
count: integer
(int64)
Number of matching customers or impacted resources represented by this bucket.
-
label: string
Display label for the chart bucket.
-
value:
value
Numeric chart value. Its meaning depends on the summary: bill amount, customer count, or configured priority value.
Nested Schema : value
Numeric chart value. Its meaning depends on the summary: bill amount, customer count, or configured priority value.
Match One Schema
Show Source
Nested Schema : HeatMapPoint
Type:
Show Source
object-
childEventId: string
Child event id for impacts under a planned/simulated parent event.
-
entityType: string
Entity type of the impacted entity.
-
id: string
Impact document id.
-
latitude: number
(double)
Latitude of the impacted entity.
-
longitude: number
(double)
Longitude of the impacted entity.
-
name: string
Name of the impacted entity.
-
specification: string
Specification of the impacted entity.
400 Response
The request isn't valid
401 Response
The request is unauthorized
403 Response
The request is forbidden
500 Response
An Internal Server Error has occurred