Customer Alliance Analytics API

openapi: 3.2.0
info:
  title: Customer Alliance Analytics API
  summary: Review management, surveys & feedback for hospitality — as an API.
  version: 4.2.0
  description: 'The Customer Alliance API gives you programmatic access to your reviews, surveys, analytics and AI insights, lets you push guests, reviews and survey responses in from your other systems, and lets you subscribe to events via outbound webhooks. ## Getting started


    1. In the dashboard, go to **Settings → API** and create a key, granting only the scopes you need. 2. Copy the key (`ca_live_…`) — it''s shown once. 3. Send it as a Bearer token on every request:


    ```bash

    curl https://app.customer-alliance.com/api/v4/reviews \

    -H "Authorization: Bearer ca_live_your_key_here"

    ```


    Call `GET /whoami` to confirm the key resolves to the account, node and scopes you expect. ## Authentication


    Every request needs `Authorization: Bearer `. Keys are created and scoped in **Settings → API**. ## Scopes


    Each key holds a subset of `reviews:read`, `surveys:read`, `analytics:read`, `insights:read`, `nodes:read`, `webhooks:manage`, `guests:write`, `reviews:write`, `surveys:write`. A call missing its scope returns `403`. ## Hierarchy


    A key is bound to one node in your account hierarchy; **read** endpoints cover that node and its subtree, and **write** endpoints (`POST /guests`, `POST /reviews`, `POST /survey-responses`) write to one property within it. The webhook-management endpoints (`/webhooks*`) are the exception — they operate account-wide and ignore the key''s node binding (see **Webhooks**) — and so are the attribute definitions of `GET /property-attributes`, which describe the account rather than a property (see **Property attributes**). ## Display scope


    By default, read endpoints return everything on your account''s subtree. An API key authenticates the account owner reading their own data — the same data the dashboard shows — so nothing is withheld from you. If the response will be shown to the public, pass `?display=public`:


    ```bash

    curl "https://app.customer-alliance.com/api/v4/reviews?display=public" \

    -H "Authorization: Bearer ca_live_your_key_here"

    ```


    Supported on `GET /reviews` and `GET /reviews/{id}` (`reviews:read`), and `GET /insights/mentions` (`insights:read`). It excludes two groups: review portals whose content may not be republished (some license redisplay as a paid product, or have terms that have not been cleared for it), and sources whose authorship was never verified — reviews entered by hand (`manual`) and imported ones (`upload`: CSV uploads, and everything pushed through `POST /reviews` or `POST /survey-responses`). Only the exact value `public` opts in. Any other value is ignored and you get the default, unfiltered behaviour — deliberately, so that a typo cannot silently withhold data. Rather than tracking which platforms may be republished yourself, use `?display=public` and let the API apply the current set. > **Upgrading an existing integration.** `GET /reviews` previously withheld these platforms from every caller. It no longer does. If you use it to power anything the public sees, add `?display=public` before upgrading — without it you will begin receiving reviews from platforms that may not be republished. If you use it for internal analytics, reporting or warehousing, you need to do nothing; you simply get more complete data. ### Survey responses


    Responses to your Customer Alliance surveys are never returned by `GET /reviews`, `GET /reviews/{id}` or `GET /insights/mentions`, with or without `display=public`. This is not a publishing restriction: a survey-bridged review is a representation of a response that `GET /surveys/{id}/responses` already serves, and returning it from both would make a consumer summing across them count the same feedback twice. To work with survey feedback, use the surveys endpoints. Survey responses imported from another tool — pushed through `POST /survey-responses` or uploaded as a CSV — are the reverse: they are returned by the review endpoints as `upload` reviews, and the surveys endpoints do not list them. Either way, each response is served exactly once.'
  termsOfService: https://www.customer-alliance.com/en/terms-and-conditions/
  contact:
    name: Customer Alliance Support
    email: info@customer-alliance.com
    url: https://www.customer-alliance.com/
servers:
- url: https://app.customer-alliance.com/api/v4
  description: Production
security:
- bearerAuth: []
tags:
- name: Analytics
  description: Score and rating aggregates.
paths:
  /analytics/scores:
    get:
      summary: Aggregate reputation scores for the key's node subtree
      description: Requires `analytics:read`.
      operationId: getAnalyticsScores
      tags:
      - Analytics
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsScores'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
      example:
        error: Invalid API key
    AnalyticsScores:
      type: object
      description: Aggregate reputation scores for the key's node subtree.
      properties:
        node_id:
          type: string
          format: uuid
        overall_score:
          type:
          - number
          - 'null'
          description: Overall score on a 0–5 scale (one decimal).
        overall_score_normalized:
          type:
          - number
          - 'null'
          description: Overall score normalised to 0–100 (may carry one decimal; round for whole-percent display).
        total_reviews:
          type: integer
        recommend_rate:
          type:
          - number
          - 'null'
        response_rate:
          type:
          - number
          - 'null'
        platform_scores:
          type: array
          items:
            type: object
            properties:
              platform:
                type: string
              score:
                type:
                - number
                - 'null'
                description: Platform score on a 0–5 scale (one decimal).
              score_normalized:
                type:
                - number
                - 'null'
                description: Platform score normalised to 0–100 (may carry one decimal; round for whole-percent display).
              reviews:
                type: integer
        ca_score:
          type: object
          description: 'The CA Score (Customer Alliance Score) for the key''s subtree, all time: half the online portal score, half the survey score, weighted equally however many reviews or responses there are, as the dashboard shows it. It is not `overall_score`, which is the portal score alone.'
          properties:
            score_100:
              type:
              - number
              - 'null'
              description: 0–100, one decimal; null when neither half has a rating.
            basis:
              type:
              - string
              - 'null'
              enum:
              - both
              - portal
              - survey
              - null
              description: Which halves the score rests on. With one half missing, the score is that half.
            low_sample:
              type: boolean
              description: A half the score rests on has fewer than 10 ratings.
            portal:
              type: object
              description: The mean score of portal reviews with a rating, from the review sources the account has connected.
              properties:
                score_100:
                  type:
                  - number
                  - 'null'
                rated:
                  type: integer
            survey:
              type: object
              description: 'The mean overall score of completed responses to surveys owned within the subtree that count toward the CA Score. Surveys switched out of the CA Score, and imported or pushed responses, are left out. An aggregate under `analytics:read`: no response or answer is returned, which is what `surveys:read` covers.'
              properties:
                score_100:
                  type:
                  - number
                  - 'null'
                scored:
                  type: integer
  responses:
    Forbidden:
      description: The key lacks the required scope, or the account's plan does not include it.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key created in Settings → API (`ca_live_…`).
externalDocs:
  description: Customer Alliance
  url: https://www.customer-alliance.com/