Struct ApiUsageDetail

pub struct ApiUsageDetail {
    pub client_ip: String,
    pub timestamp: i64,
    pub service: String,
    pub endpoint: String,
    pub instruction: String,
    pub status: u16,
    pub response_time_ms: u64,
    pub request_count: u32,
    pub kb_used: u64,
    pub meta: String,
}

Details of a single api usage.

Fields

client_ip: String

The ip address of the client.

timestamp: i64

Timestamp of when the api is requested.

service: String

The api service requested. (e.g. solanafm_api)

endpoint: String

The endpoint requested. (e.g. /v0/accounts/:hash/transactions)

instruction: String

The instruction requested for the api. (e.g. accounts)

For sockets & webhooks, it can be the data or method subscribed to.

status: u16

The status code returned. (e.g. 200)

response_time_ms: u64

The response time in milliseconds.

request_count: u32

The number of requests made within the window period.

kb_used: u64

The accumulated data size in kb within the window period.

meta: String

Additional meta data as json string. See api_headers::AdditionalMeta for standard fields.

Trait Implementations

impl Clone for ApiUsageDetail

fn clone(&self) -> ApiUsageDetail

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiUsageDetail

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

Formats the value using the given formatter.

impl Default for ApiUsageDetail

fn default() -> ApiUsageDetail

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ApiUsageDetail

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ApiUsageDetail

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

where __S: Serializer,

Serialize this value into the given Serde serializer.