Skip to main content

AdminReport

Struct AdminReport 

Source
pub struct AdminReport {
    pub report_type: String,
    pub data: Value,
    pub prev_data: Option<Value>,
    pub start_date: Option<String>,
    pub end_date: Option<String>,
    pub prev_start_date: Option<String>,
    pub prev_end_date: Option<String>,
    pub average: Option<f64>,
    pub higher_is_better: Option<bool>,
}
Expand description

Raw report payload, distilled from /admin/reports/{id}.json. Only the fields dsc analytics actually reads are deserialised — Discourse emits a lot more (axis labels, chart modes, descriptions) that we don’t care about.

data and prev_data are kept as raw serde_json::Value because Discourse uses two different shapes:

  1. Flat counter reports (signups, topics, posts, likes, flags, new_contributors): data: [{x: date, y: number}, ...].
  2. Stacked-chart reports (trust_level_growth): data: [{req: "tl1_reached", label: "...", data: [{x, y}, ...]}, ...].

current_total() walks both shapes and returns the right sum.

Fields§

§report_type: String§data: Value§prev_data: Option<Value>§start_date: Option<String>§end_date: Option<String>§prev_start_date: Option<String>§prev_end_date: Option<String>§average: Option<f64>

Some reports (e.g. time_to_first_response) emit an average scalar that is more meaningful than summing the daily points. Discourse occasionally emits this as false when no average is computable; we coerce that to None.

§higher_is_better: Option<bool>

Whether higher-is-better — Discourse marks this on each report, and we use it to set the default desirable direction when our spec doesn’t already pin one.

Implementations§

Source§

impl AdminReport

Source

pub fn current_total(&self) -> f64

Total for the current window.

Walks the data value and sums every y it can find. Handles both the flat counter shape ([{x, y}, ...]) and the stacked-chart shape ([{data: [{x, y}, ...]}, ...]). Coerces non-numeric y (Discourse occasionally emits false/null/string for empty cells) to 0.

Source

pub fn previous_total(&self) -> Option<f64>

Total for the previous-window, when present.

Trait Implementations§

Source§

impl Clone for AdminReport

Source§

fn clone(&self) -> AdminReport

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for AdminReport

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for AdminReport

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for AdminReport

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more