profoundai 0.35.1 → 0.36.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/CHANGELOG.md +25 -0
- package/client.d.mts +13 -2
- package/client.d.mts.map +1 -1
- package/client.d.ts +13 -2
- package/client.d.ts.map +1 -1
- package/client.js +3 -0
- package/client.js.map +1 -1
- package/client.mjs +3 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/index.d.mts +2 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +2 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/logs/raw.d.mts +1 -17
- package/resources/logs/raw.d.mts.map +1 -1
- package/resources/logs/raw.d.ts +1 -17
- package/resources/logs/raw.d.ts.map +1 -1
- package/resources/prompt-volumes.d.mts +112 -0
- package/resources/prompt-volumes.d.mts.map +1 -0
- package/resources/prompt-volumes.d.ts +112 -0
- package/resources/prompt-volumes.d.ts.map +1 -0
- package/resources/prompt-volumes.js +21 -0
- package/resources/prompt-volumes.js.map +1 -0
- package/resources/prompt-volumes.mjs +17 -0
- package/resources/prompt-volumes.mjs.map +1 -0
- package/resources/prompts.d.mts +1 -46
- package/resources/prompts.d.mts.map +1 -1
- package/resources/prompts.d.ts +1 -46
- package/resources/prompts.d.ts.map +1 -1
- package/resources/reports.d.mts +229 -147
- package/resources/reports.d.mts.map +1 -1
- package/resources/reports.d.ts +229 -147
- package/resources/reports.d.ts.map +1 -1
- package/resources/reports.js +68 -0
- package/resources/reports.js.map +1 -1
- package/resources/reports.mjs +68 -0
- package/resources/reports.mjs.map +1 -1
- package/resources/shared.d.mts +76 -0
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +76 -0
- package/resources/shared.d.ts.map +1 -1
- package/src/client.ts +33 -0
- package/src/resources/index.ts +11 -0
- package/src/resources/logs/raw.ts +2 -136
- package/src/resources/prompt-volumes.ts +203 -0
- package/src/resources/prompts.ts +6 -78
- package/src/resources/reports.ts +322 -299
- package/src/resources/shared.ts +221 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/src/resources/reports.ts
CHANGED
|
@@ -50,6 +50,39 @@ export class Reports extends APIResource {
|
|
|
50
50
|
return this._client.post('/v1/reports/bots', { body, ...options });
|
|
51
51
|
}
|
|
52
52
|
|
|
53
|
+
/**
|
|
54
|
+
* Get bot traffic report from the hourly aggregated materialized view (UTC-based).
|
|
55
|
+
*
|
|
56
|
+
* Supports date_interval="day" (default, UTC daily buckets) or "hour" (UTC hourly
|
|
57
|
+
* buckets).
|
|
58
|
+
*
|
|
59
|
+
* Metrics:
|
|
60
|
+
*
|
|
61
|
+
* - count: unique bot visits
|
|
62
|
+
* - citations: unique citation events (ai_assistant bot type)
|
|
63
|
+
* - indexing: unique indexing events (index bot type)
|
|
64
|
+
* - training: unique training events (ai_training bot type)
|
|
65
|
+
* - last_visit: most recent visit timestamp
|
|
66
|
+
*
|
|
67
|
+
* Dimensions:
|
|
68
|
+
*
|
|
69
|
+
* - date, path, bot_name, bot_provider, bot_type
|
|
70
|
+
*
|
|
71
|
+
* @example
|
|
72
|
+
* ```ts
|
|
73
|
+
* const reportResponse = await client.reports.getBotsReportV2(
|
|
74
|
+
* {
|
|
75
|
+
* domain: 'domain',
|
|
76
|
+
* metrics: ['count'],
|
|
77
|
+
* start_date: '2019-12-27T18:11:19.117Z',
|
|
78
|
+
* },
|
|
79
|
+
* );
|
|
80
|
+
* ```
|
|
81
|
+
*/
|
|
82
|
+
getBotsReportV2(body: ReportGetBotsReportV2Params, options?: RequestOptions): APIPromise<ReportResponse> {
|
|
83
|
+
return this._client.post('/v2/reports/bots', { body, ...options });
|
|
84
|
+
}
|
|
85
|
+
|
|
53
86
|
/**
|
|
54
87
|
* Get referral traffic report from the daily aggregated materialized view.
|
|
55
88
|
*
|
|
@@ -73,6 +106,47 @@ export class Reports extends APIResource {
|
|
|
73
106
|
return this._client.post('/v1/reports/referrals', { body, ...options });
|
|
74
107
|
}
|
|
75
108
|
|
|
109
|
+
/**
|
|
110
|
+
* Get referral traffic report from the hourly aggregated materialized view
|
|
111
|
+
* (UTC-based).
|
|
112
|
+
*
|
|
113
|
+
* Supports date_interval="day" (default, UTC daily buckets) or "hour" (UTC hourly
|
|
114
|
+
* buckets).
|
|
115
|
+
*
|
|
116
|
+
* @example
|
|
117
|
+
* ```ts
|
|
118
|
+
* const reportResponse =
|
|
119
|
+
* await client.reports.getReferralsReportV2({
|
|
120
|
+
* domain: 'domain',
|
|
121
|
+
* metrics: ['visits'],
|
|
122
|
+
* start_date: '2019-12-27T18:11:19.117Z',
|
|
123
|
+
* });
|
|
124
|
+
* ```
|
|
125
|
+
*/
|
|
126
|
+
getReferralsReportV2(
|
|
127
|
+
body: ReportGetReferralsReportV2Params,
|
|
128
|
+
options?: RequestOptions,
|
|
129
|
+
): APIPromise<ReportResponse> {
|
|
130
|
+
return this._client.post('/v2/reports/referrals', { body, ...options });
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
/**
|
|
134
|
+
* Query Fanouts
|
|
135
|
+
*
|
|
136
|
+
* @example
|
|
137
|
+
* ```ts
|
|
138
|
+
* const reportResponse = await client.reports.queryFanouts({
|
|
139
|
+
* category_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
140
|
+
* end_date: '2019-12-27T18:11:19.117Z',
|
|
141
|
+
* metrics: ['fanouts_per_execution'],
|
|
142
|
+
* start_date: '2019-12-27T18:11:19.117Z',
|
|
143
|
+
* });
|
|
144
|
+
* ```
|
|
145
|
+
*/
|
|
146
|
+
queryFanouts(body: ReportQueryFanoutsParams, options?: RequestOptions): APIPromise<ReportResponse> {
|
|
147
|
+
return this._client.post('/v1/reports/query-fanouts', { body, ...options });
|
|
148
|
+
}
|
|
149
|
+
|
|
76
150
|
/**
|
|
77
151
|
* Get citations for a given category.
|
|
78
152
|
*
|
|
@@ -108,6 +182,17 @@ export class Reports extends APIResource {
|
|
|
108
182
|
}
|
|
109
183
|
}
|
|
110
184
|
|
|
185
|
+
/**
|
|
186
|
+
* Filter by prompt UUID.
|
|
187
|
+
*/
|
|
188
|
+
export interface PromptIDFilter {
|
|
189
|
+
field: 'prompt_id';
|
|
190
|
+
|
|
191
|
+
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
192
|
+
|
|
193
|
+
value: string | Array<string>;
|
|
194
|
+
}
|
|
195
|
+
|
|
111
196
|
/**
|
|
112
197
|
* Base model for report information.
|
|
113
198
|
*/
|
|
@@ -219,18 +304,18 @@ export interface ReportCitationsParams {
|
|
|
219
304
|
filters?: Array<
|
|
220
305
|
| ReportCitationsParams.HostnameFilter
|
|
221
306
|
| Shared.PathFilter
|
|
222
|
-
|
|
|
223
|
-
|
|
|
307
|
+
| Shared.RegionIDFilter
|
|
308
|
+
| Shared.TopicIDFilter
|
|
224
309
|
| TopicNameFilter
|
|
225
|
-
|
|
|
226
|
-
|
|
|
310
|
+
| Shared.ModelIDFilter
|
|
311
|
+
| Shared.TagIDFilter
|
|
227
312
|
| ReportCitationsParams.URLFilter
|
|
228
313
|
| ReportCitationsParams.RootDomainFilter
|
|
229
|
-
|
|
|
230
|
-
|
|
|
314
|
+
| Shared.PromptTypeFilter
|
|
315
|
+
| Shared.PersonaIDFilter
|
|
231
316
|
| ReportCitationsParams.CitationCategoryFilter
|
|
232
317
|
| Shared.PromptFilter
|
|
233
|
-
|
|
|
318
|
+
| PromptIDFilter
|
|
234
319
|
>;
|
|
235
320
|
|
|
236
321
|
/**
|
|
@@ -271,50 +356,6 @@ export namespace ReportCitationsParams {
|
|
|
271
356
|
value: string | Array<string>;
|
|
272
357
|
}
|
|
273
358
|
|
|
274
|
-
export interface ProfoundAnswerEngineInsightsFiltersRegionIDFilter {
|
|
275
|
-
/**
|
|
276
|
-
* - `region` - Deprecated
|
|
277
|
-
*/
|
|
278
|
-
field: 'region_id' | 'region';
|
|
279
|
-
|
|
280
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
281
|
-
|
|
282
|
-
value: string | Array<string>;
|
|
283
|
-
}
|
|
284
|
-
|
|
285
|
-
export interface ProfoundAnswerEngineInsightsFiltersTopicIDFilter {
|
|
286
|
-
/**
|
|
287
|
-
* - `topic` - Deprecated
|
|
288
|
-
*/
|
|
289
|
-
field: 'topic_id' | 'topic';
|
|
290
|
-
|
|
291
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
292
|
-
|
|
293
|
-
value: string | Array<string>;
|
|
294
|
-
}
|
|
295
|
-
|
|
296
|
-
export interface ProfoundAnswerEngineInsightsFiltersModelIDFilter {
|
|
297
|
-
/**
|
|
298
|
-
* - `model` - Deprecated
|
|
299
|
-
*/
|
|
300
|
-
field: 'model_id' | 'model';
|
|
301
|
-
|
|
302
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
303
|
-
|
|
304
|
-
value: string | Array<string>;
|
|
305
|
-
}
|
|
306
|
-
|
|
307
|
-
export interface ProfoundAnswerEngineInsightsFiltersTagIDFilter {
|
|
308
|
-
/**
|
|
309
|
-
* - `tag` - Deprecated
|
|
310
|
-
*/
|
|
311
|
-
field: 'tag_id' | 'tag';
|
|
312
|
-
|
|
313
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
314
|
-
|
|
315
|
-
value: string | Array<string>;
|
|
316
|
-
}
|
|
317
|
-
|
|
318
359
|
/**
|
|
319
360
|
* Filter by URL
|
|
320
361
|
*/
|
|
@@ -356,10 +397,10 @@ export namespace ReportCitationsParams {
|
|
|
356
397
|
}
|
|
357
398
|
|
|
358
399
|
/**
|
|
359
|
-
* Filter by
|
|
400
|
+
* Filter by citation category
|
|
360
401
|
*/
|
|
361
|
-
export interface
|
|
362
|
-
field: '
|
|
402
|
+
export interface CitationCategoryFilter {
|
|
403
|
+
field: 'citation_category';
|
|
363
404
|
|
|
364
405
|
operator:
|
|
365
406
|
| 'is'
|
|
@@ -372,47 +413,68 @@ export namespace ReportCitationsParams {
|
|
|
372
413
|
| 'contains_case_insensitive'
|
|
373
414
|
| 'not_contains_case_insensitive';
|
|
374
415
|
|
|
375
|
-
value:
|
|
416
|
+
value: string | Array<string>;
|
|
376
417
|
}
|
|
418
|
+
}
|
|
377
419
|
|
|
378
|
-
|
|
379
|
-
|
|
420
|
+
export interface ReportGetBotsReportParams {
|
|
421
|
+
/**
|
|
422
|
+
* Domain to query logs for.
|
|
423
|
+
*/
|
|
424
|
+
domain: string;
|
|
380
425
|
|
|
381
|
-
|
|
426
|
+
metrics: Array<'count' | 'citations' | 'indexing' | 'training' | 'last_visit'>;
|
|
382
427
|
|
|
383
|
-
|
|
384
|
-
|
|
428
|
+
/**
|
|
429
|
+
* Start date for logs. Accepts: YYYY-MM-DD, YYYY-MM-DD HH:MM, YYYY-MM-DD HH:MM:SS,
|
|
430
|
+
* or full ISO timestamp.
|
|
431
|
+
*/
|
|
432
|
+
start_date: string;
|
|
385
433
|
|
|
386
434
|
/**
|
|
387
|
-
*
|
|
435
|
+
* Date interval for the report. (only used with date dimension)
|
|
388
436
|
*/
|
|
389
|
-
|
|
390
|
-
field: 'citation_category';
|
|
437
|
+
date_interval?: 'hour' | 'day' | 'week' | 'month' | 'year' | 'relative_week';
|
|
391
438
|
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
| 'not_in'
|
|
397
|
-
| 'contains'
|
|
398
|
-
| 'not_contains'
|
|
399
|
-
| 'matches'
|
|
400
|
-
| 'contains_case_insensitive'
|
|
401
|
-
| 'not_contains_case_insensitive';
|
|
439
|
+
/**
|
|
440
|
+
* Dimensions to group the report by.
|
|
441
|
+
*/
|
|
442
|
+
dimensions?: Array<'date' | 'path' | 'bot_name' | 'bot_provider'>;
|
|
402
443
|
|
|
403
|
-
|
|
404
|
-
|
|
444
|
+
/**
|
|
445
|
+
* End date for logs. Accepts same formats as start_date. Defaults to now if
|
|
446
|
+
* omitted.
|
|
447
|
+
*/
|
|
448
|
+
end_date?: string;
|
|
405
449
|
|
|
406
|
-
|
|
407
|
-
|
|
450
|
+
/**
|
|
451
|
+
* Filters for bots report.
|
|
452
|
+
*/
|
|
453
|
+
filters?: Array<Shared.PathFilter | Shared.BotNameFilter | Shared.BotProviderFilter>;
|
|
408
454
|
|
|
409
|
-
|
|
455
|
+
/**
|
|
456
|
+
* Custom ordering of the report results.
|
|
457
|
+
*
|
|
458
|
+
* The order is a record of key-value pairs where:
|
|
459
|
+
*
|
|
460
|
+
* - key is the field to order by, which can be a metric or dimension
|
|
461
|
+
* - value is the direction of the order, either 'asc' for ascending or 'desc' for
|
|
462
|
+
* descending.
|
|
463
|
+
*
|
|
464
|
+
* When not specified, the default order is the first metric in the query
|
|
465
|
+
* descending.
|
|
466
|
+
*/
|
|
467
|
+
order_by?: { [key: string]: 'asc' | 'desc' };
|
|
410
468
|
|
|
411
|
-
|
|
412
|
-
|
|
469
|
+
organization_id?: string | null;
|
|
470
|
+
|
|
471
|
+
/**
|
|
472
|
+
* Pagination settings for the report results.
|
|
473
|
+
*/
|
|
474
|
+
pagination?: Shared.Pagination;
|
|
413
475
|
}
|
|
414
476
|
|
|
415
|
-
export interface
|
|
477
|
+
export interface ReportGetBotsReportV2Params {
|
|
416
478
|
/**
|
|
417
479
|
* Domain to query logs for.
|
|
418
480
|
*/
|
|
@@ -434,10 +496,10 @@ export interface ReportGetBotsReportParams {
|
|
|
434
496
|
/**
|
|
435
497
|
* Dimensions to group the report by.
|
|
436
498
|
*/
|
|
437
|
-
dimensions?: Array<'date' | 'path' | 'bot_name' | 'bot_provider'>;
|
|
499
|
+
dimensions?: Array<'date' | 'hour' | 'path' | 'bot_name' | 'bot_provider' | 'bot_type'>;
|
|
438
500
|
|
|
439
501
|
/**
|
|
440
|
-
* End date
|
|
502
|
+
* End date in UTC. Accepts same formats as start_date. Defaults to now UTC if
|
|
441
503
|
* omitted.
|
|
442
504
|
*/
|
|
443
505
|
end_date?: string;
|
|
@@ -446,7 +508,10 @@ export interface ReportGetBotsReportParams {
|
|
|
446
508
|
* Filters for bots report.
|
|
447
509
|
*/
|
|
448
510
|
filters?: Array<
|
|
449
|
-
Shared.PathFilter
|
|
511
|
+
| Shared.PathFilter
|
|
512
|
+
| Shared.BotNameFilter
|
|
513
|
+
| Shared.BotProviderFilter
|
|
514
|
+
| ReportGetBotsReportV2Params.BotTypeFilter
|
|
450
515
|
>;
|
|
451
516
|
|
|
452
517
|
/**
|
|
@@ -471,12 +536,12 @@ export interface ReportGetBotsReportParams {
|
|
|
471
536
|
pagination?: Shared.Pagination;
|
|
472
537
|
}
|
|
473
538
|
|
|
474
|
-
export namespace
|
|
539
|
+
export namespace ReportGetBotsReportV2Params {
|
|
475
540
|
/**
|
|
476
|
-
* Filter by
|
|
541
|
+
* Filter by bot_type column (v2 hourly table only)
|
|
477
542
|
*/
|
|
478
|
-
export interface
|
|
479
|
-
field: '
|
|
543
|
+
export interface BotTypeFilter {
|
|
544
|
+
field: 'bot_type';
|
|
480
545
|
|
|
481
546
|
operator:
|
|
482
547
|
| 'is'
|
|
@@ -490,73 +555,77 @@ export namespace ReportGetBotsReportParams {
|
|
|
490
555
|
| 'not_contains_case_insensitive';
|
|
491
556
|
|
|
492
557
|
value:
|
|
493
|
-
| '
|
|
494
|
-
| '
|
|
495
|
-
| '
|
|
496
|
-
| '
|
|
497
|
-
| '
|
|
498
|
-
| 'Applebot-Extended'
|
|
499
|
-
| 'Bytespider'
|
|
500
|
-
| 'DeepSeek'
|
|
501
|
-
| 'DuckAssistBot'
|
|
502
|
-
| 'DuckDuckBot'
|
|
503
|
-
| 'Googlebot'
|
|
504
|
-
| 'Googlebot-News'
|
|
505
|
-
| 'Googlebot-Video'
|
|
506
|
-
| 'Googlebot-Image'
|
|
507
|
-
| 'Google-Extended'
|
|
508
|
-
| 'Storebot-Google'
|
|
509
|
-
| 'Google-CloudVertexBot'
|
|
510
|
-
| 'meta-externalfetcher'
|
|
511
|
-
| 'meta-externalagent'
|
|
512
|
-
| 'bingbot'
|
|
513
|
-
| 'MicrosoftPreview'
|
|
514
|
-
| 'ChatGPT-User'
|
|
515
|
-
| 'GPTBot'
|
|
516
|
-
| 'OAI-SearchBot'
|
|
517
|
-
| 'OAI-Operator'
|
|
518
|
-
| 'PerplexityBot'
|
|
519
|
-
| 'Perplexity-User'
|
|
520
|
-
| 'Grok-PageBrowser'
|
|
521
|
-
| 'YouBot'
|
|
522
|
-
| Array<
|
|
523
|
-
| 'Amazonbot'
|
|
524
|
-
| 'ClaudeBot'
|
|
525
|
-
| 'Claude-User'
|
|
526
|
-
| 'Claude-SearchBot'
|
|
527
|
-
| 'Applebot'
|
|
528
|
-
| 'Applebot-Extended'
|
|
529
|
-
| 'Bytespider'
|
|
530
|
-
| 'DeepSeek'
|
|
531
|
-
| 'DuckAssistBot'
|
|
532
|
-
| 'DuckDuckBot'
|
|
533
|
-
| 'Googlebot'
|
|
534
|
-
| 'Googlebot-News'
|
|
535
|
-
| 'Googlebot-Video'
|
|
536
|
-
| 'Googlebot-Image'
|
|
537
|
-
| 'Google-Extended'
|
|
538
|
-
| 'Storebot-Google'
|
|
539
|
-
| 'Google-CloudVertexBot'
|
|
540
|
-
| 'meta-externalfetcher'
|
|
541
|
-
| 'meta-externalagent'
|
|
542
|
-
| 'bingbot'
|
|
543
|
-
| 'MicrosoftPreview'
|
|
544
|
-
| 'ChatGPT-User'
|
|
545
|
-
| 'GPTBot'
|
|
546
|
-
| 'OAI-SearchBot'
|
|
547
|
-
| 'OAI-Operator'
|
|
548
|
-
| 'PerplexityBot'
|
|
549
|
-
| 'Perplexity-User'
|
|
550
|
-
| 'Grok-PageBrowser'
|
|
551
|
-
| 'YouBot'
|
|
552
|
-
>;
|
|
558
|
+
| 'ai_assistant'
|
|
559
|
+
| 'ai_training'
|
|
560
|
+
| 'index'
|
|
561
|
+
| 'ai_agent'
|
|
562
|
+
| Array<'ai_assistant' | 'ai_training' | 'index' | 'ai_agent'>;
|
|
553
563
|
}
|
|
564
|
+
}
|
|
565
|
+
|
|
566
|
+
export interface ReportGetReferralsReportParams {
|
|
567
|
+
/**
|
|
568
|
+
* Domain to query logs for.
|
|
569
|
+
*/
|
|
570
|
+
domain: string;
|
|
571
|
+
|
|
572
|
+
metrics: Array<'visits' | 'last_visit'>;
|
|
573
|
+
|
|
574
|
+
/**
|
|
575
|
+
* Start date for logs. Accepts: YYYY-MM-DD, YYYY-MM-DD HH:MM, YYYY-MM-DD HH:MM:SS,
|
|
576
|
+
* or full ISO timestamp.
|
|
577
|
+
*/
|
|
578
|
+
start_date: string;
|
|
554
579
|
|
|
555
580
|
/**
|
|
556
|
-
*
|
|
581
|
+
* Date interval for the report. (only used with date dimension)
|
|
557
582
|
*/
|
|
558
|
-
|
|
559
|
-
|
|
583
|
+
date_interval?: 'hour' | 'day' | 'week' | 'month' | 'year' | 'relative_week';
|
|
584
|
+
|
|
585
|
+
/**
|
|
586
|
+
* Dimensions to group the report by.
|
|
587
|
+
*/
|
|
588
|
+
dimensions?: Array<'date' | 'path' | 'referral_source'>;
|
|
589
|
+
|
|
590
|
+
/**
|
|
591
|
+
* End date for logs. Accepts same formats as start_date. Defaults to now if
|
|
592
|
+
* omitted.
|
|
593
|
+
*/
|
|
594
|
+
end_date?: string;
|
|
595
|
+
|
|
596
|
+
/**
|
|
597
|
+
* Filters for referrals report.
|
|
598
|
+
*/
|
|
599
|
+
filters?: Array<Shared.PathFilter | ReportGetReferralsReportParams.ReferralSourceFilter>;
|
|
600
|
+
|
|
601
|
+
/**
|
|
602
|
+
* Custom ordering of the report results.
|
|
603
|
+
*
|
|
604
|
+
* The order is a record of key-value pairs where:
|
|
605
|
+
*
|
|
606
|
+
* - key is the field to order by, which can be a metric or dimension
|
|
607
|
+
* - value is the direction of the order, either 'asc' for ascending or 'desc' for
|
|
608
|
+
* descending.
|
|
609
|
+
*
|
|
610
|
+
* When not specified, the default order is the first metric in the query
|
|
611
|
+
* descending.
|
|
612
|
+
*/
|
|
613
|
+
order_by?: { [key: string]: 'asc' | 'desc' };
|
|
614
|
+
|
|
615
|
+
organization_id?: string | null;
|
|
616
|
+
|
|
617
|
+
/**
|
|
618
|
+
* Pagination settings for the report results.
|
|
619
|
+
*/
|
|
620
|
+
pagination?: Shared.Pagination;
|
|
621
|
+
}
|
|
622
|
+
|
|
623
|
+
export namespace ReportGetReferralsReportParams {
|
|
624
|
+
/**
|
|
625
|
+
* Filter by referral source
|
|
626
|
+
*/
|
|
627
|
+
export interface ReferralSourceFilter {
|
|
628
|
+
field: 'referral_source';
|
|
560
629
|
|
|
561
630
|
operator:
|
|
562
631
|
| 'is'
|
|
@@ -571,43 +640,33 @@ export namespace ReportGetBotsReportParams {
|
|
|
571
640
|
|
|
572
641
|
value:
|
|
573
642
|
| 'openai'
|
|
643
|
+
| 'none'
|
|
574
644
|
| 'anthropic'
|
|
575
|
-
| 'chatgpt'
|
|
576
645
|
| 'deepseek'
|
|
577
|
-
| 'google'
|
|
578
|
-
| 'microsoft'
|
|
579
646
|
| 'perplexity'
|
|
580
|
-
| 'apple'
|
|
581
|
-
| 'bytedance'
|
|
582
|
-
| 'amazon'
|
|
583
|
-
| 'meta'
|
|
584
|
-
| 'duckduckgo'
|
|
585
647
|
| 'you'
|
|
586
|
-
| 'xai'
|
|
587
648
|
| 'grok'
|
|
649
|
+
| 'microsoft'
|
|
588
650
|
| 'gemini'
|
|
651
|
+
| 'internal'
|
|
652
|
+
| 'other'
|
|
589
653
|
| Array<
|
|
590
654
|
| 'openai'
|
|
655
|
+
| 'none'
|
|
591
656
|
| 'anthropic'
|
|
592
|
-
| 'chatgpt'
|
|
593
657
|
| 'deepseek'
|
|
594
|
-
| 'google'
|
|
595
|
-
| 'microsoft'
|
|
596
658
|
| 'perplexity'
|
|
597
|
-
| 'apple'
|
|
598
|
-
| 'bytedance'
|
|
599
|
-
| 'amazon'
|
|
600
|
-
| 'meta'
|
|
601
|
-
| 'duckduckgo'
|
|
602
659
|
| 'you'
|
|
603
|
-
| 'xai'
|
|
604
660
|
| 'grok'
|
|
661
|
+
| 'microsoft'
|
|
605
662
|
| 'gemini'
|
|
663
|
+
| 'internal'
|
|
664
|
+
| 'other'
|
|
606
665
|
>;
|
|
607
666
|
}
|
|
608
667
|
}
|
|
609
668
|
|
|
610
|
-
export interface
|
|
669
|
+
export interface ReportGetReferralsReportV2Params {
|
|
611
670
|
/**
|
|
612
671
|
* Domain to query logs for.
|
|
613
672
|
*/
|
|
@@ -629,10 +688,10 @@ export interface ReportGetReferralsReportParams {
|
|
|
629
688
|
/**
|
|
630
689
|
* Dimensions to group the report by.
|
|
631
690
|
*/
|
|
632
|
-
dimensions?: Array<'date' | 'path' | 'referral_source'>;
|
|
691
|
+
dimensions?: Array<'date' | 'hour' | 'path' | 'referral_source' | 'referral_type'>;
|
|
633
692
|
|
|
634
693
|
/**
|
|
635
|
-
* End date
|
|
694
|
+
* End date in UTC. Accepts same formats as start_date. Defaults to now UTC if
|
|
636
695
|
* omitted.
|
|
637
696
|
*/
|
|
638
697
|
end_date?: string;
|
|
@@ -640,7 +699,11 @@ export interface ReportGetReferralsReportParams {
|
|
|
640
699
|
/**
|
|
641
700
|
* Filters for referrals report.
|
|
642
701
|
*/
|
|
643
|
-
filters?: Array<
|
|
702
|
+
filters?: Array<
|
|
703
|
+
| Shared.PathFilter
|
|
704
|
+
| ReportGetReferralsReportV2Params.ReferralSourceFilter
|
|
705
|
+
| ReportGetReferralsReportV2Params.ReferralTypeFilter
|
|
706
|
+
>;
|
|
644
707
|
|
|
645
708
|
/**
|
|
646
709
|
* Custom ordering of the report results.
|
|
@@ -664,7 +727,7 @@ export interface ReportGetReferralsReportParams {
|
|
|
664
727
|
pagination?: Shared.Pagination;
|
|
665
728
|
}
|
|
666
729
|
|
|
667
|
-
export namespace
|
|
730
|
+
export namespace ReportGetReferralsReportV2Params {
|
|
668
731
|
/**
|
|
669
732
|
* Filter by referral source
|
|
670
733
|
*/
|
|
@@ -708,6 +771,76 @@ export namespace ReportGetReferralsReportParams {
|
|
|
708
771
|
| 'other'
|
|
709
772
|
>;
|
|
710
773
|
}
|
|
774
|
+
|
|
775
|
+
/**
|
|
776
|
+
* Filter by referral type
|
|
777
|
+
*/
|
|
778
|
+
export interface ReferralTypeFilter {
|
|
779
|
+
field: 'referral_type';
|
|
780
|
+
|
|
781
|
+
operator:
|
|
782
|
+
| 'is'
|
|
783
|
+
| 'not_is'
|
|
784
|
+
| 'in'
|
|
785
|
+
| 'not_in'
|
|
786
|
+
| 'contains'
|
|
787
|
+
| 'not_contains'
|
|
788
|
+
| 'matches'
|
|
789
|
+
| 'contains_case_insensitive'
|
|
790
|
+
| 'not_contains_case_insensitive';
|
|
791
|
+
|
|
792
|
+
value: 'internal' | 'referer' | 'utm' | 'none' | Array<'internal' | 'referer' | 'utm' | 'none'>;
|
|
793
|
+
}
|
|
794
|
+
}
|
|
795
|
+
|
|
796
|
+
export interface ReportQueryFanoutsParams {
|
|
797
|
+
category_id: string;
|
|
798
|
+
|
|
799
|
+
/**
|
|
800
|
+
* End date. Accepts YYYY-MM-DD, YYYY-MM-DD HH:MM, or ISO timestamp.
|
|
801
|
+
*/
|
|
802
|
+
end_date: string;
|
|
803
|
+
|
|
804
|
+
metrics: Array<'fanouts_per_execution' | 'total_fanouts' | 'share'>;
|
|
805
|
+
|
|
806
|
+
/**
|
|
807
|
+
* Start date. Accepts YYYY-MM-DD, YYYY-MM-DD HH:MM, or ISO timestamp.
|
|
808
|
+
*/
|
|
809
|
+
start_date: string;
|
|
810
|
+
|
|
811
|
+
/**
|
|
812
|
+
* Date interval for the report. (only used with date dimension)
|
|
813
|
+
*/
|
|
814
|
+
date_interval?: 'hour' | 'day' | 'week' | 'month' | 'year' | 'relative_week';
|
|
815
|
+
|
|
816
|
+
/**
|
|
817
|
+
* Dimensions to group the report by.
|
|
818
|
+
*/
|
|
819
|
+
dimensions?: Array<'prompt' | 'query' | 'model' | 'region' | 'date'>;
|
|
820
|
+
|
|
821
|
+
/**
|
|
822
|
+
* Filters to apply to the query fanout report.
|
|
823
|
+
*/
|
|
824
|
+
filters?: Array<
|
|
825
|
+
| Shared.RegionIDFilter
|
|
826
|
+
| Shared.ModelIDFilter
|
|
827
|
+
| Shared.TopicIDFilter
|
|
828
|
+
| Shared.TagIDFilter
|
|
829
|
+
| PromptIDFilter
|
|
830
|
+
| Shared.PersonaIDFilter
|
|
831
|
+
| Shared.PromptTypeFilter
|
|
832
|
+
>;
|
|
833
|
+
|
|
834
|
+
/**
|
|
835
|
+
* Custom ordering. Keys must be a requested metric or the `date` dimension. Values
|
|
836
|
+
* are `asc` or `desc`. Defaults to first metric descending.
|
|
837
|
+
*/
|
|
838
|
+
order_by?: { [key: string]: 'asc' | 'desc' };
|
|
839
|
+
|
|
840
|
+
/**
|
|
841
|
+
* Pagination settings for the report results.
|
|
842
|
+
*/
|
|
843
|
+
pagination?: Shared.Pagination;
|
|
711
844
|
}
|
|
712
845
|
|
|
713
846
|
export interface ReportSentimentParams {
|
|
@@ -758,13 +891,13 @@ export interface ReportSentimentParams {
|
|
|
758
891
|
| ReportSentimentParams.AssetIDFilter
|
|
759
892
|
| Shared.AssetNameFilter
|
|
760
893
|
| ReportSentimentParams.ThemeFilter
|
|
761
|
-
|
|
|
762
|
-
|
|
|
894
|
+
| Shared.RegionIDFilter
|
|
895
|
+
| Shared.TopicIDFilter
|
|
763
896
|
| TopicNameFilter
|
|
764
|
-
|
|
|
765
|
-
|
|
|
897
|
+
| Shared.ModelIDFilter
|
|
898
|
+
| Shared.TagIDFilter
|
|
766
899
|
| Shared.PromptFilter
|
|
767
|
-
|
|
|
900
|
+
| Shared.PersonaIDFilter
|
|
768
901
|
>;
|
|
769
902
|
|
|
770
903
|
/**
|
|
@@ -815,58 +948,6 @@ export namespace ReportSentimentParams {
|
|
|
815
948
|
|
|
816
949
|
value: string | Array<string>;
|
|
817
950
|
}
|
|
818
|
-
|
|
819
|
-
export interface ProfoundAnswerEngineInsightsFiltersRegionIDFilter {
|
|
820
|
-
/**
|
|
821
|
-
* - `region` - Deprecated
|
|
822
|
-
*/
|
|
823
|
-
field: 'region_id' | 'region';
|
|
824
|
-
|
|
825
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
826
|
-
|
|
827
|
-
value: string | Array<string>;
|
|
828
|
-
}
|
|
829
|
-
|
|
830
|
-
export interface ProfoundAnswerEngineInsightsFiltersTopicIDFilter {
|
|
831
|
-
/**
|
|
832
|
-
* - `topic` - Deprecated
|
|
833
|
-
*/
|
|
834
|
-
field: 'topic_id' | 'topic';
|
|
835
|
-
|
|
836
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
837
|
-
|
|
838
|
-
value: string | Array<string>;
|
|
839
|
-
}
|
|
840
|
-
|
|
841
|
-
export interface ProfoundAnswerEngineInsightsFiltersModelIDFilter {
|
|
842
|
-
/**
|
|
843
|
-
* - `model` - Deprecated
|
|
844
|
-
*/
|
|
845
|
-
field: 'model_id' | 'model';
|
|
846
|
-
|
|
847
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
848
|
-
|
|
849
|
-
value: string | Array<string>;
|
|
850
|
-
}
|
|
851
|
-
|
|
852
|
-
export interface ProfoundAnswerEngineInsightsFiltersTagIDFilter {
|
|
853
|
-
/**
|
|
854
|
-
* - `tag` - Deprecated
|
|
855
|
-
*/
|
|
856
|
-
field: 'tag_id' | 'tag';
|
|
857
|
-
|
|
858
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
859
|
-
|
|
860
|
-
value: string | Array<string>;
|
|
861
|
-
}
|
|
862
|
-
|
|
863
|
-
export interface ProfoundAnswerEngineInsightsFiltersPersonaIDFilter {
|
|
864
|
-
field: 'persona_id';
|
|
865
|
-
|
|
866
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
867
|
-
|
|
868
|
-
value: string | Array<string>;
|
|
869
|
-
}
|
|
870
951
|
}
|
|
871
952
|
|
|
872
953
|
export interface ReportVisibilityParams {
|
|
@@ -914,15 +995,15 @@ export interface ReportVisibilityParams {
|
|
|
914
995
|
* List of filters to apply to the visibility report.
|
|
915
996
|
*/
|
|
916
997
|
filters?: Array<
|
|
917
|
-
|
|
|
918
|
-
|
|
|
919
|
-
|
|
|
998
|
+
| Shared.RegionIDFilter
|
|
999
|
+
| Shared.ModelIDFilter
|
|
1000
|
+
| Shared.TopicIDFilter
|
|
920
1001
|
| TopicNameFilter
|
|
921
1002
|
| Shared.AssetNameFilter
|
|
922
|
-
|
|
|
923
|
-
|
|
|
1003
|
+
| Shared.TagIDFilter
|
|
1004
|
+
| PromptIDFilter
|
|
924
1005
|
| Shared.PromptFilter
|
|
925
|
-
|
|
|
1006
|
+
| Shared.PersonaIDFilter
|
|
926
1007
|
>;
|
|
927
1008
|
|
|
928
1009
|
/**
|
|
@@ -945,70 +1026,9 @@ export interface ReportVisibilityParams {
|
|
|
945
1026
|
pagination?: Shared.Pagination;
|
|
946
1027
|
}
|
|
947
1028
|
|
|
948
|
-
export namespace ReportVisibilityParams {
|
|
949
|
-
export interface ProfoundAnswerEngineInsightsFiltersRegionIDFilter {
|
|
950
|
-
/**
|
|
951
|
-
* - `region` - Deprecated
|
|
952
|
-
*/
|
|
953
|
-
field: 'region_id' | 'region';
|
|
954
|
-
|
|
955
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
956
|
-
|
|
957
|
-
value: string | Array<string>;
|
|
958
|
-
}
|
|
959
|
-
|
|
960
|
-
export interface ProfoundAnswerEngineInsightsFiltersModelIDFilter {
|
|
961
|
-
/**
|
|
962
|
-
* - `model` - Deprecated
|
|
963
|
-
*/
|
|
964
|
-
field: 'model_id' | 'model';
|
|
965
|
-
|
|
966
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
967
|
-
|
|
968
|
-
value: string | Array<string>;
|
|
969
|
-
}
|
|
970
|
-
|
|
971
|
-
export interface ProfoundAnswerEngineInsightsFiltersTopicIDFilter {
|
|
972
|
-
/**
|
|
973
|
-
* - `topic` - Deprecated
|
|
974
|
-
*/
|
|
975
|
-
field: 'topic_id' | 'topic';
|
|
976
|
-
|
|
977
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
978
|
-
|
|
979
|
-
value: string | Array<string>;
|
|
980
|
-
}
|
|
981
|
-
|
|
982
|
-
export interface ProfoundAnswerEngineInsightsFiltersTagIDFilter {
|
|
983
|
-
/**
|
|
984
|
-
* - `tag` - Deprecated
|
|
985
|
-
*/
|
|
986
|
-
field: 'tag_id' | 'tag';
|
|
987
|
-
|
|
988
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
989
|
-
|
|
990
|
-
value: string | Array<string>;
|
|
991
|
-
}
|
|
992
|
-
|
|
993
|
-
export interface ProfoundAnswerEngineInsightsFiltersPromptIDFilter {
|
|
994
|
-
field: 'prompt_id';
|
|
995
|
-
|
|
996
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
997
|
-
|
|
998
|
-
value: string | Array<string>;
|
|
999
|
-
}
|
|
1000
|
-
|
|
1001
|
-
export interface ProfoundAnswerEngineInsightsFiltersPersonaIDFilter {
|
|
1002
|
-
field: 'persona_id';
|
|
1003
|
-
|
|
1004
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
1005
|
-
|
|
1006
|
-
value: string | Array<string>;
|
|
1007
|
-
}
|
|
1008
|
-
}
|
|
1009
|
-
|
|
1010
1029
|
export declare namespace Reports {
|
|
1011
1030
|
export {
|
|
1031
|
+
type PromptIDFilter as PromptIDFilter,
|
|
1012
1032
|
type ReportInfo as ReportInfo,
|
|
1013
1033
|
type ReportResponse as ReportResponse,
|
|
1014
1034
|
type ReportResult as ReportResult,
|
|
@@ -1016,7 +1036,10 @@ export declare namespace Reports {
|
|
|
1016
1036
|
type ReportCitationsResponse as ReportCitationsResponse,
|
|
1017
1037
|
type ReportCitationsParams as ReportCitationsParams,
|
|
1018
1038
|
type ReportGetBotsReportParams as ReportGetBotsReportParams,
|
|
1039
|
+
type ReportGetBotsReportV2Params as ReportGetBotsReportV2Params,
|
|
1019
1040
|
type ReportGetReferralsReportParams as ReportGetReferralsReportParams,
|
|
1041
|
+
type ReportGetReferralsReportV2Params as ReportGetReferralsReportV2Params,
|
|
1042
|
+
type ReportQueryFanoutsParams as ReportQueryFanoutsParams,
|
|
1020
1043
|
type ReportSentimentParams as ReportSentimentParams,
|
|
1021
1044
|
type ReportVisibilityParams as ReportVisibilityParams,
|
|
1022
1045
|
};
|