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
|
<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="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.stats.html">stats</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="cloudsearch_v1.stats.index.html">index()</a></code>
</p>
<p class="firstline">Returns the index Resource.</p>
<p class="toc_element">
<code><a href="cloudsearch_v1.stats.query.html">query()</a></code>
</p>
<p class="firstline">Returns the query Resource.</p>
<p class="toc_element">
<code><a href="cloudsearch_v1.stats.session.html">session()</a></code>
</p>
<p class="firstline">Returns the session Resource.</p>
<p class="toc_element">
<code><a href="cloudsearch_v1.stats.user.html">user()</a></code>
</p>
<p class="firstline">Returns the user Resource.</p>
<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="#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>
<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>
<p class="toc_element">
<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>
<p class="firstline">Get the query statistics for customer. **Note:** This API requires a standard end user account to execute.</p>
<p class="toc_element">
<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>
<p class="firstline">Get search application stats for customer. **Note:** This API requires a standard end user account to execute.</p>
<p class="toc_element">
<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>
<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>
<p class="toc_element">
<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>
<p class="firstline">Get the users statistics for customer. **Note:** This API requires a standard end user account to execute.</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="getIndex">getIndex(fromDate_day=None, fromDate_month=None, fromDate_year=None, toDate_day=None, toDate_month=None, toDate_year=None, x__xgafv=None)</code>
<pre>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.
Args:
fromDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
fromDate_month: integer, Month of date. Must be from 1 to 12.
fromDate_year: integer, Year of date. Must be from 1 to 9999.
toDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
toDate_month: integer, Month of date. Must be from 1 to 12.
toDate_year: integer, Year of date. Must be from 1 to 9999.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"averageIndexedItemCount": "A String", # Average item count for the given date range for which billing is done.
"stats": [ # Summary of indexed item counts, one for each day in the requested range.
{ # Aggregation of items by status code as of the specified date.
"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. # The date for which statistics were calculated.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"month": 42, # Month of date. Must be from 1 to 12.
"year": 42, # Year of date. Must be from 1 to 9999.
},
"itemCountByStatus": [ # Number of items aggregrated by status code.
{
"count": "A String", # Number of items matching the status code.
"indexedItemsCount": "A String", # 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.
"statusCode": "A String", # Status of the items.
},
],
},
],
}</pre>
</div>
<div class="method">
<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>
<pre>Get the query statistics for customer. **Note:** This API requires a standard end user account to execute.
Args:
fromDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
fromDate_month: integer, Month of date. Must be from 1 to 12.
fromDate_year: integer, Year of date. Must be from 1 to 9999.
toDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
toDate_month: integer, Month of date. Must be from 1 to 12.
toDate_year: integer, Year of date. Must be from 1 to 9999.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"stats": [
{
"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. # The date for which query stats were calculated. Stats calculated on the next day close to midnight are returned.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"month": 42, # Month of date. Must be from 1 to 12.
"year": 42, # Year of date. Must be from 1 to 9999.
},
"queryCountByStatus": [
{
"count": "A String",
"statusCode": 42, # This represents the http status code.
},
],
},
],
"totalQueryCount": "A String", # Total successful query count (status code 200) for the given date range.
}</pre>
</div>
<div class="method">
<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>
<pre>Get search application stats for customer. **Note:** This API requires a standard end user account to execute.
Args:
endDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
endDate_month: integer, Month of date. Must be from 1 to 12.
endDate_year: integer, Year of date. Must be from 1 to 9999.
startDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
startDate_month: integer, Month of date. Must be from 1 to 12.
startDate_year: integer, Year of date. Must be from 1 to 9999.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response format for search application stats for a customer.
"averageSearchApplicationCount": "A String", # Average search application count for the given date range.
"stats": [ # Search application stats by date.
{ # Search application stats for a customer for the given date.
"count": "A String", # The count of search applications for the date.
"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. # The date for which search application stats were calculated.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"month": 42, # Month of date. Must be from 1 to 12.
"year": 42, # Year of date. Must be from 1 to 9999.
},
},
],
}</pre>
</div>
<div class="method">
<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>
<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.
Args:
fromDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
fromDate_month: integer, Month of date. Must be from 1 to 12.
fromDate_year: integer, Year of date. Must be from 1 to 9999.
toDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
toDate_month: integer, Month of date. Must be from 1 to 12.
toDate_year: integer, Year of date. Must be from 1 to 9999.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"stats": [
{
"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. # The date for which session stats were calculated. Stats are calculated on the following day, close to midnight PST, and then returned.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"month": 42, # Month of date. Must be from 1 to 12.
"year": 42, # Year of date. Must be from 1 to 9999.
},
"searchSessionsCount": "A String", # The count of search sessions on the day
},
],
}</pre>
</div>
<div class="method">
<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>
<pre>Get the users statistics for customer. **Note:** This API requires a standard end user account to execute.
Args:
fromDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
fromDate_month: integer, Month of date. Must be from 1 to 12.
fromDate_year: integer, Year of date. Must be from 1 to 9999.
toDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
toDate_month: integer, Month of date. Must be from 1 to 12.
toDate_year: integer, Year of date. Must be from 1 to 9999.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"stats": [
{
"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. # The date for which session stats were calculated. Stats calculated on the next day close to midnight are returned.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"month": 42, # Month of date. Must be from 1 to 12.
"year": 42, # Year of date. Must be from 1 to 9999.
},
"oneDayActiveUsersCount": "A String", # The count of unique active users in the past one day
"sevenDaysActiveUsersCount": "A String", # The count of unique active users in the past seven days
"thirtyDaysActiveUsersCount": "A String", # The count of unique active users in the past thirty days
},
],
}</pre>
</div>
</body></html>
|
