Skip to content
First requestVisit website ↗
Navigation

List Sales Coach reviews changed since your last poll

Returns reviews in the key's workspace ordered by last change, oldest first. Poll with the returned next_cursor until has_more is false, then store it and start from it next time. Only reviews that were analysed at least once appear. Changes younger than two minutes are held back until they settle (see as_of), so a cursor never skips a change. Upsert by id, and read the detail only for items whose state is ready. Requires a Sales Coach API key.

GET
https://api.channelautomation.com/api/v1/sales-coach/reviews

Authorization

  • ApiKeyAuth
    API key in header
    required

Query parameters

  • cursor
    optional
    string

    Opaque value from a previous response's next_cursor. Takes precedence over updated_since.

  • updated_since
    optional
    string

    First poll only. Returns reviews changed at or after this time. Omit to start from the beginning.

    format: date-time
  • phone
    optional
    string

    Look up one customer's reviews by phone number, newest first (any format; normalised). A lookup, not the change feed - cannot be combined with cursor or updated_since, returns no deleted reviews, and next_cursor is null.

  • limit
    optional
    integer
    maximum: 100 · minimum: 1 · default: 50

Returns

200

A page of reviews

JSON
  • data
    optional
    array of

    One of the following:

    • SalesCoachReviewItem
      • id
        optional
        string
        format: uuid
      • state
        optional
        ready
        or
        processing
        or
        unavailable

        ready: finished; read the detail. processing: being re-analysed; keep your previous copy. unavailable: the last analysis failed; flag or withdraw your previous copy.

      • title
        optional
        string
        or null
      • source
        optional
        recorded_visit
        or
        uploaded_file
        or
        phone_call
      • recorded_at
        optional
        string
        format: date-time
      • duration_seconds
        optional
        integer
        or null
      • completed_at
        optional
        string

        When the review was first analysed

        format: date-time
      • updated_at
        optional
        string
        format: date-time
      • contact
        optional
        object
        or null
        • id
          optional
          string
          format: uuid
        • name
          optional
          string
          or null
        • phone
          optional
          string
          or null
      • rep
        optional
        object
        or null
        • type
          optional
          person
          or
          ai_assistant
        • name
          optional
          string
      • appointment_id
        optional
        string
        or null
        format: uuid
      • score
        optional
        object
        or null
        • points
          optional
          number
        • max
          optional
          number
        • percent
          optional
          integer
          or null
      • process
        optional
        object
        or null

        How closely the rep followed the published sales steps. A partly followed step counts half.

        • followed
          optional
          number
        • total
          optional
          integer
        • percent
          optional
          integer
          or null
      • analysis_version
        optional
        integer
        or null

        Increases when the review is re-analysed. Re-read the detail when it changes.

      • consent
        optional
        object
        • status
          optional
          string
        • method
          optional
          string
          or null
        • provenance
          optional
          string

          existing_platform_recording for phone calls imported from call recordings

    • SalesCoachReviewTombstone
      • id
        optional
        string
        format: uuid
      • state
        optional
        deleted
      • deleted_at
        optional
        string
        format: date-time
  • next_cursor
    optional
    string
    or null

    Store this and send it as cursor on the next poll. Null only on a first poll that found nothing and gave no updated_since.

  • has_more
    optional
    boolean

    True when another page is ready now. Keep fetching until false.

  • as_of
    optional
    string

    Changes after this time (two minutes before the request) are held for a later poll so none is skipped.

    format: date-time

400

Invalid cursor

401

Missing

403

The key is not a Sales Coach key

429

More than 120 requests a minute for this key. Honour Retry-After.

Type to search…

↑↓ navigate↵ selectEsc close