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
Query Parameters
  • Minimum Value: 1
    Requested 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.
  • Minimum Value: 0
    Zero-based customer offset. If omitted, the offset is 0.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : filters
Type: array
Applied smart search filters for customer insights.
Show Source
Nested Schema : FilterChip
Type: object
Show Source
  • Name of the smart search filter.
  • 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
Nested Schema : value-oneOf[1]
Type: array
Show Source
Nested Schema : value-oneOf[3]
Type: array
Show Source
Nested Schema : value-oneOf[5]
Type: array
Show Source
Examples

Back to Top

Response

Supported Media Types

200 Response

Customer insights retrieved successfully.
Body ()
Root Schema : CustomerInsightsResponse
Type: object
Customers impacted by an event, sorted by configured party characteristic.
Show Source
Nested Schema : customers
Type: array
Current page of impacted customers in configured priority order.
Show Source
Nested Schema : tierOrder
Type: array
Configured tier priority order. Populated when tier sorting is configured.
Show Source
Nested Schema : CustomerInsight
Type: object
Customer details and configured sort attribute for an impacted customer.
Show Source
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
Body ()
Root Schema : ErrorType
Type: object
Show Source
Nested Schema : message
Type: array
Show Source

401 Response

The request is unauthorized
Body ()
Root Schema : ErrorType
Type: object
Show Source
Nested Schema : message
Type: array
Show Source

403 Response

The request is forbidden
Body ()
Root Schema : ErrorType
Type: object
Show Source
Nested Schema : message
Type: array
Show Source

500 Response

An Internal Server Error has occurred
Body ()
Root Schema : ErrorType
Type: object
Show Source
Nested Schema : message
Type: array
Show Source
Back to Top