Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

API.getMetaData includes unique visitors in year period #1598

Closed
gka opened this Issue · 7 comments

3 participants

Gregor Aisch Anthon Pang Matthieu Aubry
Gregor Aisch
Collaborator

The API call

?module=API&method=API.getMetadata&format=XML&apiModule=UserCountry&apiAction=getCountry&period=year

includes the metric "unique visitors" which is not included in the corresponding getProcessedReport call

?module=API&method=API.getProcessedReport&format=XML&apiModule=UserCountry&apiAction=getCountry&period=year
Keywords: metadata,api

Gregor Aisch
Collaborator

I'm not quite sure about the expected behaviour. Maybe the bug is not that API.getMetaData includes the unique visitor metric, but that API.getProcessedReport does not include it. However, I think both functions should return the same metrics.

The bug appears only in time periods other than day. I found this bug because the new map plugin calls API.getMetaData to build the HTML Select and the flash map calls API.getProcessedReport to load the data. If you change the time to anything but day, you'll find the metric "unique visitors" in the Select but the map does not display it, because it is missing in the getProcessedReport result.

Hope the bug is clearer now. I'll try to locate the bug in the API plugin.

Gregor Aisch
Collaborator

I found the code which removes the unique visitors from the processed metrics in line 308 and 309 in plugins/API/API.php.

if($period != 'day')
{
    unset($columns['nb_uniq_visitors']);
    unset($reportMetadata['metrics']['nb_uniq_visitors']);
}

It looks like the API.getMetaData results are independent of the selected time period and thus always include the unique visitor metrics. Since I don't want to touch the code I'll rather add a workaround to the map plugin which removes the unique visitors manually.

Gregor Aisch
Collaborator

You may change the ticket priority to minor and move it to a later milestone.

Anthon Pang
Collaborator

matt: why is it unsetting for period != 'day'? Shouldn't this be period != 'year' given #842 r1301?

Matthieu Aubry
Owner

oops, my mistake, it should be period == year. Thanks for investigating greg & vipsoft

Matthieu Aubry
Owner

(In [3329]) Fixes #1598
Unique Visitors now out of the API resultset, the UI, and the Api metadata response, when period=year. Adding API metadata test for period=year.

Matthieu Aubry
Owner

(In [3330]) Refs #1598
Fixing notice in sparkline widgets

Gregor Aisch gka added this to the Piwik 1.1 milestone
Matthieu Aubry mattab was assigned by gka
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.