quicknode-sdk 0.1.0-alpha.14

Core library for quicknode sdk
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

#[cfg(feature = "node")]
use napi_derive::napi;
#[cfg(feature = "python")]
use pyo3::pyclass;
#[cfg(feature = "python")]
use pyo3_stub_gen::derive::gen_stub_pyclass;
use serde::{Deserialize, Serialize};

/// Parameters for `get_endpoint_metrics`.
#[cfg_attr(feature = "python", gen_stub_pyclass)]
#[cfg_attr(feature = "python", pyclass(get_all, set_all))]
#[cfg_attr(feature = "node", napi(object))]
#[derive(Debug, Clone, Default, Serialize)]
pub struct GetEndpointMetricsRequest {
    /// Time period (`hour`, `day`, `week`, or `month`).
    pub period: String,
    /// Metric name (e.g. `method_calls_over_time`, `response_status_breakdown`).
    pub metric: String,
}

/// Parameters for `get_account_metrics`.
#[cfg_attr(feature = "python", gen_stub_pyclass)]
#[cfg_attr(feature = "python", pyclass(get_all, set_all))]
#[cfg_attr(feature = "node", napi(object))]
#[derive(Debug, Clone, Default, Serialize)]
pub struct GetAccountMetricsRequest {
    /// Time period (`hour`, `day`, `week`, or `month`).
    pub period: String,
    /// Metric name (e.g. `method_calls_over_time`, `credits_over_time`).
    pub metric: String,
    /// Optional percentile for latency metrics (e.g. `p50`, `p95`, `p99`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub percentile: Option<String>,
}

/// A single metric series, consisting of a descriptive tag and timestamped data points.
#[cfg_attr(feature = "python", gen_stub_pyclass)]
#[cfg_attr(feature = "python", pyclass(get_all, set_all))]
#[cfg_attr(feature = "node", napi(object))]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EndpointMetric {
    /// Data points, each as `[timestamp, value]`.
    pub data: Vec<Vec<i64>>,
    /// Human-readable tag identifying the series.
    pub tag: String,
}

/// Response from `get_endpoint_metrics`.
#[cfg_attr(feature = "python", gen_stub_pyclass)]
#[cfg_attr(feature = "python", pyclass(get_all, set_all))]
#[cfg_attr(feature = "node", napi(object))]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GetEndpointMetricsResponse {
    /// Metric series returned for the endpoint.
    #[serde(default)]
    pub data: Vec<EndpointMetric>,
    /// Error message when the request did not succeed.
    pub error: Option<String>,
}

/// Response from `get_account_metrics`.
#[cfg_attr(feature = "python", gen_stub_pyclass)]
#[cfg_attr(feature = "python", pyclass(get_all, set_all))]
#[cfg_attr(feature = "node", napi(object))]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GetAccountMetricsResponse {
    /// Metric series returned for the account.
    #[serde(default)]
    pub data: Vec<EndpointMetric>,
    /// Error message when the request did not succeed.
    pub error: Option<String>,
}