Server Stats

From INAP Dropzone API
(Difference between revisions)
Jump to: navigation, search
(Optional Data Parameters)
(Optional Data Parameters)
Line 17: Line 17:
  
 
==Optional Data Parameters==
 
==Optional Data Parameters==
*{$aggregatePeriod}: The amount of time in seconds to use to "smooth" the returned data. Defaults to 600 (10 minutes) which is about how often stats are stored to the database and as such is the smallest time period available. Higher aggregatePeriod values will return less data points compared to the amount stored and the data points will contained averaged and cumulative values (depending on the nature of the stat) from the raw data it contains. Each returned data point has a 'ticks' field that contains the number of raw data points used to create the data.
+
*{$aggregatePeriod}: The amount of time in seconds to use to "smooth" the returned data. Defaults to 600 (10 minutes) which is about how often stats are stored to the database and as such is the smallest time period available. Higher aggregatePeriod values will return less data points compared to the amount stored and the data points will contained averaged and cumulative values (depending on the nature of each stat) from the raw data it contains. Each returned data point has a 'ticks' field that contains the number of raw data points used to create the data.
 
*{$end}: A unix timestamp of the end of the time period from which you want stats. Defaults to PHP's time(). If this is less than the {$start} time you will be returned an error.
 
*{$end}: A unix timestamp of the end of the time period from which you want stats. Defaults to PHP's time(). If this is less than the {$start} time you will be returned an error.
 
*{$start}: A  unix timestamp of the start of the time period from which you want stats. Defaults to {$end} - 3600 (one hour before the {$end} value).
 
*{$start}: A  unix timestamp of the start of the time period from which you want stats. Defaults to {$end} - 3600 (one hour before the {$end} value).

Revision as of 20:29, 9 April 2013

The server stats command returns performance stats for a server over a given time period.

Contents

Path

  • /server/stats/{$start}/{$end}/{$aggregatePeriod}/{$serverid}
  • /server/stats/{$start}/{$end}/{$serverid}
  • /server/stats/{$start}/{$serverid}
  • /server/stats/{$serverid}

Method

Availability

Required Data Parameters

  • {$serverid}: The server ID that is returned when using the list command.

Optional Data Parameters

  • {$aggregatePeriod}: The amount of time in seconds to use to "smooth" the returned data. Defaults to 600 (10 minutes) which is about how often stats are stored to the database and as such is the smallest time period available. Higher aggregatePeriod values will return less data points compared to the amount stored and the data points will contained averaged and cumulative values (depending on the nature of each stat) from the raw data it contains. Each returned data point has a 'ticks' field that contains the number of raw data points used to create the data.
  • {$end}: A unix timestamp of the end of the time period from which you want stats. Defaults to PHP's time(). If this is less than the {$start} time you will be returned an error.
  • {$start}: A unix timestamp of the start of the time period from which you want stats. Defaults to {$end} - 3600 (one hour before the {$end} value).

Returned Data


Personal tools