POST
/
analytics
/
preview-metric
Preview metric query widget
curl --request POST \
  --url https://core.ravenna.ai/api/analytics/preview-metric \
  --header 'Content-Type: application/json' \
  --header 'x-ravenna-api-token: <api-key>' \
  --data '{
  "query": {
    "dataSource": "Ticket",
    "aggregations": [
      {
        "type": "count",
        "alias": "<string>",
        "field": "id"
      }
    ],
    "filterGroups": [
      [
        {
          "field": "<string>",
          "condition": "<string>",
          "value": "<string>",
          "given": "<string>"
        }
      ]
    ],
    "groupBy": "<string>",
    "limit": 123,
    "sortOrder": "ASC",
    "hideEmptyValues": true
  },
  "workspaceId": "<string>",
  "dateRange": {
    "from": "<string>",
    "to": "<string>"
  },
  "period": "hour",
  "ravFilters": [
    {
      "field": "<string>",
      "condition": "<string>",
      "value": "<string>",
      "given": "<string>"
    }
  ]
}'
{
  "type": "<string>",
  "data": [
    {
      "groupId": "<string>",
      "groupName": "<string>",
      "value": 123
    }
  ],
  "chartConfig": {}
}

Authorizations

x-ravenna-api-token
string
header
required

Body

application/json
query
object
required
workspaceId
string
required
dateRange
object
period
enum<string>
Available options:
hour,
day,
week,
month,
quarter,
year
ravFilters
object[]

Response

Successful response

type
string
required
Allowed value: "grouped"
data
object[]
required
chartConfig
object
required