Search customer insights for an event using smart filters.
post
/sia/v1/impact/event/{eventId}/customerInsights/search
Returns impacted customers grouped across event impacts, ordered by the configured priority mode. Search and filters apply before pagination. Response totals and totalMonetaryValue represent the complete matching result set, not only the returned page.
Request
Path Parameters
-
eventId(required): string
The event document id.Example:
UELINK5003
Query Parameters
-
limit: integer(int32)
Minimum Value:
1Requested customer page size. If omitted, defaults to 100. The optional impact.customerInsights.customerLimit property can set a different default and maximum page size; values above it are capped. -
offset: integer(int32)
Minimum Value:
0Zero-based customer offset. If omitted, the offset is 0.
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 retrieved successfully.
Root Schema : CustomerInsightsResponse
Type:
objectCustomers impacted by an event, sorted by configured party characteristic.
Show Source
-
billAmountCurrency: string
Configured currency label for bill amounts and totalMonetaryValue.
-
customers: array
customers
Current page of impacted customers in configured priority order.
-
eventId: string
Event document id.
-
limit: integer
(int32)
Minimum Value:
1Effective page size after applying the configured customer limit. -
offset: integer
(int32)
Minimum Value:
0Zero-based customer offset used for this page. -
sortCharacteristic: string
Customer characteristic used by the configured priority mode.
-
sortMode: string
Configured customer priority mode. Supported values are billAmount and tier.
-
tierOrder: array
tierOrder
Configured tier priority order. Populated when tier sorting is configured.
-
totalCustomers: integer
(int32)
Total number of unique customers matching the request, independent of pagination.
-
totalImpactedResources: integer
(int32)
Total number of impacted resources associated with matching customers, independent of pagination.
-
totalMonetaryValue: number
(double)
Total bill amount across all unique customers matching the request, independent of pagination.
Nested Schema : customers
Type:
arrayCurrent page of impacted customers in configured priority order.
Show Source
-
Array of:
object CustomerInsight
Customer details and configured sort attribute for an impacted customer.
Nested Schema : tierOrder
Type:
arrayConfigured tier priority order. Populated when tier sorting is configured.
Show Source
Nested Schema : CustomerInsight
Type:
objectCustomer details and configured sort attribute for an impacted customer.
Show Source
-
billAmount: number
(double)
-
customerCategory: string
-
customerHref: string
-
customerId: string
-
customerName: string
-
customerRole: string
-
customerSince: string
(date-time)
Date from which the party has been a customer, in ISO-8601 UTC format.Example:
2024-03-06T07:02:32.056Z -
customerType: string
-
email: string
-
impactedResourceCount: integer
(int32)
-
location: string
-
phone: string
-
sortValue:
sortValue
Numeric value used to order this customer for the configured sort mode. Contains the bill amount or tier rank.
-
tier: string
-
tierRank: integer
(int32)
Nested Schema : sortValue
Numeric value used to order this customer for the configured sort mode. Contains the bill amount or tier rank.
Match One Schema
Show Source
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