search

matomo-org / tag-manager

Free Open Source Matomo Tag Manager - A simple way to manage and maintain all of your (third-party) tags on your website.
https://matomo.org
GNU General Public License v3.0
177 stars 58 forks source link

Improve Tag Manager API documentation #596

Open Starker3 opened 1 year ago

Starker3 commented 1 year ago

We got the following feedback from a user:

Additionally, the API documentation for some of these end-points is very limited. It will be helpful if in a subsequent Matomo release we are able to enhance the documentation.

This feedback is specific to the Tag Manager API documentation - they would like more examples for all the different methods. They also would like clarification on what some of the methods do. Eg. they were importing a container using an API call, but couldn't understand why that newly imported container wasn't working until we explained that they needed to create a new version and publish it to an environment.

snake14 commented 1 year ago

Sounds like a good enhancement ticket. I'm marking this issue for prioritisation.

Chardonneaur commented 1 year ago

@Starker3 @snake14 . There is already a simple enhancement which could make great improvements already. Under Platform --> API, there are very few examples for the Matomo Tag Manager API. I guess by using ChatGPT we could easily get all those examples up and running and it will already give a good boost to the documentation.

Starker3 commented 1 year ago

@Chardonneaur In the case of the API examples it's not as simple as just adding to the documentation. The examples shown in the developer docs and in the Platform -> API section in the UI are generated using reflection to automatically generate that list and the examples.