Skip to content

Latest commit

 

History

History
38 lines (32 loc) · 1.5 KB

metrics-container.md

File metadata and controls

38 lines (32 loc) · 1.5 KB

Container class for Metrics:

The SoftLayer_Container_Network_CdnMarketplace_Metrics collection contains the attributes used by our Metrics APIs. There are three possible values for the type attribute: PIECHART, LINEGRAPH, or TOTALS. The output for the rest of the attributes in this container depend on the type, which is described in further detail below. All attributes except type are arrays. Not all attributes are used for all types.

class SoftLayer_Container_Network_CdnMarketplace_Metrics:

  • type
  • names
  • totals
  • percentage
  • time
  • xaxis
  • yaxis
  • yaxis2
  • yaxis3
  • yaxis4
  • yaxis5
  • yaxis6
  • yaxis7
  • yaxis8
  • yaxis9
  • yaxis10
  • yaxis11
  • yaxis12
  • yaxis13
  • yaxis14
  • yaxis15
  • yaxis16
  • yaxis17
  • yaxis18
  • yaxis19
  • yaxis20

The PIECHART type is for data that will be sent to a pie chart. In this case, the only attributes used are: names, xaxis, and yaxis. The names attribute is an array containing the region names. The xaxis attribute contains the usage in GB, and yaxis1 is the test percentage.

The LINEGRAPH type is for data that will be sent to a line graph. In this case, the names array will contain the names of the metrics that are found in the xaxis, yaxis, yaxis2...yaxis20 attributes, and the actual data will be in the corresponding arrays.

If type is TOTALS, the names array will contain the names of the metrics found in the corresponding totals array, and the actual data is contained in the totals array.