Struct UsageReport 

pub struct UsageReport {
    pub api_key_name: String,
    pub since: DateTime<Utc>,
    pub until: DateTime<Utc>,
    pub daily: Vec<UsageBucket>,
    pub bundle_builds: Option<BundleBuildUsage>,
    pub pricing: Option<UsagePricing>,
    /* private fields */
}

Response body of GET /usage.

since is the start of the UTC day it falls in, so it may precede the requested value.

Fields

api_key_name: String

since: DateTime<Utc>

until: DateTime<Utc>

daily: Vec<UsageBucket>

One bucket per UTC day in (since, until], ordered and gapless: an idle day is present with zero counts, and a session ending on a midnight belongs to the bucket that midnight closes. The series sums to sessions and compute; it is empty only from a server predating it.

bundle_builds: Option<BundleBuildUsage>

Present only for keys with the build_bundle feature.

pricing: Option<UsagePricing>

Implementations

impl UsageReport

pub fn new( api_key_name: String, since: DateTime<Utc>, until: DateTime<Utc>, daily: Vec<UsageBucket>, bundle_builds: Option<BundleBuildUsage>, pricing: Option<UsagePricing>, ) -> Self

Folds the totals from daily, which is the only way to set them.

pub fn sessions(&self) -> SessionCounts

The sum over daily, except on a response from a server predating it, where it is the total that server reported for the whole window.

pub fn compute(&self) -> ComputeTotals

The sum over daily, except on a response from a server predating it, where it is the total that server reported for the whole window.

Trait Implementations

impl Debug for UsageReport

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UsageReport

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for UsageReport

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.