Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/epappas/tap-matomo
tap-matomo is a is a Singer tap for Matomo that can be used to pull the site visits and more.
https://github.com/epappas/tap-matomo
analytics matomo matomo-analytics meltano poetry python signer singer singer-tap site-analysis tap
Last synced: 13 days ago
JSON representation
tap-matomo is a is a Singer tap for Matomo that can be used to pull the site visits and more.
- Host: GitHub
- URL: https://github.com/epappas/tap-matomo
- Owner: epappas
- Created: 2023-09-23T10:59:55.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-18T10:21:46.000Z (about 1 year ago)
- Last Synced: 2024-04-14T19:14:22.012Z (9 months ago)
- Topics: analytics, matomo, matomo-analytics, meltano, poetry, python, signer, singer, singer-tap, site-analysis, tap
- Language: Python
- Homepage:
- Size: 609 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# tap-matomo
`tap-matomo` is a Singer tap for [Matomo](https://matomo.org/)
that can be used to pull the site visits.
Built with [Meltano Singer SDK](https://sdk.meltano.com/).
and [Singer.io Specs](https://github.com/singer-io).
## Usage
### Extract only
Run `tap-matomo` by itself using `meltano invoke`:
```bash
meltano invoke tap-matomo
```
#### Extract & Load
Run `tap-matomo` in a pipeline with a loader using `meltano elt`:
```bash
# Add target-jsonl loader
meltano add loader target-jsonl
# Create output directory
mkdir output
# Run pipeline
meltano elt tap-matomo target-jsonl
# View results
cat output/assets.jsonl
```
You should see output along the following lines:
```
{ "idSite": "", "idVisit": "", "visitIp": "", "visitorId": "", "fingerprint": "", "actionDetails": [ { "type": "action", "url": "", "pageTitle": "", "pageIdAction": "", "idpageview": "", "serverTimePretty": "", "pageId": "", "pageLoadTime": "", "timeSpent": "", "timeSpentPretty": "", "pageLoadTimeMilliseconds": "", "pageviewPosition": "", "title": "", "subtitle": "", "icon": "", "iconSVG": "", "timestamp": "" }, { "type": "event", "url": "", "pageIdAction": "", "idpageview": "", "serverTimePretty": "", "pageId": "", "eventCategory": "", "eventAction": "", "pageviewPosition": "", "timestamp": "", "icon": "", "iconSVG": "", "title": "", "subtitle": "", "eventName": "", "eventValue": "" } ], "goalConversions": "", "siteCurrency": "", "siteCurrencySymbol": "", "serverDate": "", "visitServerHour": "", "lastActionTimestamp": "", "lastActionDateTime": "", "siteName": "", "serverTimestamp": "", "firstActionTimestamp": "", "serverTimePretty": "", "serverDatePretty": "", "serverDatePrettyFirstAction": "", "serverTimePrettyFirstAction": "", "userId": "", "visitorType": "", "visitorTypeIcon": "", "visitConverted": "", "visitConvertedIcon": "", "visitCount": "", "visitEcommerceStatus": "", "visitEcommerceStatusIcon": "", "daysSinceFirstVisit": "", "secondsSinceFirstVisit": "", "daysSinceLastEcommerceOrder": "", "secondsSinceLastEcommerceOrder": "", "visitDuration": "", "visitDurationPretty": "", "searches": "", "actions": "", "interactions": "", "referrerType": "", "referrerTypeName": "", "referrerName": "", "referrerKeyword": "", "referrerKeywordPosition": "", "referrerUrl": "", "referrerSearchEngineUrl": "", "referrerSearchEngineIcon": "", "referrerSocialNetworkUrl": "", "referrerSocialNetworkIcon": "", "languageCode": "", "language": "", "deviceType": "", "deviceTypeIcon": "", "deviceBrand": "", "deviceModel": "", "operatingSystem": "", "operatingSystemName": "", "operatingSystemIcon": "", "operatingSystemCode": "", "operatingSystemVersion": "", "browserFamily": "", "browserFamilyDescription": "", "browser": "", "browserName": "", "browserIcon": "", "browserCode": "", "browserVersion": "", "events": "", "continent": "", "continentCode": "", "country": "", "countryCode": "", "countryFlag": "", "region": "", "regionCode": "", "city": "", "location": "", "latitude": "", "longitude": "", "visitLocalTime": "", "visitLocalHour": "", "daysSinceLastVisit": "", "secondsSinceLastVisit": "", "resolution": "", "plugins": "", "pluginsIcons": [ { "pluginIcon": "", "pluginName": "" } ], "experiments": [], "adClickId": "", "adProviderId": "", "adProviderName": "", "formConversions": "", "sessionReplayUrl": "", "campaignId": "", "campaignContent": "", "campaignKeyword": "", "campaignMedium": "", "campaignName": "", "campaignSource": "", "campaignGroup": "", "campaignPlacement": "" }
```
## Stand-alone usage
### Installation
```bash
pip install git+https://github.com/epappas/tap-matomo.git
```
### Configuration
Create a `config.json` file with content along the following lines:
```json
{
"api": {
"base_url": "https://example.com/",
"module": "API",
"method": "Live.getLastVisitsDetails",
"idSite": "25",
"period": "day",
"date": "yesterday",
"format": "JSON",
"token_auth": "..changeme..",
"filter_limit": 10000
}
}
```
### Usage
Run `tap-matomo` with the `config.json` file created above:
```bash
tap-matomo --config config.json
```