Groups endpoint tips

GroupBy field criteria

When using the POST requests to query actions and action statistics, you can use the groupBy parameter to organize the results. The valid values for this parameter differ by entity type:

{
  "VirtualMachine":{
    "criteria":[
      {
        "filterType":"vmsByName"
      },
      {
        "filterType":"vmsByPMName"
      },
      {
        "filterType":"vmsByStorage"
      },
      {
        "filterType":"vmsByNetwork"
      },
      {
        "filterType":"vmsByApplication"
      },
      {
        "filterType":"vmsByDatabaseServer"
      },
      {
        "filterType":"vmsByDatabaseServerVersion"
      },
      {
        "filterType":"vmsByDC"
      },
      {
        "filterType":"vmsByVDC"
      },
      {
        "filterType":"vmsByDCnested"
      },
      {
        "filterType":"vmsByNumCPUs"
      },
      {
        "filterType":"vmsByMem"
      },
      {
        "filterType":"vmsByGuestName"
      },
      {
        "filterType":"vmsByAltName"
      },
      {
        "filterType":"vmsByClusterName"
      },
      {
        "filterType":"vmsByDiskArrayName"
      },
      {
        "filterType":"vmsByLogicalPoolName"
      },
      {
        "filterType":"vmsByProfileName"
      },
      {
        "filterType":"vmsByTag"
      },
      {
        "filterType":"vmsByState"
      },
      {
        "filterType":"vmsByBusinessAccountUuid"
      },
      {
        "filterType":"vmsByResourceGroupUuid"
      }
    ]
  },
  "VirtualDataCenter":{
    "criteria":[
      {
        "filterType":"vdcsByName"
      },
      {
        "filterType":"vdcsByVDCName"
      },
      {
        "filterType":"vdcsByTag"
      },
      {
        "filterType":"vdcsByState"
      }
    ]
  },
  "PhysicalMachine":{
    "criteria":[
      {
        "filterType":"pmsByName"
      },
      {
        "filterType":"pmsByStorage"
      },
      {
        "filterType":"pmsByNetwork"
      },
      {
        "filterType":"pmsBySwitch"
      },
      {
        "filterType":"pmsByNumVms"
      },
      {
        "filterType":"pmsByDC"
      },
      {
        "filterType":"pmsByMem"
      },
      {
        "filterType":"pmsByNumCPUs"
      },
      {
        "filterType":"pmsByVendorName"
      },
      {
        "filterType":"pmsByCPUModel"
      },
      {
        "filterType":"pmsByModel"
      },
      {
        "filterType":"pmsByTimezone"
      },
      {
        "filterType":"pmsByClusterName"
      },
      {
        "filterType":"pmsByTag"
      },
      {
        "filterType":"pmsByState"
      }
    ]
  },
  "Storage":{
    "criteria":[
      {
        "filterType":"storageByName"
      },
      {
        "filterType":"storageByTag"
      },
      {
        "filterType":"storageByVMs"
      },
      {
        "filterType":"storageByDC"
      },
      {
        "filterType":"storageByPMCluster"
      },
      {
        "filterType":"storageByState"
      }
    ]
  },
  "Application":{
    "criteria":[
      {
        "filterType":"appsByName"
      },
      {
        "filterType":"appsByTag"
      }
    ]
  },
  "ApplicationComponent":{
    "criteria":[
      {
        "filterType":"appSrvsByName"
      }
    ]
  },
  "WebServer":{
    "criteria":[
      {
        "filterType":"wbSrvsByName"
      }
    ]
  },
  "BusinessApplication":{
    "criteria":[
      {
        "filterType":"busAppsByName"
      }
    ]
  },
  "Database":{
    "criteria":[
      {
        "filterType":"databaseByName"
      },
      {
        "filterType":"databaseByTag"
      },
      {
        "filterType":"databaseByBusinessAccountUuid"
      },
      {
        "filterType":"databaseByResourceGroupUuid"
      }
    ]
  },
  "DatabaseServer":{
    "criteria":[
      {
        "filterType":"databaseServerByName"
      },
      {
        "filterType":"databaseServerByTag"
      },
      {
        "filterType":"databaseServerByBusinessAccountUuid"
      },
      {
        "filterType":"databaseServerByEngine"
      },
      {
        "filterType":"databaseServerByEdition"
      },
      {
        "filterType":"databaseServerByVersion"
      }
    ]
  },
  "VirtualApplication":{
    "criteria":[
      {
        "filterType":"vappsByName"
      }
    ]
  },
  "Cluster":{
    "criteria":[
      {
        "filterType":"clustersByName"
      },
      {
        "filterType":"clustersByTag"
      }
    ]
  },
  "DataCenter":{
    "criteria":[
      {
        "filterType":"datacentersByName"
      },
      {
        "filterType":"datacentersByTag"
      }
    ]
  },
  "Group":{
    "criteria":[
      {
        "filterType":"groupsByName"
      },
      {
        "filterType":"groupsByTargetName"
      }
    ]
  },
  "StorageCluster":{
    "criteria":[
      {
        "filterType":"storageClustersByName"
      }
    ]
  },
  "DiskArray":{
    "criteria":[
      {
        "filterType":"diskarrayByName"
      }
    ]
  },
  "Zone":{
    "criteria":[
      {
        "filterType":"zonsByName"
      }
    ]
  },
  "Region":{
    "criteria":[
      {
        "filterType":"regsByName"
      }
    ]
  },
  "Network":{
    "criteria":[
      {
        "filterType":"netsByName"
      }
    ]
  },
  "LoadBalancer":{
    "criteria":[
      {
        "filterType":"lbsByName"
      }
    ]
  },
  "Chassis":{
    "criteria":[
      {
        "filterType":"chasByName"
      }
    ]
  },
  "IOModule":{
    "criteria":[
      {
        "filterType":"ioModuleByName"
      }
    ]
  },
  "StorageController":{
    "criteria":[
      {
        "filterType":"storagecontrollerByName"
      }
    ]
  },
  "DPod":{
    "criteria":[
      {
        "filterType":"dpodByName"
      }
    ]
  },
  "VPod":{
    "criteria":[
      {
        "filterType":"vpodByName"
      }
    ]
  },
  "LogicalPool":{
    "criteria":[
      {
        "filterType":"logicalPoolByName"
      }
    ]
  },
  "Switch":{
    "criteria":[
      {
        "filterType":"switchByName"
      }
    ]
  },
  "Container":{
    "criteria":[
      {
        "filterType":"containersByName"
      },
      {
        "filterType":"containersByVMName"
      }
    ]
  },
  "ContainerPod":{
    "criteria":[
      {
        "filterType":"containerpodsByName"
      },
      {
        "filterType":"containerpodsByVMName"
      }
    ]
  },
  "ServiceEntity":{
    "criteria":[
      {
        "filterType":"workloadByBusinessAccountUuid"
      },
      {
        "filterType":"workloadByResourceGroupUuid"
      }
    ]
  },
  "Workload":{
    "criteria":[
      {
        "filterType":"workloadByBusinessAccountUuid"
      },
      {
        "filterType":"workloadByResourceGroupUuid"
      }
    ]
  },
  "ResourceGroup":{
    "criteria":[
      {
        "filterType":"resourceGroupByName"
      },
      {
        "filterType":"resourceGroupByUuid"
      },
      {
        "filterType":"resourceGroupByBusinessAccountUuid"
      },
      {
        "filterType":"resourceGroupByTag"
      }
    ]
  },
  "BusinessAccount":{
    "criteria":[
      {
        "filterType":"businessAccountByName"
      },
      {
        "filterType":"businessAccountByUuid"
      },
      {
        "filterType":"subBusinessAccountOfUuid"
      },
      {
        "filterType":"businessAccountValidationStatus"
      },
      {
        "filterType":"businessAccountTargetName"
      },
      {
        "filterType":"businessAccountCloudProvider"
      }
    ]
  },
  "BillingFamily":{
    "criteria":[
      {
        "filterType":"billingFamilyByName"
      }
    ]
  },
  "ViewPod":{
    "criteria":[
      {
        "filterType":"viewPodByName"
      }
    ]
  },
  "DesktopPool":{
    "criteria":[
      {
        "filterType":"desktopPoolByName"
      },
      {
        "filterType":"desktopPoolByViewPod"
      }
    ]
  },
  "BusinessUser":{
    "criteria":[
      {
        "filterType":"businessUserByName"
      },
      {
        "filterType":"businessUserByDesktopPool"
      }
    ]
  }
}