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

document deleteDataSubjects API #15160

Open
Findus23 opened this issue Nov 15, 2019 · 2 comments
Open

document deleteDataSubjects API #15160

Findus23 opened this issue Nov 15, 2019 · 2 comments
Labels
c: APIs For bugs and features in the Matomo HTTP and plugin APIs. c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base. c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself.

Comments

@Findus23
Copy link
Member

There are many use cases where people want to automatically delete from Matomo (e.g. for GDPR compliance). And thanks to the GDPR tools this is possible now.
But the API documentation isn't all that helpfull:
image

While one can guess the correct usage by taking a look at the frontend (see https://forum.matomo.org/t/scheduled-delete-filters-for-gdpr-tools/34877/4?u=lukas) a proper documentation would be helpful as this is one of the most useful API endpoints.

@Findus23 Findus23 added the c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base. label Nov 15, 2019
@tsteur
Copy link
Member

tsteur commented Nov 17, 2019

BTW if someone is keen to document this in a FAQ or guide the format is

array(array('idsite' => \d, 'idvisit' => \d)). So basically a matching number of idsite and idvisit. Multiple visits can be deleted in one go.

The user needs to have admin access for each site present in the array.

@mattab mattab added this to the Priority Backlog (Help wanted) milestone Jan 21, 2020
@Findus23 Findus23 mentioned this issue May 24, 2020
@mattab mattab added c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself. c: APIs For bugs and features in the Matomo HTTP and plugin APIs. labels Dec 10, 2023
@tsteur
Copy link
Member

tsteur commented Jan 3, 2024

Steps:

  • Show the existing public API method documentation in the list of APIs (https://developer.matomo.org/api-reference/reporting-api). Many APIs actually have a description of what the API does and which parameter it accepts. This documentation should be shown (a tooltip may be good enough):
image
  • Document the public API methods that don't have any documentation yet if they accept a non-standard Matomo API parameter (a standard API parameter is documented at the top of this page, for example flat or date or idsite). This needs to be done across core and plugins.

  • Ensure any non-standard public APIs methods have documentation where needed. Fail the test if an API is there that should be documented but isn't.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: APIs For bugs and features in the Matomo HTTP and plugin APIs. c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base. c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself.
Projects
None yet
Development

No branches or pull requests

3 participants