ROroarkhq
Live Report

Create a live report

Changed on

Saves a report on the project's live calls. Simulations are never included.

Targets are analytics measures held to a bar: a threshold metric is read as its pass rate (value is a percentage, 0-100, held AT_LEAST by default); a numeric metric as its average (held AT_MOST by default). Every target is read for the period and the period before it, so the report says whether each was met and how it moved.

Scheduled reports are written deliveryHour hours into the day after each period ends in timezone (a week runs Monday to Sunday), then emailed and posted per notifications. With generateNow (the default) the report for the latest closed period is written right away and not sent.

post/v1/live-report

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/live-report
  • Auth
    HTTP bearer

Request body

namestring required
descriptionstring nullable
agentIdstring uuid nullable
dashboardIdstring uuid nullable
cadence'DAILY' | 'WEEKLY' | 'MONTHLY'
timezonestring
deliveryHourinteger
status'ACTIVE' | 'PAUSED'
includeTranscriptExcerptsboolean
generateNowboolean

Write the report for the latest closed period right away. Default true.

Example request

{
  "name": "Front desk weekly",
  "agentId": "0b1c2d3e-4f50-4a6b-8c7d-9e0f1a2b3c4d",
  "filters": [
    {
      "type": "CALL_PROPERTY",
      "property": "region",
      "operator": "EQUALS",
      "value": "EU"
    }
  ],
  "targets": [
    {
      "metric": "task_completion_check",
      "value": 85
    },
    {
      "metric": "customer_frustration",
      "aggregation": "AVG",
      "comparator": "AT_MOST",
      "value": 2
    }
  ],
  "cadence": "WEEKLY",
  "timezone": "Europe/London",
  "deliveryHour": 9,
  "notifications": {
    "email": {
      "enabled": true,
      "recipients": []
    },
    "slack": []
  },
  "includeTranscriptExcerpts": true,
  "generateNow": true
}

Response

The created report

Changes