Analytics

Score and rating aggregates.

Aggregate reputation scores for the key's node subtree

get

Requires analytics:read.

Authorizations

bearerAuth

AuthorizationstringRequired

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

Responses

200

OK

application/json

Aggregate reputation scores for the key's node subtree.

node_idstring · uuidOptional

overall_scorenumber · nullableOptional

Overall score on a 0–5 scale (one decimal).

overall_score_normalizednumber · nullableOptional

Overall score normalised to 0–100 (may carry one decimal; round for whole-percent display).

total_reviewsintegerOptional

recommend_ratenumber · nullableOptional

response_ratenumber · nullableOptional

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/analytics/scores

HTTPcURLJavaScriptPython

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

{
  "node_id": "123e4567-e89b-12d3-a456-426614174000",
  "overall_score": null,
  "overall_score_normalized": null,
  "total_reviews": 1,
  "recommend_rate": null,
  "response_rate": null,
  "platform_scores": [
    {
      "platform": "text",
      "score": null,
      "score_normalized": null,
      "reviews": 1
    }
  ]
}