| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.stats.html">stats</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="cloudsearch_v1.stats.index.html">index()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the index Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="#getIndex">getIndex(toDate_year=None, fromDate_month=None, fromDate_year=None, toDate_month=None, x__xgafv=None, toDate_day=None, fromDate_day=None)</a></code></p> |
| 84 | <p class="firstline">Gets indexed item statistics aggreggated across all data sources. This</p> |
| 85 | <h3>Method Details</h3> |
| 86 | <div class="method"> |
| 87 | <code class="details" id="getIndex">getIndex(toDate_year=None, fromDate_month=None, fromDate_year=None, toDate_month=None, x__xgafv=None, toDate_day=None, fromDate_day=None)</code> |
| 88 | <pre>Gets indexed item statistics aggreggated across all data sources. This |
| 89 | API only returns statistics for previous dates; it doesn't return |
| 90 | statistics for the current day. |
| 91 | |
| 92 | Args: |
| 93 | toDate_year: integer, Year of date. Must be from 1 to 9999. |
| 94 | fromDate_month: integer, Month of date. Must be from 1 to 12. |
| 95 | fromDate_year: integer, Year of date. Must be from 1 to 9999. |
| 96 | toDate_month: integer, Month of date. Must be from 1 to 12. |
| 97 | x__xgafv: string, V1 error format. |
| 98 | Allowed values |
| 99 | 1 - v1 error format |
| 100 | 2 - v2 error format |
| 101 | toDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month. |
| 102 | fromDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month. |
| 103 | |
| 104 | Returns: |
| 105 | An object of the form: |
| 106 | |
| 107 | { |
| 108 | "stats": [ # Summary of indexed item counts, one for each day in the requested range. |
| 109 | { # Aggregation of items by status code as of the specified date. |
| 110 | "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999. # Date for which statistics were calculated. |
| 111 | "month": 42, # Month of date. Must be from 1 to 12. |
| 112 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month. |
| 113 | "year": 42, # Year of date. Must be from 1 to 9999. |
| 114 | }, |
| 115 | "itemCountByStatus": [ # Number of items aggregrated by status code. |
| 116 | { |
| 117 | "count": "A String", # Number of items matching the status code. |
| 118 | "statusCode": "A String", # Status of the items. |
| 119 | }, |
| 120 | ], |
| 121 | }, |
| 122 | ], |
| 123 | }</pre> |
| 124 | </div> |
| 125 | |
| 126 | </body></html> |