Skip to main content
POST
/
api
/
utm-dashboard-visualizations
Error
A valid request URL is required to generate request examples
{
  "idVisualization": 123,
  "idDashboard": 123,
  "order": 123,
  "width": 123,
  "height": 123,
  "top": 123,
  "left": 123,
  "id": 123,
  "showTimeFilter": true,
  "defaultTimeRange": "<string>",
  "gridInfo": "<string>",
  "visualization": {
    "name": "<string>",
    "idPattern": 123,
    "id": 123,
    "description": "<string>",
    "eventType": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "userCreated": "<string>",
    "userModified": "<string>",
    "chartConfig": "<string>",
    "chartAction": "<string>",
    "systemOwner": true,
    "chartType": "METRIC_CHART",
    "filterType": [
      {
        "operator": "IS",
        "field": "<string>",
        "value": {}
      }
    ],
    "aggregationType": {
      "metrics": [
        {
          "id": "<string>",
          "aggregation": "COUNT",
          "field": "<string>",
          "customLabel": "<string>"
        }
      ],
      "bucket": {
        "id": "<string>",
        "aggregation": "TERMS",
        "type": "AXIS",
        "field": "<string>",
        "customLabel": "<string>",
        "subBucket": "<unknown>",
        "terms": {
          "sortBy": "<string>",
          "asc": true,
          "size": 123
        },
        "dateHistogram": {
          "interval": "<string>"
        },
        "ranges": [
          {
            "from": 123,
            "to": 123
          }
        ]
      }
    },
    "pattern": {
      "pattern": "<string>",
      "id": 123,
      "patternModule": "<string>",
      "patternSystem": true,
      "active": true
    }
  },
  "dashboard": {
    "name": "<string>",
    "description": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "userCreated": "<string>",
    "id": 123,
    "refreshTime": 123,
    "modifiedDate": "2023-11-07T05:31:56Z",
    "userModified": "<string>",
    "filters": "<string>",
    "dashboardType": "CUSTOM",
    "systemOwner": true
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Utm-Internal-Key
string
header
required

Body

application/json
idVisualization
integer<int64>
required
idDashboard
integer<int64>
required
order
integer<int32>
required
width
number<float>
required
height
number<float>
required
top
number<float>
required
left
number<float>
required
id
integer<int64>
showTimeFilter
boolean
defaultTimeRange
string
gridInfo
string
visualization
object
dashboard
object

Response

200 - */*

OK

idVisualization
integer<int64>
required
idDashboard
integer<int64>
required
order
integer<int32>
required
width
number<float>
required
height
number<float>
required
top
number<float>
required
left
number<float>
required
id
integer<int64>
showTimeFilter
boolean
defaultTimeRange
string
gridInfo
string
visualization
object
dashboard
object