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