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

Standardise actions of last visitor API output #12284

Open
tsteur opened this Issue Nov 19, 2017 · 4 comments

Comments

Projects
None yet
2 participants
@tsteur
Member

tsteur commented Nov 19, 2017

because of action entry { "type": 95, "formName": "rechnerform", "formId": "6", "converted": "0", "submitted": 0, "serverTimePretty": "18.11.2017 20:27:14", "fields": [], "timestamp": 1511036834 },

it looks like

image

where you can only see 95 for a form interaction.

I reckon we will need to think about some way to standardide the output of actions maybe, so apps like Piwik Mobile can be written to process this API output. For example we already have always icon, next would be like a title, and a subtitle or so maybe? For a page view that would be the Page Title and the URL as subtitle.

The same logic should be then also used in the Piwik app to show the visitor log but that may actually not work because we want to have some links clickable, for example the form name which we would not be able to make clickable on the mobile app (at least it won't be trivial at all). Any thoughts?

Hiding unneeded output vs new API

Just thinking about the mobile app and that it would add quite a bit of data to send even more properties, and at the same time have lots of properties that are not needed. So maybe there would be an option to hide all action specific properties like pageIdAction or formId or formName to make the app much faster. Or maybe that would be a totally different API that only returns those standard fields? => If it is a new API then backwards compatibility will be a huge problem because not all users will have a new version of Piwik installed. But this I would need to somehow workaround anyway as I will either way need two different kind of views, one for old API format, and one for new API format (which shouldn't be too bad)

@tsteur tsteur added the c: Platform label Nov 19, 2017

@mattab

This comment has been minimized.

Show comment
Hide comment
@mattab

mattab Nov 24, 2017

Member

It sounds good (and is needed for the future it seems) to standardise the output in some way. icon, title and subtitle are the main attributes, agreed. There would probably be a datetime and couple others too. For the rest of attributes (ids, times, dates, maybe even whether something is clickable) we could maybe put them in a metadata or so.

Ideally we keep things simple and not introduce a new API. And we need to keep BC ideally. So not sure if it's easily do-able. Introducing new API name may work if we don't have a choice.

Member

mattab commented Nov 24, 2017

It sounds good (and is needed for the future it seems) to standardise the output in some way. icon, title and subtitle are the main attributes, agreed. There would probably be a datetime and couple others too. For the rest of attributes (ids, times, dates, maybe even whether something is clickable) we could maybe put them in a metadata or so.

Ideally we keep things simple and not introduce a new API. And we need to keep BC ideally. So not sure if it's easily do-able. Introducing new API name may work if we don't have a choice.

@tsteur

This comment has been minimized.

Show comment
Hide comment
@tsteur

tsteur Dec 21, 2017

Member

Any chance we could work on this as part of Piwik 3.3 or so? We got a couple of users mentioning this issue whether it is for content tracking, media, forms, ... @mattab

Member

tsteur commented Dec 21, 2017

Any chance we could work on this as part of Piwik 3.3 or so? We got a couple of users mentioning this issue whether it is for content tracking, media, forms, ... @mattab

@tsteur

This comment has been minimized.

Show comment
Hide comment
@tsteur

tsteur Dec 21, 2017

Member

I could likely integrate this into piwik mobile app then in the next release

Member

tsteur commented Dec 21, 2017

I could likely integrate this into piwik mobile app then in the next release

@mattab mattab added this to the 3.3.0 milestone Dec 21, 2017

@tsteur

This comment has been minimized.

Show comment
Hide comment
@tsteur

tsteur Dec 22, 2017

Member

FYI: Was just about to add support for this to the mobile app and I think all we need for now be like

title, icon, url

for each action where possible. Optionally also subtitle could be good to have and this subtitle could hold additional useful information.

serverTimePretty is supported by the mobile app as well and could be used to print date when it happened. Not all actions may support this.

Member

tsteur commented Dec 22, 2017

FYI: Was just about to add support for this to the mobile app and I think all we need for now be like

title, icon, url

for each action where possible. Optionally also subtitle could be good to have and this subtitle could hold additional useful information.

serverTimePretty is supported by the mobile app as well and could be used to print date when it happened. Not all actions may support this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment