profoundai 0.35.1 → 0.37.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 +48 -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/organizations/categories.d.mts +40 -3
- package/resources/organizations/categories.d.mts.map +1 -1
- package/resources/organizations/categories.d.ts +40 -3
- package/resources/organizations/categories.d.ts.map +1 -1
- package/resources/organizations/categories.js +4 -3
- package/resources/organizations/categories.js.map +1 -1
- package/resources/organizations/categories.mjs +4 -3
- package/resources/organizations/categories.mjs.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 +247 -139
- package/resources/reports.d.mts.map +1 -1
- package/resources/reports.d.ts +247 -139
- 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/organizations/categories.ts +46 -3
- package/src/resources/prompt-volumes.ts +203 -0
- package/src/resources/prompts.ts +6 -78
- package/src/resources/reports.ts +368 -280
- 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,19 @@ 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
|
|
312
|
+
| ReportCitationsParams.TagNameFilter
|
|
227
313
|
| ReportCitationsParams.URLFilter
|
|
228
314
|
| ReportCitationsParams.RootDomainFilter
|
|
229
|
-
|
|
|
230
|
-
|
|
|
315
|
+
| Shared.PromptTypeFilter
|
|
316
|
+
| Shared.PersonaIDFilter
|
|
231
317
|
| ReportCitationsParams.CitationCategoryFilter
|
|
232
318
|
| Shared.PromptFilter
|
|
233
|
-
|
|
|
319
|
+
| PromptIDFilter
|
|
234
320
|
>;
|
|
235
321
|
|
|
236
322
|
/**
|
|
@@ -271,55 +357,11 @@ export namespace ReportCitationsParams {
|
|
|
271
357
|
value: string | Array<string>;
|
|
272
358
|
}
|
|
273
359
|
|
|
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
360
|
/**
|
|
319
|
-
* Filter by
|
|
361
|
+
* Filter by tag name.
|
|
320
362
|
*/
|
|
321
|
-
export interface
|
|
322
|
-
field: '
|
|
363
|
+
export interface TagNameFilter {
|
|
364
|
+
field: 'tag_name';
|
|
323
365
|
|
|
324
366
|
operator:
|
|
325
367
|
| 'is'
|
|
@@ -336,10 +378,10 @@ export namespace ReportCitationsParams {
|
|
|
336
378
|
}
|
|
337
379
|
|
|
338
380
|
/**
|
|
339
|
-
* Filter by
|
|
381
|
+
* Filter by URL
|
|
340
382
|
*/
|
|
341
|
-
export interface
|
|
342
|
-
field: '
|
|
383
|
+
export interface URLFilter {
|
|
384
|
+
field: 'url';
|
|
343
385
|
|
|
344
386
|
operator:
|
|
345
387
|
| 'is'
|
|
@@ -356,10 +398,10 @@ export namespace ReportCitationsParams {
|
|
|
356
398
|
}
|
|
357
399
|
|
|
358
400
|
/**
|
|
359
|
-
* Filter by
|
|
401
|
+
* Filter by root domain
|
|
360
402
|
*/
|
|
361
|
-
export interface
|
|
362
|
-
field: '
|
|
403
|
+
export interface RootDomainFilter {
|
|
404
|
+
field: 'root_domain';
|
|
363
405
|
|
|
364
406
|
operator:
|
|
365
407
|
| 'is'
|
|
@@ -372,14 +414,6 @@ export namespace ReportCitationsParams {
|
|
|
372
414
|
| 'contains_case_insensitive'
|
|
373
415
|
| 'not_contains_case_insensitive';
|
|
374
416
|
|
|
375
|
-
value: 'visibility' | 'sentiment' | Array<'visibility' | 'sentiment'>;
|
|
376
|
-
}
|
|
377
|
-
|
|
378
|
-
export interface ProfoundAnswerEngineInsightsFiltersPersonaIDFilter {
|
|
379
|
-
field: 'persona_id';
|
|
380
|
-
|
|
381
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
382
|
-
|
|
383
417
|
value: string | Array<string>;
|
|
384
418
|
}
|
|
385
419
|
|
|
@@ -402,14 +436,6 @@ export namespace ReportCitationsParams {
|
|
|
402
436
|
|
|
403
437
|
value: string | Array<string>;
|
|
404
438
|
}
|
|
405
|
-
|
|
406
|
-
export interface ProfoundAnswerEngineInsightsFiltersPromptIDFilter {
|
|
407
|
-
field: 'prompt_id';
|
|
408
|
-
|
|
409
|
-
operator: 'is' | 'not_is' | 'in' | 'not_in';
|
|
410
|
-
|
|
411
|
-
value: string | Array<string>;
|
|
412
|
-
}
|
|
413
439
|
}
|
|
414
440
|
|
|
415
441
|
export interface ReportGetBotsReportParams {
|
|
@@ -442,11 +468,71 @@ export interface ReportGetBotsReportParams {
|
|
|
442
468
|
*/
|
|
443
469
|
end_date?: string;
|
|
444
470
|
|
|
471
|
+
/**
|
|
472
|
+
* Filters for bots report.
|
|
473
|
+
*/
|
|
474
|
+
filters?: Array<Shared.PathFilter | Shared.BotNameFilter | Shared.BotProviderFilter>;
|
|
475
|
+
|
|
476
|
+
/**
|
|
477
|
+
* Custom ordering of the report results.
|
|
478
|
+
*
|
|
479
|
+
* The order is a record of key-value pairs where:
|
|
480
|
+
*
|
|
481
|
+
* - key is the field to order by, which can be a metric or dimension
|
|
482
|
+
* - value is the direction of the order, either 'asc' for ascending or 'desc' for
|
|
483
|
+
* descending.
|
|
484
|
+
*
|
|
485
|
+
* When not specified, the default order is the first metric in the query
|
|
486
|
+
* descending.
|
|
487
|
+
*/
|
|
488
|
+
order_by?: { [key: string]: 'asc' | 'desc' };
|
|
489
|
+
|
|
490
|
+
organization_id?: string | null;
|
|
491
|
+
|
|
492
|
+
/**
|
|
493
|
+
* Pagination settings for the report results.
|
|
494
|
+
*/
|
|
495
|
+
pagination?: Shared.Pagination;
|
|
496
|
+
}
|
|
497
|
+
|
|
498
|
+
export interface ReportGetBotsReportV2Params {
|
|
499
|
+
/**
|
|
500
|
+
* Domain to query logs for.
|
|
501
|
+
*/
|
|
502
|
+
domain: string;
|
|
503
|
+
|
|
504
|
+
metrics: Array<'count' | 'citations' | 'indexing' | 'training' | 'last_visit'>;
|
|
505
|
+
|
|
506
|
+
/**
|
|
507
|
+
* Start date for logs. Accepts: YYYY-MM-DD, YYYY-MM-DD HH:MM, YYYY-MM-DD HH:MM:SS,
|
|
508
|
+
* or full ISO timestamp.
|
|
509
|
+
*/
|
|
510
|
+
start_date: string;
|
|
511
|
+
|
|
512
|
+
/**
|
|
513
|
+
* Date interval for the report. (only used with date dimension)
|
|
514
|
+
*/
|
|
515
|
+
date_interval?: 'hour' | 'day' | 'week' | 'month' | 'year' | 'relative_week';
|
|
516
|
+
|
|
517
|
+
/**
|
|
518
|
+
* Dimensions to group the report by.
|
|
519
|
+
*/
|
|
520
|
+
dimensions?: Array<'date' | 'hour' | 'path' | 'bot_name' | 'bot_provider' | 'bot_type'>;
|
|
521
|
+
|
|
522
|
+
/**
|
|
523
|
+
* End date in UTC. Accepts same formats as start_date. Defaults to now UTC if
|
|
524
|
+
* omitted.
|
|
525
|
+
*/
|
|
526
|
+
end_date?: string;
|
|
527
|
+
|
|
445
528
|
/**
|
|
446
529
|
* Filters for bots report.
|
|
447
530
|
*/
|
|
448
531
|
filters?: Array<
|
|
449
|
-
Shared.PathFilter
|
|
532
|
+
| Shared.PathFilter
|
|
533
|
+
| Shared.BotNameFilter
|
|
534
|
+
| Shared.BotProviderFilter
|
|
535
|
+
| ReportGetBotsReportV2Params.BotTypeFilter
|
|
450
536
|
>;
|
|
451
537
|
|
|
452
538
|
/**
|
|
@@ -471,12 +557,12 @@ export interface ReportGetBotsReportParams {
|
|
|
471
557
|
pagination?: Shared.Pagination;
|
|
472
558
|
}
|
|
473
559
|
|
|
474
|
-
export namespace
|
|
560
|
+
export namespace ReportGetBotsReportV2Params {
|
|
475
561
|
/**
|
|
476
|
-
* Filter by
|
|
562
|
+
* Filter by bot_type column (v2 hourly table only)
|
|
477
563
|
*/
|
|
478
|
-
export interface
|
|
479
|
-
field: '
|
|
564
|
+
export interface BotTypeFilter {
|
|
565
|
+
field: 'bot_type';
|
|
480
566
|
|
|
481
567
|
operator:
|
|
482
568
|
| 'is'
|
|
@@ -490,73 +576,77 @@ export namespace ReportGetBotsReportParams {
|
|
|
490
576
|
| 'not_contains_case_insensitive';
|
|
491
577
|
|
|
492
578
|
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
|
-
>;
|
|
579
|
+
| 'ai_assistant'
|
|
580
|
+
| 'ai_training'
|
|
581
|
+
| 'index'
|
|
582
|
+
| 'ai_agent'
|
|
583
|
+
| Array<'ai_assistant' | 'ai_training' | 'index' | 'ai_agent'>;
|
|
553
584
|
}
|
|
585
|
+
}
|
|
586
|
+
|
|
587
|
+
export interface ReportGetReferralsReportParams {
|
|
588
|
+
/**
|
|
589
|
+
* Domain to query logs for.
|
|
590
|
+
*/
|
|
591
|
+
domain: string;
|
|
592
|
+
|
|
593
|
+
metrics: Array<'visits' | 'last_visit'>;
|
|
594
|
+
|
|
595
|
+
/**
|
|
596
|
+
* Start date for logs. Accepts: YYYY-MM-DD, YYYY-MM-DD HH:MM, YYYY-MM-DD HH:MM:SS,
|
|
597
|
+
* or full ISO timestamp.
|
|
598
|
+
*/
|
|
599
|
+
start_date: string;
|
|
554
600
|
|
|
555
601
|
/**
|
|
556
|
-
*
|
|
602
|
+
* Date interval for the report. (only used with date dimension)
|
|
557
603
|
*/
|
|
558
|
-
|
|
559
|
-
|
|
604
|
+
date_interval?: 'hour' | 'day' | 'week' | 'month' | 'year' | 'relative_week';
|
|
605
|
+
|
|
606
|
+
/**
|
|
607
|
+
* Dimensions to group the report by.
|
|
608
|
+
*/
|
|
609
|
+
dimensions?: Array<'date' | 'path' | 'referral_source'>;
|
|
610
|
+
|
|
611
|
+
/**
|
|
612
|
+
* End date for logs. Accepts same formats as start_date. Defaults to now if
|
|
613
|
+
* omitted.
|
|
614
|
+
*/
|
|
615
|
+
end_date?: string;
|
|
616
|
+
|
|
617
|
+
/**
|
|
618
|
+
* Filters for referrals report.
|
|
619
|
+
*/
|
|
620
|
+
filters?: Array<Shared.PathFilter | ReportGetReferralsReportParams.ReferralSourceFilter>;
|
|
621
|
+
|
|
622
|
+
/**
|
|
623
|
+
* Custom ordering of the report results.
|
|
624
|
+
*
|
|
625
|
+
* The order is a record of key-value pairs where:
|
|
626
|
+
*
|
|
627
|
+
* - key is the field to order by, which can be a metric or dimension
|
|
628
|
+
* - value is the direction of the order, either 'asc' for ascending or 'desc' for
|
|
629
|
+
* descending.
|
|
630
|
+
*
|
|
631
|
+
* When not specified, the default order is the first metric in the query
|
|
632
|
+
* descending.
|
|
633
|
+
*/
|
|
634
|
+
order_by?: { [key: string]: 'asc' | 'desc' };
|
|
635
|
+
|
|
636
|
+
organization_id?: string | null;
|
|
637
|
+
|
|
638
|
+
/**
|
|
639
|
+
* Pagination settings for the report results.
|
|
640
|
+
*/
|
|
641
|
+
pagination?: Shared.Pagination;
|
|
642
|
+
}
|
|
643
|
+
|
|
644
|
+
export namespace ReportGetReferralsReportParams {
|
|
645
|
+
/**
|
|
646
|
+
* Filter by referral source
|
|
647
|
+
*/
|
|
648
|
+
export interface ReferralSourceFilter {
|
|
649
|
+
field: 'referral_source';
|
|
560
650
|
|
|
561
651
|
operator:
|
|
562
652
|
| 'is'
|
|
@@ -571,43 +661,33 @@ export namespace ReportGetBotsReportParams {
|
|
|
571
661
|
|
|
572
662
|
value:
|
|
573
663
|
| 'openai'
|
|
664
|
+
| 'none'
|
|
574
665
|
| 'anthropic'
|
|
575
|
-
| 'chatgpt'
|
|
576
666
|
| 'deepseek'
|
|
577
|
-
| 'google'
|
|
578
|
-
| 'microsoft'
|
|
579
667
|
| 'perplexity'
|
|
580
|
-
| 'apple'
|
|
581
|
-
| 'bytedance'
|
|
582
|
-
| 'amazon'
|
|
583
|
-
| 'meta'
|
|
584
|
-
| 'duckduckgo'
|
|
585
668
|
| 'you'
|
|
586
|
-
| 'xai'
|
|
587
669
|
| 'grok'
|
|
670
|
+
| 'microsoft'
|
|
588
671
|
| 'gemini'
|
|
672
|
+
| 'internal'
|
|
673
|
+
| 'other'
|
|
589
674
|
| Array<
|
|
590
675
|
| 'openai'
|
|
676
|
+
| 'none'
|
|
591
677
|
| 'anthropic'
|
|
592
|
-
| 'chatgpt'
|
|
593
678
|
| 'deepseek'
|
|
594
|
-
| 'google'
|
|
595
|
-
| 'microsoft'
|
|
596
679
|
| 'perplexity'
|
|
597
|
-
| 'apple'
|
|
598
|
-
| 'bytedance'
|
|
599
|
-
| 'amazon'
|
|
600
|
-
| 'meta'
|
|
601
|
-
| 'duckduckgo'
|
|
602
680
|
| 'you'
|
|
603
|
-
| 'xai'
|
|
604
681
|
| 'grok'
|
|
682
|
+
| 'microsoft'
|
|
605
683
|
| 'gemini'
|
|
684
|
+
| 'internal'
|
|
685
|
+
| 'other'
|
|
606
686
|
>;
|
|
607
687
|
}
|
|
608
688
|
}
|
|
609
689
|
|
|
610
|
-
export interface
|
|
690
|
+
export interface ReportGetReferralsReportV2Params {
|
|
611
691
|
/**
|
|
612
692
|
* Domain to query logs for.
|
|
613
693
|
*/
|
|
@@ -629,10 +709,10 @@ export interface ReportGetReferralsReportParams {
|
|
|
629
709
|
/**
|
|
630
710
|
* Dimensions to group the report by.
|
|
631
711
|
*/
|
|
632
|
-
dimensions?: Array<'date' | 'path' | 'referral_source'>;
|
|
712
|
+
dimensions?: Array<'date' | 'hour' | 'path' | 'referral_source' | 'referral_type'>;
|
|
633
713
|
|
|
634
714
|
/**
|
|
635
|
-
* End date
|
|
715
|
+
* End date in UTC. Accepts same formats as start_date. Defaults to now UTC if
|
|
636
716
|
* omitted.
|
|
637
717
|
*/
|
|
638
718
|
end_date?: string;
|
|
@@ -640,7 +720,11 @@ export interface ReportGetReferralsReportParams {
|
|
|
640
720
|
/**
|
|
641
721
|
* Filters for referrals report.
|
|
642
722
|
*/
|
|
643
|
-
filters?: Array<
|
|
723
|
+
filters?: Array<
|
|
724
|
+
| Shared.PathFilter
|
|
725
|
+
| ReportGetReferralsReportV2Params.ReferralSourceFilter
|
|
726
|
+
| ReportGetReferralsReportV2Params.ReferralTypeFilter
|
|
727
|
+
>;
|
|
644
728
|
|
|
645
729
|
/**
|
|
646
730
|
* Custom ordering of the report results.
|
|
@@ -664,7 +748,7 @@ export interface ReportGetReferralsReportParams {
|
|
|
664
748
|
pagination?: Shared.Pagination;
|
|
665
749
|
}
|
|
666
750
|
|
|
667
|
-
export namespace
|
|
751
|
+
export namespace ReportGetReferralsReportV2Params {
|
|
668
752
|
/**
|
|
669
753
|
* Filter by referral source
|
|
670
754
|
*/
|
|
@@ -708,6 +792,76 @@ export namespace ReportGetReferralsReportParams {
|
|
|
708
792
|
| 'other'
|
|
709
793
|
>;
|
|
710
794
|
}
|
|
795
|
+
|
|
796
|
+
/**
|
|
797
|
+
* Filter by referral type
|
|
798
|
+
*/
|
|
799
|
+
export interface ReferralTypeFilter {
|
|
800
|
+
field: 'referral_type';
|
|
801
|
+
|
|
802
|
+
operator:
|
|
803
|
+
| 'is'
|
|
804
|
+
| 'not_is'
|
|
805
|
+
| 'in'
|
|
806
|
+
| 'not_in'
|
|
807
|
+
| 'contains'
|
|
808
|
+
| 'not_contains'
|
|
809
|
+
| 'matches'
|
|
810
|
+
| 'contains_case_insensitive'
|
|
811
|
+
| 'not_contains_case_insensitive';
|
|
812
|
+
|
|
813
|
+
value: 'internal' | 'referer' | 'utm' | 'none' | Array<'internal' | 'referer' | 'utm' | 'none'>;
|
|
814
|
+
}
|
|
815
|
+
}
|
|
816
|
+
|
|
817
|
+
export interface ReportQueryFanoutsParams {
|
|
818
|
+
category_id: string;
|
|
819
|
+
|
|
820
|
+
/**
|
|
821
|
+
* End date. Accepts YYYY-MM-DD, YYYY-MM-DD HH:MM, or ISO timestamp.
|
|
822
|
+
*/
|
|
823
|
+
end_date: string;
|
|
824
|
+
|
|
825
|
+
metrics: Array<'fanouts_per_execution' | 'total_fanouts' | 'share'>;
|
|
826
|
+
|
|
827
|
+
/**
|
|
828
|
+
* Start date. Accepts YYYY-MM-DD, YYYY-MM-DD HH:MM, or ISO timestamp.
|
|
829
|
+
*/
|
|
830
|
+
start_date: string;
|
|
831
|
+
|
|
832
|
+
/**
|
|
833
|
+
* Date interval for the report. (only used with date dimension)
|
|
834
|
+
*/
|
|
835
|
+
date_interval?: 'hour' | 'day' | 'week' | 'month' | 'year' | 'relative_week';
|
|
836
|
+
|
|
837
|
+
/**
|
|
838
|
+
* Dimensions to group the report by.
|
|
839
|
+
*/
|
|
840
|
+
dimensions?: Array<'prompt' | 'query' | 'model' | 'region' | 'date'>;
|
|
841
|
+
|
|
842
|
+
/**
|
|
843
|
+
* Filters to apply to the query fanout report.
|
|
844
|
+
*/
|
|
845
|
+
filters?: Array<
|
|
846
|
+
| Shared.RegionIDFilter
|
|
847
|
+
| Shared.ModelIDFilter
|
|
848
|
+
| Shared.TopicIDFilter
|
|
849
|
+
| Shared.TagIDFilter
|
|
850
|
+
| PromptIDFilter
|
|
851
|
+
| Shared.PersonaIDFilter
|
|
852
|
+
| Shared.PromptTypeFilter
|
|
853
|
+
>;
|
|
854
|
+
|
|
855
|
+
/**
|
|
856
|
+
* Custom ordering. Keys must be a requested metric or the `date` dimension. Values
|
|
857
|
+
* are `asc` or `desc`. Defaults to first metric descending.
|
|
858
|
+
*/
|
|
859
|
+
order_by?: { [key: string]: 'asc' | 'desc' };
|
|
860
|
+
|
|
861
|
+
/**
|
|
862
|
+
* Pagination settings for the report results.
|
|
863
|
+
*/
|
|
864
|
+
pagination?: Shared.Pagination;
|
|
711
865
|
}
|
|
712
866
|
|
|
713
867
|
export interface ReportSentimentParams {
|
|
@@ -758,13 +912,14 @@ export interface ReportSentimentParams {
|
|
|
758
912
|
| ReportSentimentParams.AssetIDFilter
|
|
759
913
|
| Shared.AssetNameFilter
|
|
760
914
|
| ReportSentimentParams.ThemeFilter
|
|
761
|
-
|
|
|
762
|
-
|
|
|
915
|
+
| Shared.RegionIDFilter
|
|
916
|
+
| Shared.TopicIDFilter
|
|
763
917
|
| TopicNameFilter
|
|
764
|
-
|
|
|
765
|
-
|
|
|
918
|
+
| Shared.ModelIDFilter
|
|
919
|
+
| Shared.TagIDFilter
|
|
920
|
+
| ReportSentimentParams.TagNameFilter
|
|
766
921
|
| Shared.PromptFilter
|
|
767
|
-
|
|
|
922
|
+
| Shared.PersonaIDFilter
|
|
768
923
|
>;
|
|
769
924
|
|
|
770
925
|
/**
|
|
@@ -816,54 +971,22 @@ export namespace ReportSentimentParams {
|
|
|
816
971
|
value: string | Array<string>;
|
|
817
972
|
}
|
|
818
973
|
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
field: '
|
|
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';
|
|
974
|
+
/**
|
|
975
|
+
* Filter by tag name.
|
|
976
|
+
*/
|
|
977
|
+
export interface TagNameFilter {
|
|
978
|
+
field: 'tag_name';
|
|
865
979
|
|
|
866
|
-
operator:
|
|
980
|
+
operator:
|
|
981
|
+
| 'is'
|
|
982
|
+
| 'not_is'
|
|
983
|
+
| 'in'
|
|
984
|
+
| 'not_in'
|
|
985
|
+
| 'contains'
|
|
986
|
+
| 'not_contains'
|
|
987
|
+
| 'matches'
|
|
988
|
+
| 'contains_case_insensitive'
|
|
989
|
+
| 'not_contains_case_insensitive';
|
|
867
990
|
|
|
868
991
|
value: string | Array<string>;
|
|
869
992
|
}
|
|
@@ -914,15 +1037,16 @@ export interface ReportVisibilityParams {
|
|
|
914
1037
|
* List of filters to apply to the visibility report.
|
|
915
1038
|
*/
|
|
916
1039
|
filters?: Array<
|
|
917
|
-
|
|
|
918
|
-
|
|
|
919
|
-
|
|
|
1040
|
+
| Shared.RegionIDFilter
|
|
1041
|
+
| Shared.ModelIDFilter
|
|
1042
|
+
| Shared.TopicIDFilter
|
|
920
1043
|
| TopicNameFilter
|
|
921
1044
|
| Shared.AssetNameFilter
|
|
922
|
-
|
|
|
923
|
-
| ReportVisibilityParams.
|
|
1045
|
+
| Shared.TagIDFilter
|
|
1046
|
+
| ReportVisibilityParams.TagNameFilter
|
|
1047
|
+
| PromptIDFilter
|
|
924
1048
|
| Shared.PromptFilter
|
|
925
|
-
|
|
|
1049
|
+
| Shared.PersonaIDFilter
|
|
926
1050
|
>;
|
|
927
1051
|
|
|
928
1052
|
/**
|
|
@@ -946,62 +1070,22 @@ export interface ReportVisibilityParams {
|
|
|
946
1070
|
}
|
|
947
1071
|
|
|
948
1072
|
export namespace ReportVisibilityParams {
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
field: '
|
|
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';
|
|
1073
|
+
/**
|
|
1074
|
+
* Filter by tag name.
|
|
1075
|
+
*/
|
|
1076
|
+
export interface TagNameFilter {
|
|
1077
|
+
field: 'tag_name';
|
|
1003
1078
|
|
|
1004
|
-
operator:
|
|
1079
|
+
operator:
|
|
1080
|
+
| 'is'
|
|
1081
|
+
| 'not_is'
|
|
1082
|
+
| 'in'
|
|
1083
|
+
| 'not_in'
|
|
1084
|
+
| 'contains'
|
|
1085
|
+
| 'not_contains'
|
|
1086
|
+
| 'matches'
|
|
1087
|
+
| 'contains_case_insensitive'
|
|
1088
|
+
| 'not_contains_case_insensitive';
|
|
1005
1089
|
|
|
1006
1090
|
value: string | Array<string>;
|
|
1007
1091
|
}
|
|
@@ -1009,6 +1093,7 @@ export namespace ReportVisibilityParams {
|
|
|
1009
1093
|
|
|
1010
1094
|
export declare namespace Reports {
|
|
1011
1095
|
export {
|
|
1096
|
+
type PromptIDFilter as PromptIDFilter,
|
|
1012
1097
|
type ReportInfo as ReportInfo,
|
|
1013
1098
|
type ReportResponse as ReportResponse,
|
|
1014
1099
|
type ReportResult as ReportResult,
|
|
@@ -1016,7 +1101,10 @@ export declare namespace Reports {
|
|
|
1016
1101
|
type ReportCitationsResponse as ReportCitationsResponse,
|
|
1017
1102
|
type ReportCitationsParams as ReportCitationsParams,
|
|
1018
1103
|
type ReportGetBotsReportParams as ReportGetBotsReportParams,
|
|
1104
|
+
type ReportGetBotsReportV2Params as ReportGetBotsReportV2Params,
|
|
1019
1105
|
type ReportGetReferralsReportParams as ReportGetReferralsReportParams,
|
|
1106
|
+
type ReportGetReferralsReportV2Params as ReportGetReferralsReportV2Params,
|
|
1107
|
+
type ReportQueryFanoutsParams as ReportQueryFanoutsParams,
|
|
1020
1108
|
type ReportSentimentParams as ReportSentimentParams,
|
|
1021
1109
|
type ReportVisibilityParams as ReportVisibilityParams,
|
|
1022
1110
|
};
|