Skip to main content
The Interaction Summary API provides pre-aggregated analytics from the materialized InteractionSummary table. Falls back to on-the-fly aggregation from raw InteractionHistory if no materialized data exists.

​
GET /api/v1/interaction-summary

Get aggregated interaction data.

​
Query Parameters

ParameterTypeRequiredDescription
groupBystringNoGrouping dimension: action, treatment, channel, customer (default: action)
daysnumberNoLookback window in days (default: 30)

​
Response — groupBy=action

{
  "groupBy": "action",
  "days": 30,
  "summary": [
    {
      "id": "clx...",
      "name": "Premium Card Upgrade",
      "issue": "Revenue Growth",
      "group": "Credit Cards",
      "status": "active",
      "priority": 90,
      "impression": 1250,
      "click": 87,
      "dismiss": 45,
      "accept": 0,
      "convert": 32,
      "total": 1414,
      "ctr": 6.96,
      "cvr": 2.56,
      "positive": 87,
      "negative": 45,
      "neutral": 1118
    }
  ]
}

​
Response — groupBy=treatment

{
  "groupBy": "treatment",
  "days": 30,
  "summary": [
    {
      "id": "clx...",
      "name": "Email Variant A",
      "offerName": "Premium Card Upgrade",
      "channelType": "email",
      "channelName": "Marketing Email",
      "templateType": "html",
      "abTestVariant": "A",
      "weight": 50,
      "status": "active",
      "impression": 625,
      "click": 52,
      "dismiss": 20,
      "accept": 0,
      "convert": 18,
      "total": 715,
      "ctr": 8.32,
      "cvr": 2.88
    }
  ]
}

​
Response — groupBy=channel

{
  "groupBy": "channel",
  "days": 30,
  "summary": [
    {
      "id": "clx...",
      "name": "Marketing Email",
      "channelType": "email",
      "treatmentCount": 6,
      "impression": 2500,
      "click": 175,
      "dismiss": 90,
      "accept": 0,
      "convert": 0,
      "total": 2765,
      "ctr": 7.0
    }
  ]
}

​
Response — groupBy=customer

Returns top 100 customers by total interactions. 
{
  "groupBy": "customer",
  "days": 30,
  "summary": [
    {
      "customerId": "C-1234",
      "total": 42,
      "impression": 20,
      "click": 8,
      "dismiss": 4,
      "accept": 0,
      "convert": 3,
      "uniqueActions": 5
    }
  ]
}