ROroarkhq
Dashboard

Create a dashboard

Changed on

Creates a dashboard with its widgets. Each widget is an analytics query (see POST /v1/analytics/query) with a name unique on the dashboard, a display (LINE, NUMBER, RADAR, STACKED_BAR, TABLE) and a size (SMALL, MEDIUM, LARGE, EXTRA_LARGE). Widgets render top to bottom in the order given.

Dashboard filters apply over every widget and must be conversation-level: AGENT_PROPERTY, CALL_PROPERTY, MODALITY, DATASET or METRIC_VALUE. On a field a widget already filters, the dashboard's wins.

post/v1/dashboard

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/dashboard
  • Auth
    HTTP bearer

Request body

namestring required
descriptionstring
isDefaultboolean

Example request

{
  "name": "Support agent health",
  "timeRange": {
    "type": "LAST",
    "value": 30,
    "unit": "DAYS"
  },
  "filters": [
    {
      "type": "MODALITY",
      "value": "call"
    }
  ],
  "widgets": [
    {
      "name": "Sentiment",
      "display": "LINE",
      "size": "LARGE",
      "interval": "DAY",
      "measures": [
        {
          "metric": "sentiment_score",
          "aggregation": "AVG"
        }
      ]
    },
    {
      "name": "Calls",
      "display": "NUMBER",
      "measures": [
        {
          "type": "CONVERSATION"
        }
      ]
    }
  ]
}

Response

The created dashboard

Changes

  • 8913d3b08c7bRevision changes
    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /////// became optional for the status

    • breaking

      the response property ///// became optional for the status

    • breaking

      the response property /////// became optional for the status

    • warning

      added the new IS_NOT_SET enum value to the /// response property for the response status

    • warning

      added the new IS_NOT_SET enum value to the /////// response property for the response status

    • warning

      added the new IS_NOT_SET enum value to the ///// response property for the response status

    • warning

      added the new IS_NOT_SET enum value to the /////// response property for the response status

    • warning

      added the new IS_NOT_SET enum value to the ///// response property for the response status

    • warning

      added the new IS_SET enum value to the /// response property for the response status

    • warning

      added the new IS_SET enum value to the /////// response property for the response status

    • warning

      added the new IS_SET enum value to the ///// response property for the response status

    • warning

      added the new IS_SET enum value to the /////// response property for the response status

    • warning

      added the new IS_SET enum value to the ///// response property for the response status

    • info

      the request property // became optional

    • info

      the request property ////// became optional

    • info

      the request property //// became optional

    • info

      the request property ////// became optional

    • info

      added the new IS_NOT_SET enum value to the request property //

    • info

      added the new IS_NOT_SET enum value to the request property //////

    • info

      added the new IS_NOT_SET enum value to the request property ////

    • info

      added the new IS_NOT_SET enum value to the request property //////

    • info

      added the new IS_NOT_SET enum value to the request property ////

    • info

      added the new IS_SET enum value to the request property //

    • info

      added the new IS_SET enum value to the request property //////

    • info

      added the new IS_SET enum value to the request property ////

    • info

      added the new IS_SET enum value to the request property //////

    • info

      added the new IS_SET enum value to the request property ////

  • 2e403107d6ecRevision changes
    • info

      endpoint added