Skip to content
Snippets Groups Projects
Unverified Commit 15e18dbe authored by Bekerle, Patrizio's avatar Bekerle, Patrizio :fire:
Browse files

Add analytics-event documentation

parent b3df8164
No related branches found
No related tags found
No related merge requests found
Pipeline #16862 passed
...@@ -38,6 +38,7 @@ the version number in its `package.json` is higher than the version number on np ...@@ -38,6 +38,7 @@ the version number in its `package.json` is higher than the version number on np
| `entry-point-url` | Entry point url for all api requests | | `entry-point-url` | Entry point url for all api requests |
| `requested-login-status` | Used by the login buttons to trigger a login in auth components | | `requested-login-status` | Used by the login buttons to trigger a login in auth components |
| `initial-file-handling-state` | Used by the file-handling component to sync file source/sink at first time open | | `initial-file-handling-state` | Used by the file-handling component to sync file source/sink at first time open |
| `analytics-event` | Used to send analytics events to the Matomo component |
## Reserved events ## Reserved events
......
...@@ -23,6 +23,20 @@ npm i @dbp-toolkit/matomo ...@@ -23,6 +23,20 @@ npm i @dbp-toolkit/matomo
- example auth property: `{'login-status': 'logged-in'}` - example auth property: `{'login-status': 'logged-in'}`
- note: most often this should be an attribute that is not set directly, but subscribed at a provider - note: most often this should be an attribute that is not set directly, but subscribed at a provider
### Emitted attributes
The component emits a `dbp-set-property` event for the `analytics-event` attribute.
It looks like this:
```json
{
"category": "the category of the event",
"action": "the action of the event",
"name": "the name of the event",
"value": "the value of the event"
}
```
## Tracking actions ## Tracking actions
```html ```html
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment