Debian Codegraph @

docs/dyn/cloudsearch_v1.stats.html

raw
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="cloudsearch_v1.stats.query.html">query()</a></code>
84 </p>
85 <p class="firstline">Returns the query Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="cloudsearch_v1.stats.session.html">session()</a></code>
89 </p>
90 <p class="firstline">Returns the session Resource.</p>
91
92 <p class="toc_element">
93 <code><a href="cloudsearch_v1.stats.user.html">user()</a></code>
94 </p>
95 <p class="firstline">Returns the user Resource.</p>
96
97 <p class="toc_element">
98 <code><a href="#close">close()</a></code></p>
99 <p class="firstline">Close httplib2 connections.</p>
100 <p class="toc_element">
101 <code><a href="#getIndex">getIndex(fromDate_day=None, fromDate_month=None, fromDate_year=None, toDate_day=None, toDate_month=None, toDate_year=None, x__xgafv=None)</a></code></p>
102 <p class="firstline">Gets indexed item statistics aggreggated across all data sources. This API only returns statistics for previous dates; it doesn't return statistics for the current day. **Note:** This API requires a standard end user account to execute.</p>
103 <p class="toc_element">
104 <code><a href="#getQuery">getQuery(fromDate_day=None, fromDate_month=None, fromDate_year=None, toDate_day=None, toDate_month=None, toDate_year=None, x__xgafv=None)</a></code></p>
105 <p class="firstline">Get the query statistics for customer. **Note:** This API requires a standard end user account to execute.</p>
106 <p class="toc_element">
107 <code><a href="#getSearchapplication">getSearchapplication(endDate_day=None, endDate_month=None, endDate_year=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None)</a></code></p>
108 <p class="firstline">Get search application stats for customer. **Note:** This API requires a standard end user account to execute.</p>
109 <p class="toc_element">
110 <code><a href="#getSession">getSession(fromDate_day=None, fromDate_month=None, fromDate_year=None, toDate_day=None, toDate_month=None, toDate_year=None, x__xgafv=None)</a></code></p>
111 <p class="firstline">Get the # of search sessions, % of successful sessions with a click query statistics for customer. **Note:** This API requires a standard end user account to execute.</p>
112 <p class="toc_element">
113 <code><a href="#getUser">getUser(fromDate_day=None, fromDate_month=None, fromDate_year=None, toDate_day=None, toDate_month=None, toDate_year=None, x__xgafv=None)</a></code></p>
114 <p class="firstline">Get the users statistics for customer. **Note:** This API requires a standard end user account to execute.</p>
115 <h3>Method Details</h3>
116 <div class="method">
117 <code class="details" id="close">close()</code>
118 <pre>Close httplib2 connections.</pre>
119 </div>
120
121 <div class="method">
122 <code class="details" id="getIndex">getIndex(fromDate_day=None, fromDate_month=None, fromDate_year=None, toDate_day=None, toDate_month=None, toDate_year=None, x__xgafv=None)</code>
123 <pre>Gets indexed item statistics aggreggated across all data sources. This API only returns statistics for previous dates; it doesn&#x27;t return statistics for the current day. **Note:** This API requires a standard end user account to execute.
124
125 Args:
126 fromDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
127 fromDate_month: integer, Month of date. Must be from 1 to 12.
128 fromDate_year: integer, Year of date. Must be from 1 to 9999.
129 toDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
130 toDate_month: integer, Month of date. Must be from 1 to 12.
131 toDate_year: integer, Year of date. Must be from 1 to 9999.
132 x__xgafv: string, V1 error format.
133 Allowed values
134 1 - v1 error format
135 2 - v2 error format
136
137 Returns:
138 An object of the form:
139
140 {
141 &quot;averageIndexedItemCount&quot;: &quot;A String&quot;, # Average item count for the given date range for which billing is done.
142 &quot;stats&quot;: [ # Summary of indexed item counts, one for each day in the requested range.
143 { # Aggregation of items by status code as of the specified date.
144 &quot;date&quot;: { # 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. # The date for which statistics were calculated.
145 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
146 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
147 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
148 },
149 &quot;itemCountByStatus&quot;: [ # Number of items aggregrated by status code.
150 {
151 &quot;count&quot;: &quot;A String&quot;, # Number of items matching the status code.
152 &quot;indexedItemsCount&quot;: &quot;A String&quot;, # Number of items matching the status code for which billing is done. This excludes virtual container items from the total count. This count would not be applicable for items with ERROR or NEW_ITEM status code.
153 &quot;statusCode&quot;: &quot;A String&quot;, # Status of the items.
154 },
155 ],
156 },
157 ],
158 }</pre>
159 </div>
160
161 <div class="method">
162 <code class="details" id="getQuery">getQuery(fromDate_day=None, fromDate_month=None, fromDate_year=None, toDate_day=None, toDate_month=None, toDate_year=None, x__xgafv=None)</code>
163 <pre>Get the query statistics for customer. **Note:** This API requires a standard end user account to execute.
164
165 Args:
166 fromDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
167 fromDate_month: integer, Month of date. Must be from 1 to 12.
168 fromDate_year: integer, Year of date. Must be from 1 to 9999.
169 toDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
170 toDate_month: integer, Month of date. Must be from 1 to 12.
171 toDate_year: integer, Year of date. Must be from 1 to 9999.
172 x__xgafv: string, V1 error format.
173 Allowed values
174 1 - v1 error format
175 2 - v2 error format
176
177 Returns:
178 An object of the form:
179
180 {
181 &quot;stats&quot;: [
182 {
183 &quot;date&quot;: { # 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. # The date for which query stats were calculated. Stats calculated on the next day close to midnight are returned.
184 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
185 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
186 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
187 },
188 &quot;queryCountByStatus&quot;: [
189 {
190 &quot;count&quot;: &quot;A String&quot;,
191 &quot;statusCode&quot;: 42, # This represents the http status code.
192 },
193 ],
194 },
195 ],
196 &quot;totalQueryCount&quot;: &quot;A String&quot;, # Total successful query count (status code 200) for the given date range.
197 }</pre>
198 </div>
199
200 <div class="method">
201 <code class="details" id="getSearchapplication">getSearchapplication(endDate_day=None, endDate_month=None, endDate_year=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None)</code>
202 <pre>Get search application stats for customer. **Note:** This API requires a standard end user account to execute.
203
204 Args:
205 endDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
206 endDate_month: integer, Month of date. Must be from 1 to 12.
207 endDate_year: integer, Year of date. Must be from 1 to 9999.
208 startDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
209 startDate_month: integer, Month of date. Must be from 1 to 12.
210 startDate_year: integer, Year of date. Must be from 1 to 9999.
211 x__xgafv: string, V1 error format.
212 Allowed values
213 1 - v1 error format
214 2 - v2 error format
215
216 Returns:
217 An object of the form:
218
219 { # Response format for search application stats for a customer.
220 &quot;averageSearchApplicationCount&quot;: &quot;A String&quot;, # Average search application count for the given date range.
221 &quot;stats&quot;: [ # Search application stats by date.
222 { # Search application stats for a customer for the given date.
223 &quot;count&quot;: &quot;A String&quot;, # The count of search applications for the date.
224 &quot;date&quot;: { # 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. # The date for which search application stats were calculated.
225 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
226 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
227 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
228 },
229 },
230 ],
231 }</pre>
232 </div>
233
234 <div class="method">
235 <code class="details" id="getSession">getSession(fromDate_day=None, fromDate_month=None, fromDate_year=None, toDate_day=None, toDate_month=None, toDate_year=None, x__xgafv=None)</code>
236 <pre>Get the # of search sessions, % of successful sessions with a click query statistics for customer. **Note:** This API requires a standard end user account to execute.
237
238 Args:
239 fromDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
240 fromDate_month: integer, Month of date. Must be from 1 to 12.
241 fromDate_year: integer, Year of date. Must be from 1 to 9999.
242 toDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
243 toDate_month: integer, Month of date. Must be from 1 to 12.
244 toDate_year: integer, Year of date. Must be from 1 to 9999.
245 x__xgafv: string, V1 error format.
246 Allowed values
247 1 - v1 error format
248 2 - v2 error format
249
250 Returns:
251 An object of the form:
252
253 {
254 &quot;stats&quot;: [
255 {
256 &quot;date&quot;: { # 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. # The date for which session stats were calculated. Stats are calculated on the following day, close to midnight PST, and then returned.
257 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
258 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
259 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
260 },
261 &quot;searchSessionsCount&quot;: &quot;A String&quot;, # The count of search sessions on the day
262 },
263 ],
264 }</pre>
265 </div>
266
267 <div class="method">
268 <code class="details" id="getUser">getUser(fromDate_day=None, fromDate_month=None, fromDate_year=None, toDate_day=None, toDate_month=None, toDate_year=None, x__xgafv=None)</code>
269 <pre>Get the users statistics for customer. **Note:** This API requires a standard end user account to execute.
270
271 Args:
272 fromDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
273 fromDate_month: integer, Month of date. Must be from 1 to 12.
274 fromDate_year: integer, Year of date. Must be from 1 to 9999.
275 toDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
276 toDate_month: integer, Month of date. Must be from 1 to 12.
277 toDate_year: integer, Year of date. Must be from 1 to 9999.
278 x__xgafv: string, V1 error format.
279 Allowed values
280 1 - v1 error format
281 2 - v2 error format
282
283 Returns:
284 An object of the form:
285
286 {
287 &quot;stats&quot;: [
288 {
289 &quot;date&quot;: { # 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. # The date for which session stats were calculated. Stats calculated on the next day close to midnight are returned.
290 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
291 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
292 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
293 },
294 &quot;oneDayActiveUsersCount&quot;: &quot;A String&quot;, # The count of unique active users in the past one day
295 &quot;sevenDaysActiveUsersCount&quot;: &quot;A String&quot;, # The count of unique active users in the past seven days
296 &quot;thirtyDaysActiveUsersCount&quot;: &quot;A String&quot;, # The count of unique active users in the past thirty days
297 },
298 ],
299 }</pre>
300 </div>
301
302 </body></html>