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

Gill developer docs #801

Merged
merged 3 commits into from
Aug 26, 2024
Merged

Gill developer docs #801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
18973de
Add goal parameter description to piwiks-reporting-api.md
gillnd Aug 25, 2024
dd07baf
Add format_metrics and description to reporting-api.md
gillnd Aug 25, 2024
9f9f8a6
Add "at the visit scope level only" under Tracking a custom dimension…
gillnd Aug 26, 2024
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
1 change: 1 addition & 0 deletions docs/5.x/piwiks-reporting-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ This is the list of filters in the order in which they are applied:
- `AddColumnsProcessedMetricsGoal::GOALS_OVERVIEW` (default): adds metrics for the goals overview and not individual goals
- `AddColumnsProcessedMetricsGoal::GOALS_MINIMAL_REPORT`: add just one metric: `revenue_per_visit` (no per-goal metrics will be added)
- `AddColumnsProcessedMetricsGoal::GOALS_FULL_TABLE`: displays per-goal metrics for every goal of the site including the ecommerce goal
- `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.
7. **[Sort](/api-reference/Piwik/DataTable/Filter/Sort)**: Sorts the rows.
- `filter_sort_column`: column to sort (the filter is applied if set)
- `filter_sort_order`: `'desc'` or `'asc'`
Expand Down
6 changes: 4 additions & 2 deletions docs/5.x/reporting-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ _referrerName==Google,referrerName==Bing;country==IN_
* see [segmentation documentation](/api-reference/segmentation) for the list of available dimensions & metrics, example values for each, and more information about the custom segment parameter


* **format**; defines the format of the output
* **format**; defines the format of the output.

* xml
* json (if you want to do [cross domain request in ajax](https://bob.pythonmac.org/archives/2005/12/05/remote-json-jsonp/) and get json data, you can wrap the json data around a function call by using the **jsoncallback** parameter)
Expand All @@ -65,7 +65,9 @@ _referrerName==Google,referrerName==Bing;country==IN_
* html
* rss (when **date** is a range for example date=last10 or date=previous15)
* original; to fetch the original PHP data structure. This is useful when you call the Piwik API [internally using the PHP code](/guides/querying-the-reporting-api)


* **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.
Comment on lines +69 to +70
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


* **filter\_limit**; defines the number of rows to be returned.
* By default, only the top **100 rows** are returned.
Expand Down
2 changes: 1 addition & 1 deletion docs/5.x/tracking-javascript-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ _paq.push(['trackPageView']);

### Tracking a Custom Dimension for one specific action only

It is possible to set a Custom Dimension for one specific action only. If you want to track a Page view, you can send one or more specific Custom Dimension values along with this tracking request as follows:
It is possible to set a Custom Dimension for one specific action at the visit scope level only. If you want to track a Page view, you can send one or more specific Custom Dimension values along with this tracking request as follows:

`_paq.push(['trackPageView', pageTitle, {dimension1: 'DimensionValue'}]);`

Expand Down