Analysis

Read back what the platform found: sentiment distribution, themes, and Custom Monitoring matches for a source. Pair with the analysis.completed webhook instead of polling.

Read processed analysis for a source

get

Partner-vocabulary variant of /surveys/{survey_id}/analysis: sentiment distribution, themes and monitored flags for one source. Flags are monitored at the feedback-group level. Analysis launches automatically after content lands and takes minutes to tens of minutes depending on volume and queue depth; analysis_status: "none" means no completed run has been persisted yet (it does not distinguish queued from in-progress). Pair with the analysis.completed webhook — registered in the dashboard's Integrations Hub — instead of polling.

Response envelope migration: during the current migration window, 2xx responses carry the bare payload shown in the example (the value of the schema's data property, without the {"data": ...} wrapper). The Deprecation and Sunset headers on every 2xx announce this envelope migration — they do not deprecate the endpoint itself. After the Sunset date, responses will be wrapped as {"data": ...} exactly as the schema declares.

Authorizations

AuthorizationstringRequired

API key authentication: pass your key in the Authorization header as Bearer inpk_live_... (or inpk_test_... for a test-environment key). Create and manage keys in the dashboard under Integrations Hub -> API Keys. Each key carries a permission scope (push, create, send, mcp_read, or all) and a per-minute rate limit.

Path parameters

survey_idinteger · int64Required

The source id

Responses

200

Success

application/json

401

Unauthorized — missing or invalid credentials

application/json

403

Forbidden — insufficient permission

application/json

404

Not Found

application/json

429

Rate limit exceeded — see Retry-After header.

application/json

get/api/input/sources/{survey_id}/analysis

GET /api/input/sources/{survey_id}/analysis HTTP/1.1
Host: app.boundary-ai.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "source_id": 9021,
  "feedback_group_id": 1842,
  "feedback_type": "support_ticket",
  "analysis_id": 55710,
  "analysis_status": "available",
  "sentiment_distribution": {
    "veryPositive": 312,
    "positive": 540,
    "neutral": 205,
    "negative": 118,
    "veryNegative": 42
  },
  "themes": [
    {
      "name": "Response time",
      "mentions": 214,
      "avg_sentiment": -0.31,
      "description": "Waiting time before the first reply"
    }
  ],
  "flags": [
    {
      "name": "Churn risk",
      "mentions": 17,
      "avg_sentiment": -0.62,
      "summary": "Accounts describing an intent to cancel",
      "scope": "survey_series"
    }
  ]
}