Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(README): improve documentation of parameters #87

Merged
merged 1 commit into from
Mar 25, 2021
Merged

docs(README): improve documentation of parameters #87

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,16 +58,26 @@ Be aware the use of Pendo makes sense only once your visitor is identified in yo

#### Service API

There are 2 methods implemented by the Pendo adapter:
The add-on [`ember-metrics`](https://github.com/poteto/ember-metrics) includes a `metrics` Service,
which provides the methods:

- `identify([analyticsName], options)`
- `identify(analyticsName?: string | string[], analyticsOptions?: {})`

For analytics services that have identification functionality.

- `trackEvent([analyticsName], options)`
- `trackEvent(analyticsName?: string | string[], analyticsOptions?: {})`

This is a general purpose method for tracking a named event in your application.


For both methods: (see [ember-metrics#api](https://github.com/adopted-ember-addons/ember-metrics#api))

- Parameter `analyticsName` is optional and allows you to specifically target analytics Services.

- Parameter `analyticsOptions` is optional and allows you to pass a configuration to the adapter of
the targeted analytics Services.


### Activate Pendo

To activate Pendo, you should call the `identify` function provided by the `metrics` service. To do so, your app should contains the following code:
Expand Down