1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
* @category Piwik_Plugins
* @package Piwik_API
*/
/**
*
* @package Piwik_API
*/
class Piwik_API_Controller extends Piwik_Controller
{
function index()
{
// when calling the API through http, we limit the number of returned results
if(!isset($_GET['filter_limit']))
{
$_GET['filter_limit'] = Piwik_Config::getInstance()->General['API_datatable_default_limit'];
}
$request = new Piwik_API_Request('token_auth='.Piwik_Common::getRequestVar('token_auth', 'anonymous', 'string'));
echo $request->process();
}
public function listAllMethods()
{
$ApiDocumentation = new Piwik_API_DocumentationGenerator();
echo $ApiDocumentation->getAllInterfaceString( $outputExampleUrls = true, $prefixUrls = Piwik_Common::getRequestVar('prefixUrl', '') );
}
public function listAllAPI()
{
$view = Piwik_View::factory("listAllAPI");
$this->setGeneralVariablesView($view);
$ApiDocumentation = new Piwik_API_DocumentationGenerator();
$view->countLoadedAPI = Piwik_API_Proxy::getInstance()->getCountRegisteredClasses();
$view->list_api_methods_with_links = $ApiDocumentation->getAllInterfaceString();
echo $view->render();
}
public function listSegments()
{
$segments = Piwik_API_API::getInstance()->getSegmentsMetadata($this->idSite);
$tableDimensions = $tableMetrics = '';
$customVariables=0;
$lastCategory=array();
foreach($segments as $segment)
{
$onlyDisplay = array('customVariableName1', 'customVariableName2', 'customVariableValue1', 'customVariableValue2', 'customVariablePageName1', 'customVariablePageValue1');
$customVariableWillBeDisplayed = in_array($segment['segment'], $onlyDisplay);
// Don't display more than 4 custom variables name/value rows
if($segment['category'] == 'Custom Variables'
&& !$customVariableWillBeDisplayed)
{
continue;
}
$thisCategory = $segment['category'];
$output = '';
if(empty($lastCategory[$segment['type']])
|| $lastCategory[$segment['type']] != $thisCategory)
{
$output .= '<tr><td class="segmentCategory" colspan="2"><b>'.$thisCategory.'</b></td></tr>';
}
$lastCategory[$segment['type']] = $thisCategory;
$exampleValues = isset($segment['acceptedValues'])
? 'Example values: <code>'.$segment['acceptedValues'].'</code>'
: '';
$restrictedToAdmin = isset($segment['permission']) ? '<br/>Note: This segment can only be used by an Admin user' : '';
$output .= '<tr>
<td class="segmentString">'.$segment['segment'].'</td>
<td class="segmentName">'.$segment['name'] .$restrictedToAdmin.'<br/>'.$exampleValues.' </td>
</tr>';
// Show only 2 custom variables and display message for rest
if($customVariableWillBeDisplayed)
{
$customVariables++;
if($customVariables == count($onlyDisplay))
{
$output .= '<tr><td colspan="2"> There are 5 custom variables available, so you can segment across any segment name and value range.
<br/>For example, <code>customVariableName1==Type;customVariableValue1==Customer</code>
<br/>Returns all visitors that have the Custom Variable "Type" set to "Customer".
<br/>Custom Variables of scope "page" can be queried separately. For example, to query the Custom Variable of scope "page",
<br/>stored in index 1, you would use the segment <code>customVariablePageName1==ArticleLanguage;customVariablePageValue1==FR</code>
</td></tr>';
}
}
if($segment['type'] == 'dimension') {
$tableDimensions .= $output;
} else {
$tableMetrics .= $output;
}
}
echo "
<b>Dimensions</b>
<table>
$tableDimensions
</table>
<br/>
<b>Metrics</b>
<table>
$tableMetrics
</table>
";
}
}
|
