matomo-rs 0.1.0

Async client for the Matomo Reporting API, focused on data export and migration
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

//! [`Endpoint`] impls for each typed Matomo call. These build a [`Params`] bag
//! and name a `Module.action`; the blanket [`crate::Query`] turns them into a
//! request. They carry no transport.

use serde_json::Value;

use crate::models::{
    ActionPage, Download, Outlink, ReferrerAll, ReferrerType, Visit, VisitsSummary,
};
use crate::params::{IdSite, Period, Segment};
use crate::request::Params;
use crate::transport::Endpoint;

fn base(id_site: IdSite, period: Period, segment: Option<Segment>) -> Params {
    let mut params = Params::new().id_site(id_site).period(period);
    if let Some(s) = segment {
        params = params.segment(s);
    }
    params
}

pub struct VisitsSummaryGet {
    pub id_site: IdSite,
    pub period: Period,
    pub segment: Option<Segment>,
}

impl Endpoint for VisitsSummaryGet {
    type Response = VisitsSummary;
    fn method(&self) -> &'static str {
        "VisitsSummary.get"
    }
    fn params(&self) -> Params {
        base(self.id_site.clone(), self.period, self.segment.clone())
    }
}

/// `Live.getLastVisitsDetails` for a single page; params are supplied verbatim.
pub struct LiveGetLastVisitsDetails {
    pub params: Params,
}

impl Endpoint for LiveGetLastVisitsDetails {
    type Response = Vec<Visit>;
    fn method(&self) -> &'static str {
        "Live.getLastVisitsDetails"
    }
    fn params(&self) -> Params {
        self.params.clone()
    }
}

macro_rules! actions_endpoint {
    ($name:ident, $method:literal, $resp:ty) => {
        pub struct $name {
            pub id_site: IdSite,
            pub period: Period,
            pub segment: Option<Segment>,
        }
        impl Endpoint for $name {
            type Response = $resp;
            fn method(&self) -> &'static str {
                $method
            }
            fn params(&self) -> Params {
                base(self.id_site.clone(), self.period, self.segment.clone())
            }
        }
    };
}

actions_endpoint!(ActionsGetPageUrls, "Actions.getPageUrls", Vec<ActionPage>);
actions_endpoint!(
    ActionsGetPageTitles,
    "Actions.getPageTitles",
    Vec<ActionPage>
);
actions_endpoint!(ActionsGetDownloads, "Actions.getDownloads", Vec<Download>);
actions_endpoint!(ActionsGetOutlinks, "Actions.getOutlinks", Vec<Outlink>);
actions_endpoint!(
    ReferrersGetReferrerType,
    "Referrers.getReferrerType",
    Vec<ReferrerType>
);
actions_endpoint!(ReferrersGetAll, "Referrers.getAll", Vec<ReferrerAll>);

pub struct ApiGetMatomoVersion;

impl Endpoint for ApiGetMatomoVersion {
    type Response = Value;
    fn method(&self) -> &'static str {
        "API.getMatomoVersion"
    }
    fn params(&self) -> Params {
        Params::new()
    }
}

pub struct ApiGetReportMetadata {
    pub params: Params,
}

impl Endpoint for ApiGetReportMetadata {
    type Response = Value;
    fn method(&self) -> &'static str {
        "API.getReportMetadata"
    }
    fn params(&self) -> Params {
        self.params.clone()
    }
}

pub struct ApiGetBulkRequest {
    pub params: Params,
}

impl Endpoint for ApiGetBulkRequest {
    type Response = Value;
    fn method(&self) -> &'static str {
        "API.getBulkRequest"
    }
    fn params(&self) -> Params {
        self.params.clone()
    }
}