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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.environments.html">environments</a> . <a href="apigee_v1.organizations.environments.securityStats.html">securityStats</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#queryTabularStats">queryTabularStats(orgenv, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieve security statistics as tabular rows.</p>
<p class="toc_element">
<code><a href="#queryTabularStats_next">queryTabularStats_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#queryTimeSeriesStats">queryTimeSeriesStats(orgenv, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieve security statistics as a collection of time series.</p>
<p class="toc_element">
<code><a href="#queryTimeSeriesStats_next">queryTimeSeriesStats_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="queryTabularStats">queryTabularStats(orgenv, body=None, x__xgafv=None)</code>
<pre>Retrieve security statistics as tabular rows.
Args:
orgenv: string, Required. Should be of the form organizations//environments/. (required)
body: object, The request body.
The object takes the form of:
{ # Request payload representing the query to be run for fetching security statistics as rows.
"dimensions": [ # Required. List of dimension names to group the aggregations by.
"A String",
],
"filter": "A String", # Filter further on specific dimension values. Follows the same grammar as custom report's filter expressions. Example, apiproxy eq 'foobar'. https://cloud.google.com/apigee/docs/api-platform/analytics/analytics-reference#filters
"metrics": [ # Required. List of metrics and their aggregations.
{ # The optionally aggregated metric to query with its ordering.
"aggregation": "A String", # Aggregation function associated with the metric.
"name": "A String", # Name of the metric
"order": "A String", # Ordering for this aggregation in the result. For time series this is ignored since the ordering of points depends only on the timestamp, not the values.
},
],
"pageSize": 42, # Page size represents the number of rows.
"pageToken": "A String", # Identifies a sequence of rows.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Time range for the stats.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Encapsulates two kinds of stats that are results of the dimensions and aggregations requested. - Tabular rows. - Time series data. Example of tabular rows, Represents security stats results as a row of flat values.
"columns": [ # Column names corresponding to the same order as the inner values in the stats field.
"A String",
],
"nextPageToken": "A String", # Next page token.
"values": [ # Resultant rows from the executed query.
[
"",
],
],
}</pre>
</div>
<div class="method">
<code class="details" id="queryTabularStats_next">queryTabularStats_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="queryTimeSeriesStats">queryTimeSeriesStats(orgenv, body=None, x__xgafv=None)</code>
<pre>Retrieve security statistics as a collection of time series.
Args:
orgenv: string, Required. Should be of the form organizations//environments/. (required)
body: object, The request body.
The object takes the form of:
{ # QueryTimeSeriesStatsRequest represents a query that returns a collection of time series sequences grouped by their values.
"dimensions": [ # List of dimension names to group the aggregations by. If no dimensions are passed, a single trend line representing the requested metric aggregations grouped by environment is returned.
"A String",
],
"filter": "A String", # Filter further on specific dimension values. Follows the same grammar as custom report's filter expressions. Example, apiproxy eq 'foobar'. https://cloud.google.com/apigee/docs/api-platform/analytics/analytics-reference#filters
"metrics": [ # Required. List of metrics and their aggregations.
{ # The optionally aggregated metric to query with its ordering.
"aggregation": "A String", # Aggregation function associated with the metric.
"name": "A String", # Name of the metric
"order": "A String", # Ordering for this aggregation in the result. For time series this is ignored since the ordering of points depends only on the timestamp, not the values.
},
],
"pageSize": 42, # Page size represents the number of time series sequences, one per unique set of dimensions and their values.
"pageToken": "A String", # Page token stands for a specific collection of time series sequences.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Required. Time range for the stats.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timestampOrder": "A String", # Order the sequences in increasing or decreasing order of timestamps. Default is descending order of timestamps (latest first).
"windowSize": "A String", # Time buckets to group the stats by.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents security stats result as a collection of time series sequences.
"columns": [ # Column names corresponding to the same order as the inner values in the stats field.
"A String",
],
"nextPageToken": "A String", # Next page token.
"values": [ # Results of the query returned as a JSON array.
{ # A sequence of time series.
"dimensions": { # Map of dimensions and their values that uniquely identifies a time series sequence.
"a_key": "A String",
},
"points": [ # List of points. First value of each inner list is a timestamp.
[
"",
],
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="queryTimeSeriesStats_next">queryTimeSeriesStats_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
