1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<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> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 82<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> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes an existing custom report definition</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Retrieve a custom report definition.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, expand=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Return a list of Custom Reports</p> 92<p class="toc_element"> 93 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Update an existing custom report definition</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="close">close()</code> 98 <pre>Close httplib2 connections.</pre> 99</div> 100 101<div class="method"> 102 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 103 <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. 104 105Args: 106 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) 107 body: object, The request body. 108 The object takes the form of: 109 110{ 111 "chartType": "A String", # This field contains the chart type for the report 112 "comments": [ # Legacy field: not used. This field contains a list of comments associated with custom report 113 "A String", 114 ], 115 "createdAt": "A String", # Output only. Unix time when the app was created json key: createdAt 116 "dimensions": [ # This contains the list of dimensions for the report 117 "A String", 118 ], 119 "displayName": "A String", # This is the display name for the report 120 "environment": "A String", # Output only. Environment name 121 "filter": "A String", # This field contains the filter expression 122 "fromTime": "A String", # Legacy field: not used. Contains the from time for the report 123 "lastModifiedAt": "A String", # Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt 124 "lastViewedAt": "A String", # Output only. Last viewed time of this entity as milliseconds since epoch 125 "limit": "A String", # Legacy field: not used This field contains the limit for the result retrieved 126 "metrics": [ # Required. This contains the list of metrics 127 { # This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum 128 "function": "A String", # aggregate function 129 "name": "A String", # name of the metric 130 }, 131 ], 132 "name": "A String", # Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id 133 "offset": "A String", # Legacy field: not used. This field contains the offset for the data 134 "organization": "A String", # Output only. Organization name 135 "properties": [ # This field contains report properties such as ui metadata etc. 136 { 137 "property": "A String", # name of the property 138 "value": [ # property values 139 { # Key-value pair to store extra metadata. 140 "name": "A String", # API key of the attribute. 141 "value": "A String", # Value of the attribute. 142 }, 143 ], 144 }, 145 ], 146 "sortByCols": [ # Legacy field: not used much. Contains the list of sort by columns 147 "A String", 148 ], 149 "sortOrder": "A String", # Legacy field: not used much. Contains the sort order for the sort columns 150 "tags": [ # Legacy field: not used. This field contains a list of tags associated with custom report 151 "A String", 152 ], 153 "timeUnit": "A String", # This field contains the time unit of aggregation for the report 154 "toTime": "A String", # Legacy field: not used. Contains the end time for the report 155 "topk": "A String", # Legacy field: not used. This field contains the top k parameter value for restricting the result 156} 157 158 x__xgafv: string, V1 error format. 159 Allowed values 160 1 - v1 error format 161 2 - v2 error format 162 163Returns: 164 An object of the form: 165 166 { 167 "chartType": "A String", # This field contains the chart type for the report 168 "comments": [ # Legacy field: not used. This field contains a list of comments associated with custom report 169 "A String", 170 ], 171 "createdAt": "A String", # Output only. Unix time when the app was created json key: createdAt 172 "dimensions": [ # This contains the list of dimensions for the report 173 "A String", 174 ], 175 "displayName": "A String", # This is the display name for the report 176 "environment": "A String", # Output only. Environment name 177 "filter": "A String", # This field contains the filter expression 178 "fromTime": "A String", # Legacy field: not used. Contains the from time for the report 179 "lastModifiedAt": "A String", # Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt 180 "lastViewedAt": "A String", # Output only. Last viewed time of this entity as milliseconds since epoch 181 "limit": "A String", # Legacy field: not used This field contains the limit for the result retrieved 182 "metrics": [ # Required. This contains the list of metrics 183 { # This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum 184 "function": "A String", # aggregate function 185 "name": "A String", # name of the metric 186 }, 187 ], 188 "name": "A String", # Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id 189 "offset": "A String", # Legacy field: not used. This field contains the offset for the data 190 "organization": "A String", # Output only. Organization name 191 "properties": [ # This field contains report properties such as ui metadata etc. 192 { 193 "property": "A String", # name of the property 194 "value": [ # property values 195 { # Key-value pair to store extra metadata. 196 "name": "A String", # API key of the attribute. 197 "value": "A String", # Value of the attribute. 198 }, 199 ], 200 }, 201 ], 202 "sortByCols": [ # Legacy field: not used much. Contains the list of sort by columns 203 "A String", 204 ], 205 "sortOrder": "A String", # Legacy field: not used much. Contains the sort order for the sort columns 206 "tags": [ # Legacy field: not used. This field contains a list of tags associated with custom report 207 "A String", 208 ], 209 "timeUnit": "A String", # This field contains the time unit of aggregation for the report 210 "toTime": "A String", # Legacy field: not used. Contains the end time for the report 211 "topk": "A String", # Legacy field: not used. This field contains the top k parameter value for restricting the result 212}</pre> 213</div> 214 215<div class="method"> 216 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 217 <pre>Deletes an existing custom report definition 218 219Args: 220 name: string, Required. Custom Report name of the form: `organizations/{organization_id}/reports/{report_name}` (required) 221 x__xgafv: string, V1 error format. 222 Allowed values 223 1 - v1 error format 224 2 - v2 error format 225 226Returns: 227 An object of the form: 228 229 { 230 "message": "A String", # The response contains only a message field. 231}</pre> 232</div> 233 234<div class="method"> 235 <code class="details" id="get">get(name, x__xgafv=None)</code> 236 <pre>Retrieve a custom report definition. 237 238Args: 239 name: string, Required. Custom Report name of the form: `organizations/{organization_id}/reports/{report_name}` (required) 240 x__xgafv: string, V1 error format. 241 Allowed values 242 1 - v1 error format 243 2 - v2 error format 244 245Returns: 246 An object of the form: 247 248 { 249 "chartType": "A String", # This field contains the chart type for the report 250 "comments": [ # Legacy field: not used. This field contains a list of comments associated with custom report 251 "A String", 252 ], 253 "createdAt": "A String", # Output only. Unix time when the app was created json key: createdAt 254 "dimensions": [ # This contains the list of dimensions for the report 255 "A String", 256 ], 257 "displayName": "A String", # This is the display name for the report 258 "environment": "A String", # Output only. Environment name 259 "filter": "A String", # This field contains the filter expression 260 "fromTime": "A String", # Legacy field: not used. Contains the from time for the report 261 "lastModifiedAt": "A String", # Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt 262 "lastViewedAt": "A String", # Output only. Last viewed time of this entity as milliseconds since epoch 263 "limit": "A String", # Legacy field: not used This field contains the limit for the result retrieved 264 "metrics": [ # Required. This contains the list of metrics 265 { # This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum 266 "function": "A String", # aggregate function 267 "name": "A String", # name of the metric 268 }, 269 ], 270 "name": "A String", # Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id 271 "offset": "A String", # Legacy field: not used. This field contains the offset for the data 272 "organization": "A String", # Output only. Organization name 273 "properties": [ # This field contains report properties such as ui metadata etc. 274 { 275 "property": "A String", # name of the property 276 "value": [ # property values 277 { # Key-value pair to store extra metadata. 278 "name": "A String", # API key of the attribute. 279 "value": "A String", # Value of the attribute. 280 }, 281 ], 282 }, 283 ], 284 "sortByCols": [ # Legacy field: not used much. Contains the list of sort by columns 285 "A String", 286 ], 287 "sortOrder": "A String", # Legacy field: not used much. Contains the sort order for the sort columns 288 "tags": [ # Legacy field: not used. This field contains a list of tags associated with custom report 289 "A String", 290 ], 291 "timeUnit": "A String", # This field contains the time unit of aggregation for the report 292 "toTime": "A String", # Legacy field: not used. Contains the end time for the report 293 "topk": "A String", # Legacy field: not used. This field contains the top k parameter value for restricting the result 294}</pre> 295</div> 296 297<div class="method"> 298 <code class="details" id="list">list(parent, expand=None, x__xgafv=None)</code> 299 <pre>Return a list of Custom Reports 300 301Args: 302 parent: string, Required. The parent organization name under which the API product will be listed `organizations/{organization_id}/reports` (required) 303 expand: boolean, Set to 'true' to get expanded details about each custom report. 304 x__xgafv: string, V1 error format. 305 Allowed values 306 1 - v1 error format 307 2 - v2 error format 308 309Returns: 310 An object of the form: 311 312 { # This message encapsulates a list of custom report definitions 313 "qualifier": [ 314 { 315 "chartType": "A String", # This field contains the chart type for the report 316 "comments": [ # Legacy field: not used. This field contains a list of comments associated with custom report 317 "A String", 318 ], 319 "createdAt": "A String", # Output only. Unix time when the app was created json key: createdAt 320 "dimensions": [ # This contains the list of dimensions for the report 321 "A String", 322 ], 323 "displayName": "A String", # This is the display name for the report 324 "environment": "A String", # Output only. Environment name 325 "filter": "A String", # This field contains the filter expression 326 "fromTime": "A String", # Legacy field: not used. Contains the from time for the report 327 "lastModifiedAt": "A String", # Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt 328 "lastViewedAt": "A String", # Output only. Last viewed time of this entity as milliseconds since epoch 329 "limit": "A String", # Legacy field: not used This field contains the limit for the result retrieved 330 "metrics": [ # Required. This contains the list of metrics 331 { # This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum 332 "function": "A String", # aggregate function 333 "name": "A String", # name of the metric 334 }, 335 ], 336 "name": "A String", # Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id 337 "offset": "A String", # Legacy field: not used. This field contains the offset for the data 338 "organization": "A String", # Output only. Organization name 339 "properties": [ # This field contains report properties such as ui metadata etc. 340 { 341 "property": "A String", # name of the property 342 "value": [ # property values 343 { # Key-value pair to store extra metadata. 344 "name": "A String", # API key of the attribute. 345 "value": "A String", # Value of the attribute. 346 }, 347 ], 348 }, 349 ], 350 "sortByCols": [ # Legacy field: not used much. Contains the list of sort by columns 351 "A String", 352 ], 353 "sortOrder": "A String", # Legacy field: not used much. Contains the sort order for the sort columns 354 "tags": [ # Legacy field: not used. This field contains a list of tags associated with custom report 355 "A String", 356 ], 357 "timeUnit": "A String", # This field contains the time unit of aggregation for the report 358 "toTime": "A String", # Legacy field: not used. Contains the end time for the report 359 "topk": "A String", # Legacy field: not used. This field contains the top k parameter value for restricting the result 360 }, 361 ], 362}</pre> 363</div> 364 365<div class="method"> 366 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code> 367 <pre>Update an existing custom report definition 368 369Args: 370 name: string, Required. Custom Report name of the form: `organizations/{organization_id}/reports/{report_name}` (required) 371 body: object, The request body. 372 The object takes the form of: 373 374{ 375 "chartType": "A String", # This field contains the chart type for the report 376 "comments": [ # Legacy field: not used. This field contains a list of comments associated with custom report 377 "A String", 378 ], 379 "createdAt": "A String", # Output only. Unix time when the app was created json key: createdAt 380 "dimensions": [ # This contains the list of dimensions for the report 381 "A String", 382 ], 383 "displayName": "A String", # This is the display name for the report 384 "environment": "A String", # Output only. Environment name 385 "filter": "A String", # This field contains the filter expression 386 "fromTime": "A String", # Legacy field: not used. Contains the from time for the report 387 "lastModifiedAt": "A String", # Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt 388 "lastViewedAt": "A String", # Output only. Last viewed time of this entity as milliseconds since epoch 389 "limit": "A String", # Legacy field: not used This field contains the limit for the result retrieved 390 "metrics": [ # Required. This contains the list of metrics 391 { # This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum 392 "function": "A String", # aggregate function 393 "name": "A String", # name of the metric 394 }, 395 ], 396 "name": "A String", # Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id 397 "offset": "A String", # Legacy field: not used. This field contains the offset for the data 398 "organization": "A String", # Output only. Organization name 399 "properties": [ # This field contains report properties such as ui metadata etc. 400 { 401 "property": "A String", # name of the property 402 "value": [ # property values 403 { # Key-value pair to store extra metadata. 404 "name": "A String", # API key of the attribute. 405 "value": "A String", # Value of the attribute. 406 }, 407 ], 408 }, 409 ], 410 "sortByCols": [ # Legacy field: not used much. Contains the list of sort by columns 411 "A String", 412 ], 413 "sortOrder": "A String", # Legacy field: not used much. Contains the sort order for the sort columns 414 "tags": [ # Legacy field: not used. This field contains a list of tags associated with custom report 415 "A String", 416 ], 417 "timeUnit": "A String", # This field contains the time unit of aggregation for the report 418 "toTime": "A String", # Legacy field: not used. Contains the end time for the report 419 "topk": "A String", # Legacy field: not used. This field contains the top k parameter value for restricting the result 420} 421 422 x__xgafv: string, V1 error format. 423 Allowed values 424 1 - v1 error format 425 2 - v2 error format 426 427Returns: 428 An object of the form: 429 430 { 431 "chartType": "A String", # This field contains the chart type for the report 432 "comments": [ # Legacy field: not used. This field contains a list of comments associated with custom report 433 "A String", 434 ], 435 "createdAt": "A String", # Output only. Unix time when the app was created json key: createdAt 436 "dimensions": [ # This contains the list of dimensions for the report 437 "A String", 438 ], 439 "displayName": "A String", # This is the display name for the report 440 "environment": "A String", # Output only. Environment name 441 "filter": "A String", # This field contains the filter expression 442 "fromTime": "A String", # Legacy field: not used. Contains the from time for the report 443 "lastModifiedAt": "A String", # Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt 444 "lastViewedAt": "A String", # Output only. Last viewed time of this entity as milliseconds since epoch 445 "limit": "A String", # Legacy field: not used This field contains the limit for the result retrieved 446 "metrics": [ # Required. This contains the list of metrics 447 { # This encapsulates a metric property of the form sum(message_count) where name is message_count and function is sum 448 "function": "A String", # aggregate function 449 "name": "A String", # name of the metric 450 }, 451 ], 452 "name": "A String", # Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id 453 "offset": "A String", # Legacy field: not used. This field contains the offset for the data 454 "organization": "A String", # Output only. Organization name 455 "properties": [ # This field contains report properties such as ui metadata etc. 456 { 457 "property": "A String", # name of the property 458 "value": [ # property values 459 { # Key-value pair to store extra metadata. 460 "name": "A String", # API key of the attribute. 461 "value": "A String", # Value of the attribute. 462 }, 463 ], 464 }, 465 ], 466 "sortByCols": [ # Legacy field: not used much. Contains the list of sort by columns 467 "A String", 468 ], 469 "sortOrder": "A String", # Legacy field: not used much. Contains the sort order for the sort columns 470 "tags": [ # Legacy field: not used. This field contains a list of tags associated with custom report 471 "A String", 472 ], 473 "timeUnit": "A String", # This field contains the time unit of aggregation for the report 474 "toTime": "A String", # Legacy field: not used. Contains the end time for the report 475 "topk": "A String", # Legacy field: not used. This field contains the top k parameter value for restricting the result 476}</pre> 477</div> 478 479</body></html>