@gojinko/api-client 2.19.0 → 2.20.0
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.
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/tools.d.ts +9 -1
- package/dist/tools.d.ts.map +1 -1
- package/dist/tools.js +4 -0
- package/dist/tools.js.map +1 -1
- package/dist/types/devplatform.d.ts +48 -2
- package/dist/types/devplatform.d.ts.map +1 -1
- package/dist/types/generated.d.ts +441 -8
- package/dist/types/generated.d.ts.map +1 -1
- package/package.json +1 -1
- package/public-api.yaml +312 -4
|
@@ -41,9 +41,9 @@ export interface paths {
|
|
|
41
41
|
search_window_min?: components["parameters"]["searchWindowMin"];
|
|
42
42
|
/** @description Maximum advance-purchase window in days (must be >= search_window_min). */
|
|
43
43
|
search_window_max?: components["parameters"]["searchWindowMax"];
|
|
44
|
-
/** @description Snapshot mode only: number of most-recent days of search activity aggregated into the demand level (default 7, max 90 — the cube retains 90 days). Rejected when analysis=trend. */
|
|
44
|
+
/** @description Snapshot mode only: number of most-recent days of search activity aggregated into the demand level (min 2, default 7, max 90 — a 1-day window is the current day, whose data is incomplete; the cube retains 90 days). Rejected when analysis=trend. */
|
|
45
45
|
snapshot_window_days?: components["parameters"]["snapshotWindowDays"];
|
|
46
|
-
/** @description Trend mode only: size in days of each of the two adjacent windows compared for growth (default 7, max 45 — a trend spans 2x the window within the cube's 90-day retention). Rejected when analysis=snapshot. */
|
|
46
|
+
/** @description Trend mode only: size in days of each of the two adjacent windows compared for growth (min 2, default 7, max 45 — a 1-day window's recent period is the current day, whose data is incomplete; a trend spans 2x the window within the cube's 90-day retention). Rejected when analysis=snapshot. */
|
|
47
47
|
trend_window_days?: components["parameters"]["trendWindowDays"];
|
|
48
48
|
/** @description Max rows (1-200, default 20). */
|
|
49
49
|
limit?: components["parameters"]["limit"];
|
|
@@ -129,9 +129,9 @@ export interface paths {
|
|
|
129
129
|
search_window_min?: components["parameters"]["searchWindowMin"];
|
|
130
130
|
/** @description Maximum advance-purchase window in days (must be >= search_window_min). */
|
|
131
131
|
search_window_max?: components["parameters"]["searchWindowMax"];
|
|
132
|
-
/** @description Snapshot mode only: number of most-recent days of search activity aggregated into the demand level (default 7, max 90 — the cube retains 90 days). Rejected when analysis=trend. */
|
|
132
|
+
/** @description Snapshot mode only: number of most-recent days of search activity aggregated into the demand level (min 2, default 7, max 90 — a 1-day window is the current day, whose data is incomplete; the cube retains 90 days). Rejected when analysis=trend. */
|
|
133
133
|
snapshot_window_days?: components["parameters"]["snapshotWindowDays"];
|
|
134
|
-
/** @description Trend mode only: size in days of each of the two adjacent windows compared for growth (default 7, max 45 — a trend spans 2x the window within the cube's 90-day retention). Rejected when analysis=snapshot. */
|
|
134
|
+
/** @description Trend mode only: size in days of each of the two adjacent windows compared for growth (min 2, default 7, max 45 — a 1-day window's recent period is the current day, whose data is incomplete; a trend spans 2x the window within the cube's 90-day retention). Rejected when analysis=snapshot. */
|
|
135
135
|
trend_window_days?: components["parameters"]["trendWindowDays"];
|
|
136
136
|
/** @description Max rows (1-200, default 20). */
|
|
137
137
|
limit?: components["parameters"]["limit"];
|
|
@@ -215,9 +215,9 @@ export interface paths {
|
|
|
215
215
|
search_window_min?: components["parameters"]["searchWindowMin"];
|
|
216
216
|
/** @description Maximum advance-purchase window in days (must be >= search_window_min). */
|
|
217
217
|
search_window_max?: components["parameters"]["searchWindowMax"];
|
|
218
|
-
/** @description Snapshot mode only: number of most-recent days of search activity aggregated into the demand level (default 7, max 90 — the cube retains 90 days). Rejected when analysis=trend. */
|
|
218
|
+
/** @description Snapshot mode only: number of most-recent days of search activity aggregated into the demand level (min 2, default 7, max 90 — a 1-day window is the current day, whose data is incomplete; the cube retains 90 days). Rejected when analysis=trend. */
|
|
219
219
|
snapshot_window_days?: components["parameters"]["snapshotWindowDays"];
|
|
220
|
-
/** @description Trend mode only: size in days of each of the two adjacent windows compared for growth (default 7, max 45 — a trend spans 2x the window within the cube's 90-day retention). Rejected when analysis=snapshot. */
|
|
220
|
+
/** @description Trend mode only: size in days of each of the two adjacent windows compared for growth (min 2, default 7, max 45 — a 1-day window's recent period is the current day, whose data is incomplete; a trend spans 2x the window within the cube's 90-day retention). Rejected when analysis=snapshot. */
|
|
221
221
|
trend_window_days?: components["parameters"]["trendWindowDays"];
|
|
222
222
|
/** @description Max rows (1-200, default 20). */
|
|
223
223
|
limit?: components["parameters"]["limit"];
|
|
@@ -265,6 +265,346 @@ export interface paths {
|
|
|
265
265
|
patch?: never;
|
|
266
266
|
trace?: never;
|
|
267
267
|
};
|
|
268
|
+
"/v1/evolution": {
|
|
269
|
+
parameters: {
|
|
270
|
+
query?: never;
|
|
271
|
+
header?: never;
|
|
272
|
+
path?: never;
|
|
273
|
+
cookie?: never;
|
|
274
|
+
};
|
|
275
|
+
/**
|
|
276
|
+
* Daily demand time series for explicit origin/destination pairs
|
|
277
|
+
* @description Deep dive: returns one daily de-sampled search-volume series per (origin, destination) pair. v1 allows a list on only one side — a single origin with many destinations, or many origins with a single destination.
|
|
278
|
+
*/
|
|
279
|
+
get: {
|
|
280
|
+
parameters: {
|
|
281
|
+
query: {
|
|
282
|
+
/** @description Pairs endpoint: comma-separated origin selectors `<Level>:<Code>` (e.g. `Country:US,Country:CA`). v1: at most one of origins/destinations may have more than one entry. */
|
|
283
|
+
origins: components["parameters"]["origins"];
|
|
284
|
+
/** @description Pairs endpoint: comma-separated destination selectors `<Level>:<Code>` (e.g. `Country:FR,Country:DE`). */
|
|
285
|
+
destinations: components["parameters"]["destinations"];
|
|
286
|
+
/** @description Named departure window (defaults to Next90Days server-side). */
|
|
287
|
+
travel_period?: components["parameters"]["travelPeriod"];
|
|
288
|
+
/** @description Start of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
|
|
289
|
+
departure_date_from?: components["parameters"]["departureDateFrom"];
|
|
290
|
+
/** @description End of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
|
|
291
|
+
departure_date_to?: components["parameters"]["departureDateTo"];
|
|
292
|
+
/** @description Optional traveler-type filter. */
|
|
293
|
+
traveler_type?: components["parameters"]["travelerType"];
|
|
294
|
+
/** @description Optional trip-type filter. */
|
|
295
|
+
trip_type?: components["parameters"]["tripType"];
|
|
296
|
+
/** @description Minimum trip length in nights (return_date − dep_date). Round-trips only; must be >= 0. */
|
|
297
|
+
trip_duration_min?: components["parameters"]["tripDurationMin"];
|
|
298
|
+
/** @description Maximum trip length in nights (must be >= trip_duration_min). */
|
|
299
|
+
trip_duration_max?: components["parameters"]["tripDurationMax"];
|
|
300
|
+
/** @description Minimum advance-purchase window in days (dep_date − search_date): searches made at least this many days before departure. Must be >= 0. */
|
|
301
|
+
search_window_min?: components["parameters"]["searchWindowMin"];
|
|
302
|
+
/** @description Maximum advance-purchase window in days (must be >= search_window_min). */
|
|
303
|
+
search_window_max?: components["parameters"]["searchWindowMax"];
|
|
304
|
+
/** @description Size of the evolution window in days (min 2, default 7, max 45). The series spans the last N complete days ending yesterday; the current day is excluded as incomplete. */
|
|
305
|
+
trend_window_days?: components["parameters"]["evolutionWindowDays"];
|
|
306
|
+
/** @description Bucket size for the returned series: day (default), week, or month. */
|
|
307
|
+
granularity?: components["parameters"]["granularity"];
|
|
308
|
+
};
|
|
309
|
+
header?: never;
|
|
310
|
+
path?: never;
|
|
311
|
+
cookie?: never;
|
|
312
|
+
};
|
|
313
|
+
requestBody?: never;
|
|
314
|
+
responses: {
|
|
315
|
+
/** @description Per-pair demand time series */
|
|
316
|
+
200: {
|
|
317
|
+
headers: {
|
|
318
|
+
[name: string]: unknown;
|
|
319
|
+
};
|
|
320
|
+
content: {
|
|
321
|
+
"application/json": components["schemas"]["EvolutionResponse"];
|
|
322
|
+
};
|
|
323
|
+
};
|
|
324
|
+
/** @description Authentication required */
|
|
325
|
+
401: {
|
|
326
|
+
headers: {
|
|
327
|
+
[name: string]: unknown;
|
|
328
|
+
};
|
|
329
|
+
content: {
|
|
330
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
331
|
+
};
|
|
332
|
+
};
|
|
333
|
+
/** @description Validation error */
|
|
334
|
+
422: {
|
|
335
|
+
headers: {
|
|
336
|
+
[name: string]: unknown;
|
|
337
|
+
};
|
|
338
|
+
content: {
|
|
339
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
340
|
+
};
|
|
341
|
+
};
|
|
342
|
+
};
|
|
343
|
+
};
|
|
344
|
+
put?: never;
|
|
345
|
+
post?: never;
|
|
346
|
+
delete?: never;
|
|
347
|
+
options?: never;
|
|
348
|
+
head?: never;
|
|
349
|
+
patch?: never;
|
|
350
|
+
trace?: never;
|
|
351
|
+
};
|
|
352
|
+
"/v1/destination/evolution": {
|
|
353
|
+
parameters: {
|
|
354
|
+
query?: never;
|
|
355
|
+
header?: never;
|
|
356
|
+
path?: never;
|
|
357
|
+
cookie?: never;
|
|
358
|
+
};
|
|
359
|
+
/**
|
|
360
|
+
* Daily demand time series for the top-N destinations
|
|
361
|
+
* @description Ranks destinations (optionally reachable from origin_market) by within-window growth, then returns each top-N destination's daily series.
|
|
362
|
+
*/
|
|
363
|
+
get: {
|
|
364
|
+
parameters: {
|
|
365
|
+
query?: {
|
|
366
|
+
/** @description Origin market filter as <Level>:<Code>, e.g. Country:US or City:NYC. */
|
|
367
|
+
origin_market?: components["parameters"]["originMarket"];
|
|
368
|
+
/** @description Optional destination filter as <Level>:<Code>, e.g. Country:TH. */
|
|
369
|
+
destination?: components["parameters"]["destinationFilter"];
|
|
370
|
+
/** @description Named departure window (defaults to Next90Days server-side). */
|
|
371
|
+
travel_period?: components["parameters"]["travelPeriod"];
|
|
372
|
+
/** @description Start of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
|
|
373
|
+
departure_date_from?: components["parameters"]["departureDateFrom"];
|
|
374
|
+
/** @description End of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
|
|
375
|
+
departure_date_to?: components["parameters"]["departureDateTo"];
|
|
376
|
+
/** @description Optional traveler-type filter. */
|
|
377
|
+
traveler_type?: components["parameters"]["travelerType"];
|
|
378
|
+
/** @description Optional trip-type filter. */
|
|
379
|
+
trip_type?: components["parameters"]["tripType"];
|
|
380
|
+
/** @description Minimum trip length in nights (return_date − dep_date). Round-trips only; must be >= 0. */
|
|
381
|
+
trip_duration_min?: components["parameters"]["tripDurationMin"];
|
|
382
|
+
/** @description Maximum trip length in nights (must be >= trip_duration_min). */
|
|
383
|
+
trip_duration_max?: components["parameters"]["tripDurationMax"];
|
|
384
|
+
/** @description Minimum advance-purchase window in days (dep_date − search_date): searches made at least this many days before departure. Must be >= 0. */
|
|
385
|
+
search_window_min?: components["parameters"]["searchWindowMin"];
|
|
386
|
+
/** @description Maximum advance-purchase window in days (must be >= search_window_min). */
|
|
387
|
+
search_window_max?: components["parameters"]["searchWindowMax"];
|
|
388
|
+
/** @description Size of the evolution window in days (min 2, default 7, max 45). The series spans the last N complete days ending yesterday; the current day is excluded as incomplete. */
|
|
389
|
+
trend_window_days?: components["parameters"]["evolutionWindowDays"];
|
|
390
|
+
/** @description Bucket size for the returned series: day (default), week, or month. */
|
|
391
|
+
granularity?: components["parameters"]["granularity"];
|
|
392
|
+
/** @description Evolution endpoints: maximum number of series (top-N keys). Default 10, max 50. */
|
|
393
|
+
limit?: components["parameters"]["evolutionLimit"];
|
|
394
|
+
};
|
|
395
|
+
header?: never;
|
|
396
|
+
path?: never;
|
|
397
|
+
cookie?: never;
|
|
398
|
+
};
|
|
399
|
+
requestBody?: never;
|
|
400
|
+
responses: {
|
|
401
|
+
/** @description Top-N destination time series */
|
|
402
|
+
200: {
|
|
403
|
+
headers: {
|
|
404
|
+
[name: string]: unknown;
|
|
405
|
+
};
|
|
406
|
+
content: {
|
|
407
|
+
"application/json": components["schemas"]["EvolutionResponse"];
|
|
408
|
+
};
|
|
409
|
+
};
|
|
410
|
+
/** @description Authentication required */
|
|
411
|
+
401: {
|
|
412
|
+
headers: {
|
|
413
|
+
[name: string]: unknown;
|
|
414
|
+
};
|
|
415
|
+
content: {
|
|
416
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
417
|
+
};
|
|
418
|
+
};
|
|
419
|
+
/** @description Validation error */
|
|
420
|
+
422: {
|
|
421
|
+
headers: {
|
|
422
|
+
[name: string]: unknown;
|
|
423
|
+
};
|
|
424
|
+
content: {
|
|
425
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
426
|
+
};
|
|
427
|
+
};
|
|
428
|
+
};
|
|
429
|
+
};
|
|
430
|
+
put?: never;
|
|
431
|
+
post?: never;
|
|
432
|
+
delete?: never;
|
|
433
|
+
options?: never;
|
|
434
|
+
head?: never;
|
|
435
|
+
patch?: never;
|
|
436
|
+
trace?: never;
|
|
437
|
+
};
|
|
438
|
+
"/v1/market/evolution": {
|
|
439
|
+
parameters: {
|
|
440
|
+
query?: never;
|
|
441
|
+
header?: never;
|
|
442
|
+
path?: never;
|
|
443
|
+
cookie?: never;
|
|
444
|
+
};
|
|
445
|
+
/**
|
|
446
|
+
* Daily demand time series for the top-N source markets
|
|
447
|
+
* @description Ranks source markets for a destination by within-window growth, then returns each top-N market's daily series. `destination` is required.
|
|
448
|
+
*/
|
|
449
|
+
get: {
|
|
450
|
+
parameters: {
|
|
451
|
+
query: {
|
|
452
|
+
/** @description Destination as <Level>:<Code>, e.g. Country:TH. Required for this endpoint. */
|
|
453
|
+
destination: components["parameters"]["destinationRequired"];
|
|
454
|
+
/** @description Origin market filter as <Level>:<Code>, e.g. Country:US or City:NYC. */
|
|
455
|
+
origin_market?: components["parameters"]["originMarket"];
|
|
456
|
+
/** @description Named departure window (defaults to Next90Days server-side). */
|
|
457
|
+
travel_period?: components["parameters"]["travelPeriod"];
|
|
458
|
+
/** @description Start of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
|
|
459
|
+
departure_date_from?: components["parameters"]["departureDateFrom"];
|
|
460
|
+
/** @description End of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
|
|
461
|
+
departure_date_to?: components["parameters"]["departureDateTo"];
|
|
462
|
+
/** @description Optional traveler-type filter. */
|
|
463
|
+
traveler_type?: components["parameters"]["travelerType"];
|
|
464
|
+
/** @description Optional trip-type filter. */
|
|
465
|
+
trip_type?: components["parameters"]["tripType"];
|
|
466
|
+
/** @description Minimum trip length in nights (return_date − dep_date). Round-trips only; must be >= 0. */
|
|
467
|
+
trip_duration_min?: components["parameters"]["tripDurationMin"];
|
|
468
|
+
/** @description Maximum trip length in nights (must be >= trip_duration_min). */
|
|
469
|
+
trip_duration_max?: components["parameters"]["tripDurationMax"];
|
|
470
|
+
/** @description Minimum advance-purchase window in days (dep_date − search_date): searches made at least this many days before departure. Must be >= 0. */
|
|
471
|
+
search_window_min?: components["parameters"]["searchWindowMin"];
|
|
472
|
+
/** @description Maximum advance-purchase window in days (must be >= search_window_min). */
|
|
473
|
+
search_window_max?: components["parameters"]["searchWindowMax"];
|
|
474
|
+
/** @description Size of the evolution window in days (min 2, default 7, max 45). The series spans the last N complete days ending yesterday; the current day is excluded as incomplete. */
|
|
475
|
+
trend_window_days?: components["parameters"]["evolutionWindowDays"];
|
|
476
|
+
/** @description Bucket size for the returned series: day (default), week, or month. */
|
|
477
|
+
granularity?: components["parameters"]["granularity"];
|
|
478
|
+
/** @description Evolution endpoints: maximum number of series (top-N keys). Default 10, max 50. */
|
|
479
|
+
limit?: components["parameters"]["evolutionLimit"];
|
|
480
|
+
};
|
|
481
|
+
header?: never;
|
|
482
|
+
path?: never;
|
|
483
|
+
cookie?: never;
|
|
484
|
+
};
|
|
485
|
+
requestBody?: never;
|
|
486
|
+
responses: {
|
|
487
|
+
/** @description Top-N market time series */
|
|
488
|
+
200: {
|
|
489
|
+
headers: {
|
|
490
|
+
[name: string]: unknown;
|
|
491
|
+
};
|
|
492
|
+
content: {
|
|
493
|
+
"application/json": components["schemas"]["EvolutionResponse"];
|
|
494
|
+
};
|
|
495
|
+
};
|
|
496
|
+
/** @description Authentication required */
|
|
497
|
+
401: {
|
|
498
|
+
headers: {
|
|
499
|
+
[name: string]: unknown;
|
|
500
|
+
};
|
|
501
|
+
content: {
|
|
502
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
503
|
+
};
|
|
504
|
+
};
|
|
505
|
+
/** @description Validation error */
|
|
506
|
+
422: {
|
|
507
|
+
headers: {
|
|
508
|
+
[name: string]: unknown;
|
|
509
|
+
};
|
|
510
|
+
content: {
|
|
511
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
512
|
+
};
|
|
513
|
+
};
|
|
514
|
+
};
|
|
515
|
+
};
|
|
516
|
+
put?: never;
|
|
517
|
+
post?: never;
|
|
518
|
+
delete?: never;
|
|
519
|
+
options?: never;
|
|
520
|
+
head?: never;
|
|
521
|
+
patch?: never;
|
|
522
|
+
trace?: never;
|
|
523
|
+
};
|
|
524
|
+
"/v1/audience/evolution": {
|
|
525
|
+
parameters: {
|
|
526
|
+
query?: never;
|
|
527
|
+
header?: never;
|
|
528
|
+
path?: never;
|
|
529
|
+
cookie?: never;
|
|
530
|
+
};
|
|
531
|
+
/**
|
|
532
|
+
* Daily demand time series for the traveler-type mix
|
|
533
|
+
* @description Returns a daily series per traveler-type segment (Solo / Couple / Family / Group) of demand for a destination. `destination` is required; `traveler_type` is not a filter here — this endpoint buckets by it.
|
|
534
|
+
*/
|
|
535
|
+
get: {
|
|
536
|
+
parameters: {
|
|
537
|
+
query: {
|
|
538
|
+
/** @description Destination as <Level>:<Code>, e.g. Country:TH. Required for this endpoint. */
|
|
539
|
+
destination: components["parameters"]["destinationRequired"];
|
|
540
|
+
/** @description Origin market filter as <Level>:<Code>, e.g. Country:US or City:NYC. */
|
|
541
|
+
origin_market?: components["parameters"]["originMarket"];
|
|
542
|
+
/** @description Named departure window (defaults to Next90Days server-side). */
|
|
543
|
+
travel_period?: components["parameters"]["travelPeriod"];
|
|
544
|
+
/** @description Start of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
|
|
545
|
+
departure_date_from?: components["parameters"]["departureDateFrom"];
|
|
546
|
+
/** @description End of departure window (YYYY-MM-DD). Required when travel_period=Custom. */
|
|
547
|
+
departure_date_to?: components["parameters"]["departureDateTo"];
|
|
548
|
+
/** @description Optional trip-type filter. */
|
|
549
|
+
trip_type?: components["parameters"]["tripType"];
|
|
550
|
+
/** @description Minimum trip length in nights (return_date − dep_date). Round-trips only; must be >= 0. */
|
|
551
|
+
trip_duration_min?: components["parameters"]["tripDurationMin"];
|
|
552
|
+
/** @description Maximum trip length in nights (must be >= trip_duration_min). */
|
|
553
|
+
trip_duration_max?: components["parameters"]["tripDurationMax"];
|
|
554
|
+
/** @description Minimum advance-purchase window in days (dep_date − search_date): searches made at least this many days before departure. Must be >= 0. */
|
|
555
|
+
search_window_min?: components["parameters"]["searchWindowMin"];
|
|
556
|
+
/** @description Maximum advance-purchase window in days (must be >= search_window_min). */
|
|
557
|
+
search_window_max?: components["parameters"]["searchWindowMax"];
|
|
558
|
+
/** @description Size of the evolution window in days (min 2, default 7, max 45). The series spans the last N complete days ending yesterday; the current day is excluded as incomplete. */
|
|
559
|
+
trend_window_days?: components["parameters"]["evolutionWindowDays"];
|
|
560
|
+
/** @description Bucket size for the returned series: day (default), week, or month. */
|
|
561
|
+
granularity?: components["parameters"]["granularity"];
|
|
562
|
+
/** @description Evolution endpoints: maximum number of series (top-N keys). Default 10, max 50. */
|
|
563
|
+
limit?: components["parameters"]["evolutionLimit"];
|
|
564
|
+
};
|
|
565
|
+
header?: never;
|
|
566
|
+
path?: never;
|
|
567
|
+
cookie?: never;
|
|
568
|
+
};
|
|
569
|
+
requestBody?: never;
|
|
570
|
+
responses: {
|
|
571
|
+
/** @description Per-segment time series */
|
|
572
|
+
200: {
|
|
573
|
+
headers: {
|
|
574
|
+
[name: string]: unknown;
|
|
575
|
+
};
|
|
576
|
+
content: {
|
|
577
|
+
"application/json": components["schemas"]["EvolutionResponse"];
|
|
578
|
+
};
|
|
579
|
+
};
|
|
580
|
+
/** @description Authentication required */
|
|
581
|
+
401: {
|
|
582
|
+
headers: {
|
|
583
|
+
[name: string]: unknown;
|
|
584
|
+
};
|
|
585
|
+
content: {
|
|
586
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
587
|
+
};
|
|
588
|
+
};
|
|
589
|
+
/** @description Validation error */
|
|
590
|
+
422: {
|
|
591
|
+
headers: {
|
|
592
|
+
[name: string]: unknown;
|
|
593
|
+
};
|
|
594
|
+
content: {
|
|
595
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
596
|
+
};
|
|
597
|
+
};
|
|
598
|
+
};
|
|
599
|
+
};
|
|
600
|
+
put?: never;
|
|
601
|
+
post?: never;
|
|
602
|
+
delete?: never;
|
|
603
|
+
options?: never;
|
|
604
|
+
head?: never;
|
|
605
|
+
patch?: never;
|
|
606
|
+
trace?: never;
|
|
607
|
+
};
|
|
268
608
|
"/health": {
|
|
269
609
|
parameters: {
|
|
270
610
|
query?: never;
|
|
@@ -3256,6 +3596,89 @@ export interface components {
|
|
|
3256
3596
|
analysis_type: components["schemas"]["AnalysisType"];
|
|
3257
3597
|
rows: components["schemas"]["AudienceRow"][];
|
|
3258
3598
|
};
|
|
3599
|
+
/**
|
|
3600
|
+
* @description Bucket size for an evolution series: day (default), week, or month.
|
|
3601
|
+
* @enum {string}
|
|
3602
|
+
*/
|
|
3603
|
+
Granularity: "day" | "week" | "month";
|
|
3604
|
+
EvolutionPoint: {
|
|
3605
|
+
/**
|
|
3606
|
+
* Format: date
|
|
3607
|
+
* @description Bucket start date (YYYY-MM-DD).
|
|
3608
|
+
* @example 2026-06-20
|
|
3609
|
+
*/
|
|
3610
|
+
date: string;
|
|
3611
|
+
/**
|
|
3612
|
+
* Format: double
|
|
3613
|
+
* @description De-sampled search volume for the bucket.
|
|
3614
|
+
* @example 1234
|
|
3615
|
+
*/
|
|
3616
|
+
value: number;
|
|
3617
|
+
};
|
|
3618
|
+
/** @description Per-series rollup over the returned window. */
|
|
3619
|
+
SeriesSummary: {
|
|
3620
|
+
/**
|
|
3621
|
+
* Format: double
|
|
3622
|
+
* @example 34567
|
|
3623
|
+
*/
|
|
3624
|
+
total?: number;
|
|
3625
|
+
/**
|
|
3626
|
+
* Format: double
|
|
3627
|
+
* @example 1191
|
|
3628
|
+
*/
|
|
3629
|
+
avg_per_day?: number;
|
|
3630
|
+
/**
|
|
3631
|
+
* Format: double
|
|
3632
|
+
* @description Within-window growth %: recent half vs. prior half. Null when the prior half is empty.
|
|
3633
|
+
* @example 12.3
|
|
3634
|
+
*/
|
|
3635
|
+
growth_pct?: number | null;
|
|
3636
|
+
/**
|
|
3637
|
+
* Format: date
|
|
3638
|
+
* @example 2026-06-14
|
|
3639
|
+
*/
|
|
3640
|
+
peak_date?: string;
|
|
3641
|
+
/**
|
|
3642
|
+
* Format: double
|
|
3643
|
+
* @example 1890
|
|
3644
|
+
*/
|
|
3645
|
+
peak_value?: number;
|
|
3646
|
+
};
|
|
3647
|
+
EvolutionSeries: {
|
|
3648
|
+
/**
|
|
3649
|
+
* @description Ranked dimension value (destination/market/audience endpoints); omitted for the pairs endpoint.
|
|
3650
|
+
* @example Country:FR
|
|
3651
|
+
*/
|
|
3652
|
+
label?: string;
|
|
3653
|
+
/**
|
|
3654
|
+
* @description Pairs endpoint only: the origin selector for this series.
|
|
3655
|
+
* @example Country:US
|
|
3656
|
+
*/
|
|
3657
|
+
origin?: string;
|
|
3658
|
+
/**
|
|
3659
|
+
* @description Pairs endpoint only: the destination selector for this series.
|
|
3660
|
+
* @example Country:FR
|
|
3661
|
+
*/
|
|
3662
|
+
destination?: string;
|
|
3663
|
+
series: components["schemas"]["EvolutionPoint"][];
|
|
3664
|
+
summary?: components["schemas"]["SeriesSummary"];
|
|
3665
|
+
};
|
|
3666
|
+
EvolutionResponse: {
|
|
3667
|
+
granularity: components["schemas"]["Granularity"];
|
|
3668
|
+
/**
|
|
3669
|
+
* Format: date
|
|
3670
|
+
* @description First (inclusive) bucket date of the window.
|
|
3671
|
+
* @example 2026-06-19
|
|
3672
|
+
*/
|
|
3673
|
+
from: string;
|
|
3674
|
+
/**
|
|
3675
|
+
* Format: date
|
|
3676
|
+
* @description Last (inclusive) bucket date of the window.
|
|
3677
|
+
* @example 2026-06-25
|
|
3678
|
+
*/
|
|
3679
|
+
to: string;
|
|
3680
|
+
series: components["schemas"]["EvolutionSeries"][];
|
|
3681
|
+
};
|
|
3259
3682
|
};
|
|
3260
3683
|
responses: never;
|
|
3261
3684
|
parameters: {
|
|
@@ -3285,12 +3708,22 @@ export interface components {
|
|
|
3285
3708
|
searchWindowMin: number;
|
|
3286
3709
|
/** @description Maximum advance-purchase window in days (must be >= search_window_min). */
|
|
3287
3710
|
searchWindowMax: number;
|
|
3288
|
-
/** @description Snapshot mode only: number of most-recent days of search activity aggregated into the demand level (default 7, max 90 — the cube retains 90 days). Rejected when analysis=trend. */
|
|
3711
|
+
/** @description Snapshot mode only: number of most-recent days of search activity aggregated into the demand level (min 2, default 7, max 90 — a 1-day window is the current day, whose data is incomplete; the cube retains 90 days). Rejected when analysis=trend. */
|
|
3289
3712
|
snapshotWindowDays: number;
|
|
3290
|
-
/** @description Trend mode only: size in days of each of the two adjacent windows compared for growth (default 7, max 45 — a trend spans 2x the window within the cube's 90-day retention). Rejected when analysis=snapshot. */
|
|
3713
|
+
/** @description Trend mode only: size in days of each of the two adjacent windows compared for growth (min 2, default 7, max 45 — a 1-day window's recent period is the current day, whose data is incomplete; a trend spans 2x the window within the cube's 90-day retention). Rejected when analysis=snapshot. */
|
|
3291
3714
|
trendWindowDays: number;
|
|
3292
3715
|
/** @description Max rows (1-200, default 20). */
|
|
3293
3716
|
limit: number;
|
|
3717
|
+
/** @description Pairs endpoint: comma-separated origin selectors `<Level>:<Code>` (e.g. `Country:US,Country:CA`). v1: at most one of origins/destinations may have more than one entry. */
|
|
3718
|
+
origins: string;
|
|
3719
|
+
/** @description Pairs endpoint: comma-separated destination selectors `<Level>:<Code>` (e.g. `Country:FR,Country:DE`). */
|
|
3720
|
+
destinations: string;
|
|
3721
|
+
/** @description Size of the evolution window in days (min 2, default 7, max 45). The series spans the last N complete days ending yesterday; the current day is excluded as incomplete. */
|
|
3722
|
+
evolutionWindowDays: number;
|
|
3723
|
+
/** @description Bucket size for the returned series: day (default), week, or month. */
|
|
3724
|
+
granularity: components["schemas"]["Granularity"];
|
|
3725
|
+
/** @description Evolution endpoints: maximum number of series (top-N keys). Default 10, max 50. */
|
|
3726
|
+
evolutionLimit: number;
|
|
3294
3727
|
};
|
|
3295
3728
|
requestBodies: never;
|
|
3296
3729
|
headers: never;
|