Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

What exactly is action_name? (Maybe) Change its documentation.

Aperta
  • Qualcosa non va?
#735 0 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
javascript
Ambito
api, documentation

Direzione di ricerca

Inizia con la documentazione citata della Tracking HTTP API e l’implementazione JavaScript di riferimento in js/piwik.js, in particolare logPageView. Confronta come viene descritto e registrato action_name per le visualizzazioni di pagina e gli eventi, quindi chiarisci il suo utilizzo previsto nella documentazione dell’API con una raccomandazione inequivocabile ed esempi.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

For context: We are currently discussing implementing a tracker solution based on the Tracking HTTP API.

The documentation lists action_name as one of the Recommended parameters. It also states that "you should provide as much information as you can" with regard to the parameters. We understand this as setting the recommended parameters as frequent as possible.

Here is the quoted description of action_name from the documentation:

action_name (recommended) — The title of the action being tracked. For page tracks this is used as page title. If enabled in your installation you may use the category tree structure in this field. For example, “game / register new user” would then create a group “game” and add the item “register new user” in it.

The second sentence of the quote makes it clear to me how to use action_name when tracking page views.

Now, I had a rather long discussion with one of my collegs on how to use action_name when not tracking a page view.
As a Recommended parameter, the documentation kind of suggests to set it in every tracking call if possible, but only gives advice on what to set it to when tracking page views.

Now, I view action_name more like a page_name and I only want to set it when tracking page views, while he wants to set it for every tracking call (to the name of the page the action happens on).

To prove my point, I did two things:

  • I reffered to the JavaScript tracking API, which only uses action_name in logPageView. (Side question: Am I correct to treat the JavaScript implementation as a "Tracker Refference Implementation"?)
  • I tracked an event using the event paramters e_c and e_a, and also set an action_name; The event was logged and I inspected the Matomo database directly, but found out that action_name for the event was recorded nowhere.

He on the other hand argued that:

  • The documentation recommends it, so we should set it.
  • Setting a parameter that might not be used doesn't hurt.

Since we could not come to an agreement on this matter, we are now asking what exactly action_name is and how/when we should use it?

Lingua principale
PHP
Stelle
58
Fork
88
Merge medio
2g 10h
PR unite (30g)
2

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di matomo-org/developer-documentation

Tutte le issue di matomo-org/developer-documentation

Issue simili

Altre issue su PHP

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.