Skip to content
Developer docsChannel Automation Developers
First requestVisit website ↗
Navigation

Get one Sales Coach review with its summary, scorecard, coaching and transcript

Returns a finished review. Call it only for list items whose state is ready. A 404 or 409 is not a failure of your workflow: the change that caused it appears again in a later list poll. Requires a Sales Coach API key.

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

Authorization

  • ApiKeyAuth
    API key in header
    required

Path parameters

  • id
    string
    required
    format: uuid

Query parameters

  • include
    optional
    string

    Comma-separated sections to return. Defaults to all four.

Returns

200

The review

JSON
  • data
    optional
    object
    • 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

    • summary
      optional
      object
      • summary
        optional
        string
        or null
      • outcome
        optional
        string
        or null
      • customer_sentiment
        optional
        string
        or null
      • topics
        optional
        array of
        string
      • next_steps
        optional
        array of
        string
      • commitments
        optional
        array of
        string
      • customer_needs
        optional
        array of
        string
      • products_discussed
        optional
        array of
        string
      • budget
        optional
        string
        or null
      • timeline
        optional
        string
        or null
      • objections
        optional
        array of
        object
        • text
          optional
          string
        • category
          optional
          string
          or null
        • response
          optional
          string
          or null
        • at_seconds
          optional
          number
          or null
      • competitors
        optional
        array of
        object
        • name
          optional
          string
        • context
          optional
          string
          or null
        • sentiment
          optional
          string
          or null
        • comparison
          optional
          string
          or null
        • at_seconds
          optional
          number
          or null
      • buying_intent
        optional
        object
        or null
        • level
          optional
          string
        • reasoning
          optional
          string
          or null
      • deal_probability_estimate
        optional
        number
        or null

        An AI estimate from this conversation alone (0-100). Not a forecast.

    • scorecard
      optional
      object
      or null
      • scorecard_version
        optional
        integer
        or null
      • points
        optional
        number
      • max
        optional
        number
      • percent
        optional
        integer
        or null
      • sections
        optional
        array of
        object
        • key
          optional
          string
        • label
          optional
          string
        • score
          optional
          number
        • max
          optional
          number
        • reason
          optional
          string
          or null
        • at_seconds
          optional
          number
          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
        • steps
          optional
          array of
          object
          • key
            optional
            string
          • label
            optional
            string
          • verdict
            optional
            done
            or
            partly
            or
            skipped
          • reason
            optional
            string
            or null
          • at_seconds
            optional
            number
            or null
    • coaching
      optional
      array of
      object
      • title
        optional
        string
        or null
      • detail
        optional
        string
        or null
      • at_seconds
        optional
        number
        or null
    • transcript
      optional
      array of
      object

      Every segment, in order. Times are null for some imported phone calls.

      • index
        optional
        integer
      • at_seconds
        optional
        number
        or null
      • end_seconds
        optional
        number
        or null
      • speaker
        optional
        agent
        or
        customer
        or
        other
        or
        unknown
      • text
        optional
        string

400

include names an unknown section

401

Missing

403

The key cannot read Sales Coach reviews

404

Not found in this workspace

409

not_ready: the review exists but is not finished (for example it is being re-analysed). changed: it changed while being read; retry after retry_after_seconds.

413

The transcript has more than 10

429

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

Type to search…

↑↓ navigate↵ selectEsc close