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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
|
<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.reports.html">reports</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="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a Custom Report for an Organization. A Custom Report provides Apigee Customers to create custom dashboards in addition to the standard dashboards which are provided. The Custom Report in its simplest form contains specifications about metrics, dimensions and filters. It is important to note that the custom report by itself does not provide an executable entity. The Edge UI converts the custom report definition into an analytics query and displays the result in a chart.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an existing custom report definition</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieve a custom report definition.</p>
<p class="toc_element">
<code><a href="#list">list(parent, expand=None, x__xgafv=None)</a></code></p>
<p class="firstline">Return a list of Custom Reports</p>
<p class="toc_element">
<code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update an existing custom report definition</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="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a Custom Report for an Organization. A Custom Report provides Apigee Customers to create custom dashboards in addition to the standard dashboards which are provided. The Custom Report in its simplest form contains specifications about metrics, dimensions and filters. It is important to note that the custom report by itself does not provide an executable entity. The Edge UI converts the custom report definition into an analytics query and displays the result in a chart.
Args:
parent: string, Required. The parent organization name under which the Custom Report will be created. Must be of the form: `organizations/{organization_id}/reports` (required)
body: object, The request body.
The object takes the form of:
{
"chartType": "A String", # This field contains the chart type for the report
"comments": [ # Legacy field: not used. This field contains a list of comments associated with custom report
"A String",
],
"createdAt": "A String", # Output only. Unix time when the app was created json key: createdAt
"dimensions": [ # This contains the list of dimensions for the report
"A String",
],
"displayName": "A String", # This is the display name for the report
"environment": "A String", # Output only. Environment name
"filter": "A String", # This field contains the filter expression
"fromTime": "A String", # Legacy field: not used. Contains the from time for the report
"lastModifiedAt": "A String", # Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt
"lastViewedAt": "A String", # Output only. Last viewed time of this entity as milliseconds since epoch
"limit": "A String", # Legacy field: not used This field contains the limit for the result retrieved
"metrics": [ # Required. This contains the list of metrics
{ # This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum
"function": "A String", # aggregate function
"name": "A String", # name of the metric
},
],
"name": "A String", # Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id
"offset": "A String", # Legacy field: not used. This field contains the offset for the data
"organization": "A String", # Output only. Organization name
"properties": [ # This field contains report properties such as ui metadata etc.
{
"property": "A String", # name of the property
"value": [ # property values
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
},
],
"sortByCols": [ # Legacy field: not used much. Contains the list of sort by columns
"A String",
],
"sortOrder": "A String", # Legacy field: not used much. Contains the sort order for the sort columns
"tags": [ # Legacy field: not used. This field contains a list of tags associated with custom report
"A String",
],
"timeUnit": "A String", # This field contains the time unit of aggregation for the report
"toTime": "A String", # Legacy field: not used. Contains the end time for the report
"topk": "A String", # Legacy field: not used. This field contains the top k parameter value for restricting the result
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"chartType": "A String", # This field contains the chart type for the report
"comments": [ # Legacy field: not used. This field contains a list of comments associated with custom report
"A String",
],
"createdAt": "A String", # Output only. Unix time when the app was created json key: createdAt
"dimensions": [ # This contains the list of dimensions for the report
"A String",
],
"displayName": "A String", # This is the display name for the report
"environment": "A String", # Output only. Environment name
"filter": "A String", # This field contains the filter expression
"fromTime": "A String", # Legacy field: not used. Contains the from time for the report
"lastModifiedAt": "A String", # Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt
"lastViewedAt": "A String", # Output only. Last viewed time of this entity as milliseconds since epoch
"limit": "A String", # Legacy field: not used This field contains the limit for the result retrieved
"metrics": [ # Required. This contains the list of metrics
{ # This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum
"function": "A String", # aggregate function
"name": "A String", # name of the metric
},
],
"name": "A String", # Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id
"offset": "A String", # Legacy field: not used. This field contains the offset for the data
"organization": "A String", # Output only. Organization name
"properties": [ # This field contains report properties such as ui metadata etc.
{
"property": "A String", # name of the property
"value": [ # property values
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
},
],
"sortByCols": [ # Legacy field: not used much. Contains the list of sort by columns
"A String",
],
"sortOrder": "A String", # Legacy field: not used much. Contains the sort order for the sort columns
"tags": [ # Legacy field: not used. This field contains a list of tags associated with custom report
"A String",
],
"timeUnit": "A String", # This field contains the time unit of aggregation for the report
"toTime": "A String", # Legacy field: not used. Contains the end time for the report
"topk": "A String", # Legacy field: not used. This field contains the top k parameter value for restricting the result
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes an existing custom report definition
Args:
name: string, Required. Custom Report name of the form: `organizations/{organization_id}/reports/{report_name}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"message": "A String", # The response contains only a message field.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Retrieve a custom report definition.
Args:
name: string, Required. Custom Report name of the form: `organizations/{organization_id}/reports/{report_name}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"chartType": "A String", # This field contains the chart type for the report
"comments": [ # Legacy field: not used. This field contains a list of comments associated with custom report
"A String",
],
"createdAt": "A String", # Output only. Unix time when the app was created json key: createdAt
"dimensions": [ # This contains the list of dimensions for the report
"A String",
],
"displayName": "A String", # This is the display name for the report
"environment": "A String", # Output only. Environment name
"filter": "A String", # This field contains the filter expression
"fromTime": "A String", # Legacy field: not used. Contains the from time for the report
"lastModifiedAt": "A String", # Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt
"lastViewedAt": "A String", # Output only. Last viewed time of this entity as milliseconds since epoch
"limit": "A String", # Legacy field: not used This field contains the limit for the result retrieved
"metrics": [ # Required. This contains the list of metrics
{ # This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum
"function": "A String", # aggregate function
"name": "A String", # name of the metric
},
],
"name": "A String", # Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id
"offset": "A String", # Legacy field: not used. This field contains the offset for the data
"organization": "A String", # Output only. Organization name
"properties": [ # This field contains report properties such as ui metadata etc.
{
"property": "A String", # name of the property
"value": [ # property values
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
},
],
"sortByCols": [ # Legacy field: not used much. Contains the list of sort by columns
"A String",
],
"sortOrder": "A String", # Legacy field: not used much. Contains the sort order for the sort columns
"tags": [ # Legacy field: not used. This field contains a list of tags associated with custom report
"A String",
],
"timeUnit": "A String", # This field contains the time unit of aggregation for the report
"toTime": "A String", # Legacy field: not used. Contains the end time for the report
"topk": "A String", # Legacy field: not used. This field contains the top k parameter value for restricting the result
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, expand=None, x__xgafv=None)</code>
<pre>Return a list of Custom Reports
Args:
parent: string, Required. The parent organization name under which the API product will be listed `organizations/{organization_id}/reports` (required)
expand: boolean, Set to 'true' to get expanded details about each custom report.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This message encapsulates a list of custom report definitions
"qualifier": [
{
"chartType": "A String", # This field contains the chart type for the report
"comments": [ # Legacy field: not used. This field contains a list of comments associated with custom report
"A String",
],
"createdAt": "A String", # Output only. Unix time when the app was created json key: createdAt
"dimensions": [ # This contains the list of dimensions for the report
"A String",
],
"displayName": "A String", # This is the display name for the report
"environment": "A String", # Output only. Environment name
"filter": "A String", # This field contains the filter expression
"fromTime": "A String", # Legacy field: not used. Contains the from time for the report
"lastModifiedAt": "A String", # Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt
"lastViewedAt": "A String", # Output only. Last viewed time of this entity as milliseconds since epoch
"limit": "A String", # Legacy field: not used This field contains the limit for the result retrieved
"metrics": [ # Required. This contains the list of metrics
{ # This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum
"function": "A String", # aggregate function
"name": "A String", # name of the metric
},
],
"name": "A String", # Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id
"offset": "A String", # Legacy field: not used. This field contains the offset for the data
"organization": "A String", # Output only. Organization name
"properties": [ # This field contains report properties such as ui metadata etc.
{
"property": "A String", # name of the property
"value": [ # property values
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
},
],
"sortByCols": [ # Legacy field: not used much. Contains the list of sort by columns
"A String",
],
"sortOrder": "A String", # Legacy field: not used much. Contains the sort order for the sort columns
"tags": [ # Legacy field: not used. This field contains a list of tags associated with custom report
"A String",
],
"timeUnit": "A String", # This field contains the time unit of aggregation for the report
"toTime": "A String", # Legacy field: not used. Contains the end time for the report
"topk": "A String", # Legacy field: not used. This field contains the top k parameter value for restricting the result
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
<pre>Update an existing custom report definition
Args:
name: string, Required. Custom Report name of the form: `organizations/{organization_id}/reports/{report_name}` (required)
body: object, The request body.
The object takes the form of:
{
"chartType": "A String", # This field contains the chart type for the report
"comments": [ # Legacy field: not used. This field contains a list of comments associated with custom report
"A String",
],
"createdAt": "A String", # Output only. Unix time when the app was created json key: createdAt
"dimensions": [ # This contains the list of dimensions for the report
"A String",
],
"displayName": "A String", # This is the display name for the report
"environment": "A String", # Output only. Environment name
"filter": "A String", # This field contains the filter expression
"fromTime": "A String", # Legacy field: not used. Contains the from time for the report
"lastModifiedAt": "A String", # Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt
"lastViewedAt": "A String", # Output only. Last viewed time of this entity as milliseconds since epoch
"limit": "A String", # Legacy field: not used This field contains the limit for the result retrieved
"metrics": [ # Required. This contains the list of metrics
{ # This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum
"function": "A String", # aggregate function
"name": "A String", # name of the metric
},
],
"name": "A String", # Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id
"offset": "A String", # Legacy field: not used. This field contains the offset for the data
"organization": "A String", # Output only. Organization name
"properties": [ # This field contains report properties such as ui metadata etc.
{
"property": "A String", # name of the property
"value": [ # property values
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
},
],
"sortByCols": [ # Legacy field: not used much. Contains the list of sort by columns
"A String",
],
"sortOrder": "A String", # Legacy field: not used much. Contains the sort order for the sort columns
"tags": [ # Legacy field: not used. This field contains a list of tags associated with custom report
"A String",
],
"timeUnit": "A String", # This field contains the time unit of aggregation for the report
"toTime": "A String", # Legacy field: not used. Contains the end time for the report
"topk": "A String", # Legacy field: not used. This field contains the top k parameter value for restricting the result
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"chartType": "A String", # This field contains the chart type for the report
"comments": [ # Legacy field: not used. This field contains a list of comments associated with custom report
"A String",
],
"createdAt": "A String", # Output only. Unix time when the app was created json key: createdAt
"dimensions": [ # This contains the list of dimensions for the report
"A String",
],
"displayName": "A String", # This is the display name for the report
"environment": "A String", # Output only. Environment name
"filter": "A String", # This field contains the filter expression
"fromTime": "A String", # Legacy field: not used. Contains the from time for the report
"lastModifiedAt": "A String", # Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt
"lastViewedAt": "A String", # Output only. Last viewed time of this entity as milliseconds since epoch
"limit": "A String", # Legacy field: not used This field contains the limit for the result retrieved
"metrics": [ # Required. This contains the list of metrics
{ # This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum
"function": "A String", # aggregate function
"name": "A String", # name of the metric
},
],
"name": "A String", # Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id
"offset": "A String", # Legacy field: not used. This field contains the offset for the data
"organization": "A String", # Output only. Organization name
"properties": [ # This field contains report properties such as ui metadata etc.
{
"property": "A String", # name of the property
"value": [ # property values
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
},
],
"sortByCols": [ # Legacy field: not used much. Contains the list of sort by columns
"A String",
],
"sortOrder": "A String", # Legacy field: not used much. Contains the sort order for the sort columns
"tags": [ # Legacy field: not used. This field contains a list of tags associated with custom report
"A String",
],
"timeUnit": "A String", # This field contains the time unit of aggregation for the report
"toTime": "A String", # Legacy field: not used. Contains the end time for the report
"topk": "A String", # Legacy field: not used. This field contains the top k parameter value for restricting the result
}</pre>
</div>
</body></html>
|
