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.

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

Gill developer docs #801

Merged
merged 3 commits into from
Aug 26, 2024
Merged

Gill developer docs #801

merged 3 commits into from
Aug 26, 2024

Conversation

gillnd
Copy link
Contributor

@gillnd gillnd commented Aug 26, 2024

Description:

Gillian Douglas made 3 changes

Review

  1. Add goal parameter description to piwiks-reporting-api.md (KB-869, github Goal missing parameters #791 )
  2. Add format_metrics and description to reporting-api.md (KB-873, github Enrich the developer API reporting documentation by adding a description of the format_metrics parameter #795 )
  3. Add note on visit scope level under "Tracking a custom dimension for one specific action only" (KB-870, github Misleading documentation when it comes to custom dimension at the action level along with goals #793 )

add missing goal parameter:
`filter_show_goal_columns_process_goals`: Includes process goals using goal identifiers. Metrics are exported to additional columns for the specified goals and in the respective order listed.
add 
format_metrics; defines the output format of the metrics' values.
By appending &format_metrics=0, the metrics' values are displayed as numerical values in the output instead of the default percent rate.
… in tracking javascript guide.md

Add "at the visit scope level only" under Tracking a custom dimension for one specific action only in tracking javascript guide.md (KB-870)
Copy link
Contributor

@snake14 snake14 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good. Tested locally and everything appears to display correctly 👍

@snake14 snake14 merged commit 3d09150 into live Aug 26, 2024
@snake14 snake14 deleted the gill-developer-docs branch August 26, 2024 21:49
Comment on lines +69 to +70
* **format_metrics**; defines the output format of the metrics' values.
* By appending `&format_metrics=0`, the metrics' values are displayed as numerical values in the output instead of the default percent rate.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just for completeness: There are actually three possible values that can be provided here:

  • format_metrics=0: metrics will not be formatted at all. Percent values are returned as rates - This might be best used if the numbers should be used for further processing
  • format_metrics=1: All metrics are returned formatted (this also includes appending percent or money signs) - This might be best used if the data should be used for direct presentation
  • format_metrics=bc: In that case only percent values are formatted, while all other values aren't. This behavior is deprecated and only still exists, as the Matomo UI expects it in some places. This is also the default behavior if nothing is provided. At some point this option will be removed and format_metrics=0 will become the new default.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sgiehl Thank you. I will add this

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies @gillnd . I guess I should have waited to merge your PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@snake14 no worries at all, thanks for all your assistance. I've added sgiehl's comments in a new pull request 801

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants