Skip to main content

REST APIs for 23.5

VEN Dashboard APIs

The Dashboard uses the following API to aggregate various data from the system and help you focus on the data you are interested in:

POST api/v2/orgs/:xorg_id/vens/statistics

You can obtain summary statistics for VENs by specifying which statistics you are interested in from a set of options. The API also supports obtaining a count for a specific property value (such as a count of VENs from a particular version of product).

POST vens/statistics

Sample Request

{
   “property_counts”: [
	{  
	   "property": "version",
	   "values": [
              "19.3", 
              "18.3"]
	   "filters": [
		{  
		   "filter_property": "status",
		   "values": [ 
                      "active", 
                      ""
                  ]
		},
		{  
		   "filter_property": "containerized",
		   "values": [
                     "true"
                  ]
		}
	    ]
   },
   {
	  "property": "version",
	   "filters": [
		{
		"filter_property": "status",
		"values": [
                   "active"]
		}
	   ]
      },
      {
	   "property": "health"
      }  
   ]
}

Sample Response

{
	“property_counts”: [
	   {  
	      "property": "version",
	      “counts”:[
		{
		   "value": "19.1",
		   "count": 1
		},
		{
		   "value": "18.3",
		   "count": 2
		}
	   ]
	},
	{
	      "property": "version",
	      “counts”:[
		{
		   "value": "18.1",
		   "count": 1
		},
		{
		   "value": "18.2",
		   "count": 1
		},
		{
		   "value": "18.3",
		   "count": 2
		},
		{
		   "value": "19.1",
		   "count": 2
		}
	]
},
{
	   "property": "health",
	   “counts”:[
		{
		   "value": "healthy",
		   "count": 3
		},
		{
		   "value": "warning",
		   "count": 3
		},
		{
		   "value": "err",
		   "count": 2
		}
	    ]
	}  
   ]
}