picked 0.0.103 → 0.0.104-next.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -119,6 +119,22 @@ enum AnalyticsSessionsReportKind {
119
119
  }
120
120
  ```
121
121
 
122
+ ### `AnalyticsSessionSearchSuggestion`
123
+
124
+ ```graphql
125
+ """
126
+ A session search suggested for what was typed into a sessions search box.
127
+ """
128
+ type AnalyticsSessionSearchSuggestion {
129
+ """The session search query."""
130
+ query: String!
131
+ """What the query finds, in plain English."""
132
+ description: String!
133
+ """How many sessions the query keeps within the window."""
134
+ count: Int!
135
+ }
136
+ ```
137
+
122
138
  ### `AnalyticsSessionConnection`
123
139
 
124
140
  ```graphql
@@ -199,7 +215,9 @@ type AnalyticsSessionSummary {
199
215
  Where the visitor came from. Null when the landing page had no referrer.
200
216
  """
201
217
  referrer: AnalyticsReferrer
202
- """The UTM campaign of the landing page's URL. Null when it carried none."""
218
+ """
219
+ The UTM campaign of the landing page's URL. Null when none of its fields has a value.
220
+ """
203
221
  campaign: AnalyticsCampaign
204
222
  """The visitor's device. Null when it is unknown."""
205
223
  device: AnalyticsDevice
@@ -210,6 +228,10 @@ type AnalyticsSessionSummary {
210
228
  """
211
229
  gaid: String
212
230
  """
231
+ The Google Ads click ID, the `gclid` of the landing page's URL. Null when it carried none.
232
+ """
233
+ gclid: String
234
+ """
213
235
  The visitor's Picked ID, from the first event to carry one. Null when none did.
214
236
  """
215
237
  visitorId: String
@@ -243,6 +265,14 @@ type AnalyticsCampaign {
243
265
  medium: String
244
266
  """`utm_campaign`."""
245
267
  name: String
268
+ """
269
+ `utm_term`. Null as well when the URL carried neither `utm_source` nor `utm_medium`.
270
+ """
271
+ term: String
272
+ """
273
+ `utm_content`. Null as well when the URL carried neither `utm_source` nor `utm_medium`.
274
+ """
275
+ content: String
246
276
  }
247
277
  ```
248
278
 
@@ -160,6 +160,23 @@ type LeadResponse {
160
160
  }
161
161
  ```
162
162
 
163
+ ### `LeadSearchSuggestion`
164
+
165
+ ```graphql
166
+ """A leads search suggested for what was typed into a leads search box."""
167
+ type LeadSearchSuggestion {
168
+ """The leads search query."""
169
+ query: String!
170
+ """What the query finds, in plain English."""
171
+ description: String!
172
+ """
173
+ How many leads the query matches within the window. Null when a `session.` clause leaves the
174
+ query without a total.
175
+ """
176
+ count: Int
177
+ }
178
+ ```
179
+
163
180
  ### `LeadConnection`
164
181
 
165
182
  ```graphql
@@ -252,6 +252,23 @@ type Project {
252
252
  """
253
253
  leadReports: [LeadReport!]! @auth
254
254
  """
255
+ Suggests up to four leads searches for what was typed into a leads search box, each counted within
256
+ the window. Requires the `lead-search-suggestions` feature flag.
257
+ Scope: `ORGANIZATION_LEADS_READ`.
258
+ """
259
+ leadSearchSuggestions(
260
+ """What was typed, at most 200 characters."""
261
+ text: String!
262
+ """
263
+ The window, in the project's time zone, each suggestion is counted within.
264
+ """
265
+ window: MetricWindowInput
266
+ """
267
+ How a session's leads count. `SESSION` counts each session's newest matching lead once.
268
+ """
269
+ collapse: LeadCollapse = NONE
270
+ ): [LeadSearchSuggestion!]! @auth
271
+ """
255
272
  The Sessions reports on the project, in order: how its sessions arrive, the journeys they take,
256
273
  and which of them convert. Each is a signed embed URL locked to the project, with an editable
257
274
  date range.
@@ -292,16 +309,35 @@ type Project {
292
309
  containing it, or any value, for `gaid`, `utm_source`, `utm_medium`,
293
310
  `utm_campaign`, `utm_term`, `utm_content`, `page_url`, `page_origin`,
294
311
  `page_pathname`, `page_query`, `landing_page_url`, `landing_page_origin`,
295
- `landing_page_pathname` or `landing_page_query`, each also written under
296
- `session.`; `lead:*` asks that the session captured a lead. A leading `-`
297
- negates a clause; clauses combine with AND, or with OR when the query says
298
- so, never both; at most ten.
312
+ `landing_page_pathname` or `landing_page_query`; `location_country`,
313
+ `location_country_code`, `location_region` and `location_city` ask the same
314
+ of the session's location, equal in any case; each field is also written under `session.`; `lead:*` asks that the
315
+ session captured a lead. A leading `-` negates a clause; clauses combine
316
+ with AND, or with OR when the query says so, never both; at most ten.
299
317
  """
300
318
  query: String
301
319
  """Whether to include bots."""
302
320
  includeBots: Boolean = false
303
321
  ): AnalyticsSessionConnection! @auth
304
322
  """
323
+ Suggests up to four session searches for what was typed into a sessions search box, each with
324
+ how many sessions it keeps within the window. Requires the `lead-search-suggestions` feature flag.
325
+ Scope: `ORGANIZATION_LEADS_READ`.
326
+ """
327
+ analyticsSessionSearchSuggestions(
328
+ """What was typed, at most 200 characters."""
329
+ text: String!
330
+ """
331
+ The window, in the project's time zone, each suggestion is counted within. Defaults to today
332
+ and the six days before it.
333
+ """
334
+ window: MetricWindowInput
335
+ """
336
+ Whether each count keeps the sessions of bots, as `analyticsSessions` does.
337
+ """
338
+ includeBots: Boolean = false
339
+ ): [AnalyticsSessionSearchSuggestion!]! @auth
340
+ """
305
341
  The saved views of one of the project's lists, oldest first.
306
342
  Scope: `ORGANIZATION_PROJECTS_READ`.
307
343
  """
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "picked",
3
3
  "description": "The Picked SDK front door: the client, the picked.config helpers, and the picked CLI in one install",
4
- "version": "0.0.103",
4
+ "version": "0.0.104-next.2",
5
5
  "bin": {
6
6
  "picked": "dist/esm/bin.js"
7
7
  },
8
8
  "dependencies": {
9
- "@picked/cli": "0.0.103",
10
- "@picked/config": "0.0.103"
9
+ "@picked/cli": "0.0.104-next.2",
10
+ "@picked/config": "0.0.104-next.2"
11
11
  },
12
12
  "devDependencies": {
13
13
  "@picked/client": "workspace:*",
@@ -64,7 +64,7 @@
64
64
  "main": "./dist/cjs/index.js",
65
65
  "module": "./dist/esm/index.js",
66
66
  "peerDependencies": {
67
- "@picked/client": "0.0.103"
67
+ "@picked/client": "0.0.104-next.2"
68
68
  },
69
69
  "private": false,
70
70
  "publishConfig": {