Insights

AI recommendations, mentions and topics.

List AI recommendations for the account (newest first)

get

Requires insights:read.

Authorizations

bearerAuth

AuthorizationstringRequired

An API key created in Settings → API (ca_live_…).

Query parameters

cursorstringOptional

Opaque pagination cursor from a prior response's next_cursor.

limitinteger · min: 1 · max: 100OptionalDefault: 25

Responses

200

A page of recommendations.

application/json

next_cursorstring · nullableRequired

Pass as ?cursor= to fetch the next page; null on the last page.

has_morebooleanRequired

401

Missing or invalid API key.

application/json

403

The key lacks the required scope, or the account's plan does not include it.

application/json

get/insights/recommendations

HTTPcURLJavaScriptPython

GET /api/v4/insights/recommendations HTTP/1.1
Host: app.customer-alliance.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "title": "text",
      "body": "text",
      "priority": "high",
      "impact": null,
      "canonical_label_id": null,
      "created_at": "2026-08-11T17:39:36.905Z"
    }
  ],
  "next_cursor": null,
  "has_more": true
}

List topic mentions extracted from reviews in the key's subtree (newest first)

get

Requires insights:read.

Authorizations

bearerAuth

AuthorizationstringRequired

An API key created in Settings → API (ca_live_…).

Query parameters

cursorstringOptional

Opaque pagination cursor from a prior response's next_cursor.

limitinteger · min: 1 · max: 100OptionalDefault: 25

Responses

200

A page of mentions.

application/json

next_cursorstring · nullableRequired

Pass as ?cursor= to fetch the next page; null on the last page.

has_morebooleanRequired

401

Missing or invalid API key.

application/json

403

The key lacks the required scope, or the account's plan does not include it.

application/json

get/insights/mentions

HTTPcURLJavaScriptPython

GET /api/v4/insights/mentions HTTP/1.1
Host: app.customer-alliance.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "review_id": "123e4567-e89b-12d3-a456-426614174000",
      "source_field": "text",
      "text": "text",
      "sentiment": null,
      "canonical_label_id": "123e4567-e89b-12d3-a456-426614174000",
      "custom_category_id": null,
      "confidence": null,
      "is_hidden": true,
      "created_at": "2026-08-11T17:39:36.905Z"
    }
  ],
  "next_cursor": null,
  "has_more": true
}

List the canonical topic labels readable by the account

get

Requires insights:read.

Authorizations

bearerAuth

AuthorizationstringRequired

An API key created in Settings → API (ca_live_…).

Responses

200

OK

application/json

401

Missing or invalid API key.

application/json

403

The key lacks the required scope, or the account's plan does not include it.

application/json

get/insights/topics

HTTPcURLJavaScriptPython

GET /api/v4/insights/topics HTTP/1.1
Host: app.customer-alliance.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "language": null,
      "parent_label_id": null
    }
  ]
}