Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 673ec5cf1a654055c85c0d426b27d270a8ade262 / . / docs / dyn / cloudsearch_v1.stats.html
blob: c5aa1753b135ae738f438527f25d8c105d6c29ff [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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="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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]98 <code><a href="#close">close()</a></code></p>
99<p class="firstline">Close httplib2 connections.</p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]100<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]101 <code><a href="#getIndex">getIndex(toDate_day=None, toDate_month=None, fromDate_year=None, toDate_year=None, fromDate_month=None, fromDate_day=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]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>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]103<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]104 <code><a href="#getQuery">getQuery(fromDate_month=None, fromDate_day=None, fromDate_year=None, toDate_month=None, toDate_year=None, toDate_day=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]105<p class="firstline">Get the query statistics for customer. **Note:** This API requires a standard end user account to execute.</p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]106<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]107 <code><a href="#getSession">getSession(toDate_year=None, fromDate_month=None, fromDate_year=None, fromDate_day=None, toDate_month=None, toDate_day=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]108<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>
109<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]110 <code><a href="#getUser">getUser(fromDate_year=None, toDate_day=None, fromDate_day=None, toDate_year=None, fromDate_month=None, toDate_month=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]111<p class="firstline">Get the users statistics for customer. **Note:** This API requires a standard end user account to execute.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112<h3>Method Details</h3>
113<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]114 <code class="details" id="close">close()</code>
115 <pre>Close httplib2 connections.</pre>
116</div>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]117
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]118<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]119 <code class="details" id="getIndex">getIndex(toDate_day=None, toDate_month=None, fromDate_year=None, toDate_year=None, fromDate_month=None, fromDate_day=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]120 <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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]121
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]123 toDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]124 toDate_month: integer, Month of date. Must be from 1 to 12.
125 fromDate_year: integer, Year of date. Must be from 1 to 9999.
126 toDate_year: integer, Year of date. Must be from 1 to 9999.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]127 fromDate_month: integer, Month of date. Must be from 1 to 12.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]128 fromDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129 x__xgafv: string, V1 error format.
130 Allowed values
131 1 - v1 error format
132 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]133
134Returns:
135 An object of the form:
136
137 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]138 &quot;stats&quot;: [ # Summary of indexed item counts, one for each day in the requested range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139 { # Aggregation of items by status code as of the specified date.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]140 &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. # Date for which statistics were calculated.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]141 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]142 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]143 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
144 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]145 &quot;itemCountByStatus&quot;: [ # Number of items aggregrated by status code.
146 {
147 &quot;count&quot;: &quot;A String&quot;, # Number of items matching the status code.
148 &quot;statusCode&quot;: &quot;A String&quot;, # Status of the items.
149 },
150 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]151 },
152 ],
153 }</pre>
154</div>
155
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]156<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]157 <code class="details" id="getQuery">getQuery(fromDate_month=None, fromDate_day=None, fromDate_year=None, toDate_month=None, toDate_year=None, toDate_day=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]158 <pre>Get the query statistics for customer. **Note:** This API requires a standard end user account to execute.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]159
160Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]161 fromDate_month: integer, Month of date. Must be from 1 to 12.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]162 fromDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
163 fromDate_year: integer, Year of date. Must be from 1 to 9999.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]164 toDate_month: integer, Month of date. Must be from 1 to 12.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]165 toDate_year: integer, Year of date. Must be from 1 to 9999.
166 toDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]167 x__xgafv: string, V1 error format.
168 Allowed values
169 1 - v1 error format
170 2 - v2 error format
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]171
172Returns:
173 An object of the form:
174
175 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]176 &quot;stats&quot;: [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]177 {
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]178 &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. # Date for which query stats were calculated. Stats calculated on the next day close to midnight are returned.
179 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
180 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
181 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
182 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]183 &quot;queryCountByStatus&quot;: [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]184 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]185 &quot;count&quot;: &quot;A String&quot;,
186 &quot;statusCode&quot;: 42, # This represents the http status code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]187 },
188 ],
189 },
190 ],
191 }</pre>
192</div>
193
194<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]195 <code class="details" id="getSession">getSession(toDate_year=None, fromDate_month=None, fromDate_year=None, fromDate_day=None, toDate_month=None, toDate_day=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]196 <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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]197
198Args:
199 toDate_year: integer, Year of date. Must be from 1 to 9999.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]200 fromDate_month: integer, Month of date. Must be from 1 to 12.
201 fromDate_year: integer, Year of date. Must be from 1 to 9999.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]202 fromDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]203 toDate_month: integer, Month of date. Must be from 1 to 12.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]204 toDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]205 x__xgafv: string, V1 error format.
206 Allowed values
207 1 - v1 error format
208 2 - v2 error format
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]209
210Returns:
211 An object of the form:
212
213 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]214 &quot;stats&quot;: [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]215 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]216 &quot;searchSessionsCount&quot;: &quot;A String&quot;, # The count of search sessions on the day
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]217 &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. # Date for which session stats were calculated. Stats calculated on the next day close to midnight are returned.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]218 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]219 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]220 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
221 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]222 },
223 ],
224 }</pre>
225</div>
226
227<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]228 <code class="details" id="getUser">getUser(fromDate_year=None, toDate_day=None, fromDate_day=None, toDate_year=None, fromDate_month=None, toDate_month=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]229 <pre>Get the users statistics for customer. **Note:** This API requires a standard end user account to execute.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]230
231Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]232 fromDate_year: integer, Year of date. Must be from 1 to 9999.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]233 toDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]234 fromDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month.
235 toDate_year: integer, Year of date. Must be from 1 to 9999.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]236 fromDate_month: integer, Month of date. Must be from 1 to 12.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]237 toDate_month: integer, Month of date. Must be from 1 to 12.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]238 x__xgafv: string, V1 error format.
239 Allowed values
240 1 - v1 error format
241 2 - v2 error format
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]242
243Returns:
244 An object of the form:
245
246 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]247 &quot;stats&quot;: [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]248 {
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]249 &quot;sevenDaysActiveUsersCount&quot;: &quot;A String&quot;, # The count of unique active users in the past seven days
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]250 &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. # Date for which session stats were calculated. Stats calculated on the next day close to midnight are returned.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]251 &quot;year&quot;: 42, # Year of date. Must be from 1 to 9999.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]252 &quot;month&quot;: 42, # Month of date. Must be from 1 to 12.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]253 &quot;day&quot;: 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]254 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]255 &quot;thirtyDaysActiveUsersCount&quot;: &quot;A String&quot;, # The count of unique active users in the past thirty days
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]256 &quot;oneDayActiveUsersCount&quot;: &quot;A String&quot;, # The count of unique active users in the past one day
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]257 },
258 ],
259 }</pre>
260</div>
261
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]262</body></html>