@madewithremy/admin 0.1.55 → 0.1.57
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 +23 -0
- package/dist/index.d.ts +165 -16
- package/dist/index.js +19 -1
- package/dist/index.js.map +1 -1
- package/dist/prod.js +138 -18
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,29 @@ What changed in `@madewithremy/admin`, newest first, each version under its own
|
|
|
4
4
|
|
|
5
5
|
Versions before 0.1.44 aren't recorded here.
|
|
6
6
|
|
|
7
|
+
## 0.1.57
|
|
8
|
+
|
|
9
|
+
### New
|
|
10
|
+
|
|
11
|
+
- `datasources list` (`admin.dataSources.list`) gives each source's `documentLimit`: the most documents it may hold, the app's limit, or `null` when unlimited. A source nearing it shows before an add is refused.
|
|
12
|
+
|
|
13
|
+
### Changed behavior
|
|
14
|
+
|
|
15
|
+
- A document added past the limit is refused with `document_limit_reached` (422), where it was `entitlement_required:unlimited_data_source_documents`. Support raises the limit per app or workspace. Code that branched on the old code should check for the new one.
|
|
16
|
+
|
|
17
|
+
## 0.1.56
|
|
18
|
+
|
|
19
|
+
### New
|
|
20
|
+
|
|
21
|
+
- Prerendered snapshots are kept per host, so an app serving several sites has each site's own page at a path. `prerender pages` (`admin.prerender.pages`) lists each snapshot's `host` (null for one stored before snapshots were kept per host), `prerender view <path> [--host <h>]` (`admin.prerender.view({ path, host })`) shows one host's copy, the app's own URL by default, and answers with its `host` and the `status` crawlers get it with: 200, or the 4xx the page declared with `<meta name="prerender-status-code">`.
|
|
22
|
+
- `prerender invalidate` (`admin.prerender.invalidate`) takes full URLs as well as paths: a URL purges the page on that host only, a path on every host, as before.
|
|
23
|
+
- `analytics query` (`admin.analytics.query`) takes the new metrics `timeOnPage`, `scrollDepth`, `visitDuration` and `bounceRate` (averages, `null` when there's nothing to average), and the visit dimensions `entryPath`, `exitPath`, `visitReferrerHost`, `visitSourceCategory` and `visitUtmSource`…`visitUtmContent`. It also takes `prop:<key>` for a custom event's property, the filter-only `visitEvent`, and `orderBy` on `visits`.
|
|
24
|
+
- `analytics funnel '<json>'` (`admin.analytics.funnel`) counts visits through ordered steps (pages or events) and where they dropped off, optionally split. `analytics paths ['<json>']` (`admin.analytics.paths`) shows where visits went after a page and their commonest routes. Both follow a visitor across the apps sharing the host (mounts); `meta.apps` lists them.
|
|
25
|
+
|
|
26
|
+
### Changed behavior
|
|
27
|
+
|
|
28
|
+
- Code reading `admin.prerender.pages()` should tell rows apart by host and path together: the same path on two hosts is two rows.
|
|
29
|
+
|
|
7
30
|
## 0.1.55
|
|
8
31
|
|
|
9
32
|
### Changed behavior
|
package/dist/index.d.ts
CHANGED
|
@@ -330,13 +330,20 @@ declare namespace tasks {
|
|
|
330
330
|
* customerApps/AppAnalytics/live/PresenceStore.ts — live DAO
|
|
331
331
|
* customerApps/AppAnalytics/dao/CrawlerHitsDao.ts — crawlers DAO
|
|
332
332
|
*/
|
|
333
|
-
/** The
|
|
334
|
-
type
|
|
333
|
+
/** The counts the query engine can return per row. */
|
|
334
|
+
type AnalyticsCountMetric = 'pageviews' | 'visitors' | 'visits' | 'events';
|
|
335
|
+
/**
|
|
336
|
+
* The averages: seconds a page was actively read, % of the page scrolled,
|
|
337
|
+
* seconds a visit was actively read, % of visits that bounced. `null` in a
|
|
338
|
+
* row when there's nothing to average.
|
|
339
|
+
*/
|
|
340
|
+
type AnalyticsAverageMetric = 'timeOnPage' | 'scrollDepth' | 'visitDuration' | 'bounceRate';
|
|
341
|
+
type AnalyticsMetric = AnalyticsCountMetric | AnalyticsAverageMetric;
|
|
335
342
|
/** One row in a query result. `dimensions` contains the group-by key(s);
|
|
336
343
|
* `metrics` contains only the requested-and-available metrics. */
|
|
337
344
|
interface AnalyticsQueryResultRow {
|
|
338
345
|
dimensions: Record<string, string>;
|
|
339
|
-
metrics: Partial<Record<
|
|
346
|
+
metrics: Partial<Record<AnalyticsCountMetric, number>> & Partial<Record<AnalyticsAverageMetric, number | null>>;
|
|
340
347
|
}
|
|
341
348
|
/** Response shape for POST /insights/query. */
|
|
342
349
|
interface AnalyticsQueryResult {
|
|
@@ -364,6 +371,55 @@ interface AnalyticsQueryResult {
|
|
|
364
371
|
interface AnalyticsBatchResult {
|
|
365
372
|
results: AnalyticsQueryResult[];
|
|
366
373
|
}
|
|
374
|
+
/** A funnel step: a page opened, or a custom event fired. */
|
|
375
|
+
type AnalyticsFunnelStep = {
|
|
376
|
+
page: string;
|
|
377
|
+
match: 'is' | 'contains';
|
|
378
|
+
} | {
|
|
379
|
+
event: string;
|
|
380
|
+
props: Record<string, string>;
|
|
381
|
+
};
|
|
382
|
+
/** What a funnel or paths read reports about its window and the apps it read. */
|
|
383
|
+
interface AnalyticsVisitReadMeta {
|
|
384
|
+
window: {
|
|
385
|
+
requested: [string, string];
|
|
386
|
+
served: [string, string];
|
|
387
|
+
};
|
|
388
|
+
/** True when the window was cut: to retention, or to when visits were first recorded. */
|
|
389
|
+
clamped: boolean;
|
|
390
|
+
/** The apps whose visits answered: this one, and those sharing its host. */
|
|
391
|
+
apps: string[];
|
|
392
|
+
}
|
|
393
|
+
/** Response shape for POST /insights/funnel. */
|
|
394
|
+
interface AnalyticsFunnelResult {
|
|
395
|
+
steps: {
|
|
396
|
+
step: AnalyticsFunnelStep;
|
|
397
|
+
visits: number;
|
|
398
|
+
dropOff: number;
|
|
399
|
+
}[];
|
|
400
|
+
breakdown?: {
|
|
401
|
+
dimension: string;
|
|
402
|
+
groups: {
|
|
403
|
+
value: string | null;
|
|
404
|
+
visits: number[];
|
|
405
|
+
}[];
|
|
406
|
+
};
|
|
407
|
+
meta: AnalyticsVisitReadMeta;
|
|
408
|
+
}
|
|
409
|
+
/** Response shape for POST /insights/paths. */
|
|
410
|
+
interface AnalyticsPathsResult {
|
|
411
|
+
visits: number;
|
|
412
|
+
/** With `from`: the page opened next, or null where the visit ended. */
|
|
413
|
+
next?: {
|
|
414
|
+
path: string | null;
|
|
415
|
+
visits: number;
|
|
416
|
+
}[];
|
|
417
|
+
routes: {
|
|
418
|
+
paths: string[];
|
|
419
|
+
visits: number;
|
|
420
|
+
}[];
|
|
421
|
+
meta: AnalyticsVisitReadMeta;
|
|
422
|
+
}
|
|
367
423
|
/** One ranked traffic source row, with category + vendor classification
|
|
368
424
|
* applied server-side (UTM source values are classified the same way as
|
|
369
425
|
* referrer hosts — ChatGPT/Perplexity often arrive tagged
|
|
@@ -604,18 +660,24 @@ interface CrawlersParams {
|
|
|
604
660
|
*
|
|
605
661
|
* The query body shape (all fields optional except `metrics`):
|
|
606
662
|
* ```
|
|
607
|
-
* metrics
|
|
663
|
+
* metrics counts: "pageviews" | "visitors" | "visits" | "events"
|
|
664
|
+
* averages (null with nothing to average): "timeOnPage" (s)
|
|
665
|
+
* | "scrollDepth" (%) | "visitDuration" (s) | "bounceRate" (%)
|
|
608
666
|
* dimensions at most ONE entity dimension OR "time" (not both):
|
|
609
667
|
* path referrerHost sourceCategory country city deviceType
|
|
610
668
|
* browser os language visitorType utmSource utmMedium
|
|
611
669
|
* utmCampaign utmTerm utmContent eventName
|
|
670
|
+
* the visit's: entryPath exitPath visitReferrerHost
|
|
671
|
+
* visitSourceCategory visitUtmSource … visitUtmContent
|
|
672
|
+
* a custom event's property: prop:<key>
|
|
612
673
|
* granularity required with "time": "5m" | "hour" | "day" | "week" | "month"
|
|
613
674
|
* timezone IANA zone for day/week/month boundaries (default UTC)
|
|
614
675
|
* filters [[op, dimension, [values...]], ...]
|
|
615
676
|
* ops: "is" (any of) | "is_not" (none of) | "contains"
|
|
677
|
+
* plus the filter-only "visitEvent": the visit fired the event
|
|
616
678
|
* dateRange "1h" | "24h" | "7d" | "30d" | "90d" | "all"
|
|
617
679
|
* or ["<startISO>", "<endISO>"] (default "24h")
|
|
618
|
-
* orderBy grouped only: [["pageviews" | "events", "asc" | "desc"]]
|
|
680
|
+
* orderBy grouped only: [["pageviews" | "events" | "visits", "asc" | "desc"]]
|
|
619
681
|
* limit grouped only; default 25, max 1000
|
|
620
682
|
* offset paging
|
|
621
683
|
* releaseId optional release scope
|
|
@@ -650,6 +712,65 @@ declare function query$1(ctx: AdminContext, body: Record<string, unknown>): Prom
|
|
|
650
712
|
* ]);
|
|
651
713
|
*/
|
|
652
714
|
declare function batch(ctx: AdminContext, queries: unknown[] | undefined): Promise<AnalyticsBatchResult>;
|
|
715
|
+
/**
|
|
716
|
+
* How many visits went through ordered steps, and where they dropped off.
|
|
717
|
+
*
|
|
718
|
+
* The body (`steps` required):
|
|
719
|
+
* ```
|
|
720
|
+
* steps 2-8 of { "page": "/pricing", "match"?: "is" | "contains" }
|
|
721
|
+
* or { "event": "signup_start", "props"?: { "plan": "pro" } },
|
|
722
|
+
* each reached after the one before it within one visit
|
|
723
|
+
* breakdown optional split: entryPath exitPath visitReferrerHost
|
|
724
|
+
* visitSourceCategory visitUtm* visitorType deviceType country
|
|
725
|
+
* browser os (its 25 largest values)
|
|
726
|
+
* filters pick visits: a visit is in when any of its rows matches them all
|
|
727
|
+
* dateRange as for query (raw events: 90 days at most)
|
|
728
|
+
* releaseId optional release scope
|
|
729
|
+
* ```
|
|
730
|
+
*
|
|
731
|
+
* Follows a visitor across the apps sharing this one's host (the apps it
|
|
732
|
+
* mounts, the app it's mounted under), the ones the caller may open; `meta.apps`
|
|
733
|
+
* lists them. Visit-level reads start when the app's visits were first
|
|
734
|
+
* recorded, which `meta.clamped` and `meta.window.served` say.
|
|
735
|
+
*
|
|
736
|
+
* @throws AdminApiError `invalid_step` (400) for a malformed or missing step,
|
|
737
|
+
* `invalid_dimension` (400) for a breakdown a visit doesn't have once,
|
|
738
|
+
* `invalid_query_field` (400) for an unknown field.
|
|
739
|
+
*
|
|
740
|
+
* @example
|
|
741
|
+
* const { steps } = await admin.analytics.funnel({
|
|
742
|
+
* steps: [{ page: '/blog/', match: 'contains' }, { event: 'signup_start' }],
|
|
743
|
+
* dateRange: '30d',
|
|
744
|
+
* });
|
|
745
|
+
*/
|
|
746
|
+
declare function funnel(ctx: AdminContext, body: Record<string, unknown>): Promise<AnalyticsFunnelResult>;
|
|
747
|
+
/**
|
|
748
|
+
* The routes visits took: where they went after a page, and the pages they
|
|
749
|
+
* commonly opened with.
|
|
750
|
+
*
|
|
751
|
+
* The body (all optional):
|
|
752
|
+
* ```
|
|
753
|
+
* from a path: the pages opened next after it (null = left there)
|
|
754
|
+
* depth 1-5 opening pages per route (default 3)
|
|
755
|
+
* limit 1-100 rows per list (default 10)
|
|
756
|
+
* filters pick visits, as for funnel
|
|
757
|
+
* dateRange as for query (raw events: 90 days at most)
|
|
758
|
+
* releaseId optional release scope
|
|
759
|
+
* ```
|
|
760
|
+
*
|
|
761
|
+
* A page reloaded or reopened in a row counts once. Follows a visitor across
|
|
762
|
+
* the apps sharing this one's host, as `funnel` does.
|
|
763
|
+
*
|
|
764
|
+
* @throws AdminApiError `invalid_query` (400) for a `depth` or `limit` out of
|
|
765
|
+
* range, `invalid_query_field` (400) for an unknown field.
|
|
766
|
+
*
|
|
767
|
+
* @example
|
|
768
|
+
* const { next, routes } = await admin.analytics.paths({
|
|
769
|
+
* from: '/pricing',
|
|
770
|
+
* dateRange: '7d',
|
|
771
|
+
* });
|
|
772
|
+
*/
|
|
773
|
+
declare function paths(ctx: AdminContext, body: Record<string, unknown>): Promise<AnalyticsPathsResult>;
|
|
653
774
|
/**
|
|
654
775
|
* Ranked traffic sources: per-session first source (UTM > referrer > direct),
|
|
655
776
|
* with category and vendor classification applied server-side.
|
|
@@ -717,11 +838,13 @@ type analytics_SourcesParams = SourcesParams;
|
|
|
717
838
|
declare const analytics_aiSources: typeof aiSources;
|
|
718
839
|
declare const analytics_batch: typeof batch;
|
|
719
840
|
declare const analytics_crawlers: typeof crawlers;
|
|
841
|
+
declare const analytics_funnel: typeof funnel;
|
|
720
842
|
declare const analytics_live: typeof live;
|
|
721
843
|
declare const analytics_map: typeof map;
|
|
844
|
+
declare const analytics_paths: typeof paths;
|
|
722
845
|
declare const analytics_sources: typeof sources;
|
|
723
846
|
declare namespace analytics {
|
|
724
|
-
export { analytics_aiSources as aiSources, analytics_batch as batch, analytics_crawlers as crawlers, analytics_live as live, analytics_map as map, query$1 as query, analytics_sources as sources };
|
|
847
|
+
export { analytics_aiSources as aiSources, analytics_batch as batch, analytics_crawlers as crawlers, analytics_funnel as funnel, analytics_live as live, analytics_map as map, analytics_paths as paths, query$1 as query, analytics_sources as sources };
|
|
725
848
|
export type { analytics_AiSourcesParams as AiSourcesParams, analytics_CrawlersParams as CrawlersParams, analytics_MapParams as MapParams, analytics_SourcesParams as SourcesParams };
|
|
726
849
|
}
|
|
727
850
|
|
|
@@ -2634,6 +2757,11 @@ interface DataSourcesListEntry {
|
|
|
2634
2757
|
name: string | null;
|
|
2635
2758
|
/** Total document count (active pipeline). */
|
|
2636
2759
|
documentCount: number;
|
|
2760
|
+
/**
|
|
2761
|
+
* The most documents the source may hold, the app's limit; null when
|
|
2762
|
+
* unlimited. An add past it is refused with `document_limit_reached`.
|
|
2763
|
+
*/
|
|
2764
|
+
documentLimit: number | null;
|
|
2637
2765
|
counts: DataSourcesBuildProgress;
|
|
2638
2766
|
/** Source-document bytes (does not include vector storage). */
|
|
2639
2767
|
storageBytes: number;
|
|
@@ -3000,6 +3128,8 @@ interface AddDocumentResult {
|
|
|
3000
3128
|
*
|
|
3001
3129
|
* @throws AdminApiError `invalid_content_hash` (400) — malformed hash
|
|
3002
3130
|
* (internal; `addDocument` computes this from `content`).
|
|
3131
|
+
* @throws AdminApiError `document_limit_reached` (422) — the source holds the
|
|
3132
|
+
* app's limit of documents (`documentLimit` in `list`); support raises it.
|
|
3003
3133
|
* @example
|
|
3004
3134
|
* const result = await admin.dataSources.addDocument({
|
|
3005
3135
|
* slug: 'policies',
|
|
@@ -3118,7 +3248,8 @@ declare function documents(ctx: AdminContext, params: DocumentsParams): Promise<
|
|
|
3118
3248
|
*/
|
|
3119
3249
|
declare function allDocuments(ctx: AdminContext, params: Omit<DocumentsParams, 'cursor' | 'limit'>): Promise<DataSourcesDocumentStatus[]>;
|
|
3120
3250
|
/**
|
|
3121
|
-
* List all data sources with document counts,
|
|
3251
|
+
* List all data sources with document counts, the most documents each may
|
|
3252
|
+
* hold (`documentLimit`, null when unlimited), build progress, and active
|
|
3122
3253
|
* version metadata.
|
|
3123
3254
|
*
|
|
3124
3255
|
* @example
|
|
@@ -7513,6 +7644,9 @@ declare namespace methods {
|
|
|
7513
7644
|
*/
|
|
7514
7645
|
/** One stored snapshot entry as returned by the listing endpoint. */
|
|
7515
7646
|
interface PrerenderPage {
|
|
7647
|
+
/** The host the page was rendered on, since one app can serve several
|
|
7648
|
+
* sites. Null for a page stored before snapshots were kept per host. */
|
|
7649
|
+
host: string | null;
|
|
7516
7650
|
path: string;
|
|
7517
7651
|
/** ISO timestamp of when the snapshot was last written. Optional — absent
|
|
7518
7652
|
* if the object store did not return a LastModified header. */
|
|
@@ -7534,12 +7668,17 @@ interface PrerenderPagesResult {
|
|
|
7534
7668
|
* Returns JSON (not text/html) so the snapshot HTML cannot execute in the
|
|
7535
7669
|
* api origin; the dashboard renders it in a sandboxed iframe. */
|
|
7536
7670
|
interface PrerenderViewResult {
|
|
7671
|
+
/** The host whose copy this is (the app's address when none was asked for). */
|
|
7672
|
+
host: string;
|
|
7537
7673
|
path: string;
|
|
7538
7674
|
html: string;
|
|
7675
|
+
/** The status crawlers are served it with: 200, or the 4xx the page
|
|
7676
|
+
* declared with `<meta name="prerender-status-code">`. */
|
|
7677
|
+
status: number;
|
|
7539
7678
|
}
|
|
7540
7679
|
/** Response shape for POST /prerender/invalidate.
|
|
7541
|
-
* `purged` is the number of paths explicitly purged, or 'all'
|
|
7542
|
-
* entire snapshot prefix was wiped (--all flag / no paths body). */
|
|
7680
|
+
* `purged` is the number of pages (paths or URLs) explicitly purged, or 'all'
|
|
7681
|
+
* when the entire snapshot prefix was wiped (--all flag / no paths body). */
|
|
7543
7682
|
interface PrerenderInvalidateResult {
|
|
7544
7683
|
purged: number | 'all';
|
|
7545
7684
|
}
|
|
@@ -7571,11 +7710,18 @@ interface PrerenderPagesParams {
|
|
|
7571
7710
|
interface PrerenderViewParams {
|
|
7572
7711
|
/** App path to look up (e.g. `/u/abc123`). Must be non-empty. */
|
|
7573
7712
|
path: string;
|
|
7713
|
+
/**
|
|
7714
|
+
* The host whose copy to show, for an app serving several sites (as `pages`
|
|
7715
|
+
* lists it). Omit for the copy on the app's address.
|
|
7716
|
+
*/
|
|
7717
|
+
host?: string;
|
|
7574
7718
|
}
|
|
7575
7719
|
interface PrerenderInvalidateParams {
|
|
7576
7720
|
/**
|
|
7577
|
-
*
|
|
7578
|
-
*
|
|
7721
|
+
* Pages to purge: paths (`/u/abc`), purged on every host the app is served
|
|
7722
|
+
* on, or full URLs (`https://site-a.com/u/abc`), purged on that host only.
|
|
7723
|
+
* Omit (or pass undefined) to purge every snapshot (the `--all` flag). An
|
|
7724
|
+
* explicit empty array is the same as --all.
|
|
7579
7725
|
*/
|
|
7580
7726
|
paths?: string[];
|
|
7581
7727
|
}
|
|
@@ -7592,14 +7738,15 @@ interface PrerenderInvalidateParams {
|
|
|
7592
7738
|
*/
|
|
7593
7739
|
declare function pages(ctx: AdminContext, params?: PrerenderPagesParams): Promise<PrerenderPagesResult>;
|
|
7594
7740
|
/**
|
|
7595
|
-
* Retrieve the stored snapshot HTML for a single path
|
|
7741
|
+
* Retrieve the stored snapshot HTML for a single path, on one host, with the
|
|
7742
|
+
* status crawlers get it with (a page that declared a 4xx is stored as one).
|
|
7596
7743
|
*
|
|
7597
7744
|
* Returns JSON (not text/html) so the snapshot cannot execute in the API
|
|
7598
7745
|
* origin; render the `html` field in a sandboxed iframe if displaying it.
|
|
7599
7746
|
*
|
|
7600
7747
|
* @throws AdminApiError `snapshot_not_found` (404) — no snapshot exists for
|
|
7601
|
-
* that path (the path is cold; trigger a render via
|
|
7602
|
-
* `missing_path` (400) — `path` is empty.
|
|
7748
|
+
* that path on that host (the path is cold; trigger a render via
|
|
7749
|
+
* `prerender get`); `missing_path` (400) — `path` is empty.
|
|
7603
7750
|
* @example
|
|
7604
7751
|
* const { html } = await admin.prerender.view({ path: '/u/abc123' });
|
|
7605
7752
|
*/
|
|
@@ -7612,8 +7759,10 @@ declare function view(ctx: AdminContext, params: PrerenderViewParams): Promise<P
|
|
|
7612
7759
|
* invalidated path will trigger a fresh render.
|
|
7613
7760
|
*
|
|
7614
7761
|
* @example
|
|
7615
|
-
* // Purge a specific path:
|
|
7762
|
+
* // Purge a specific path, on every host:
|
|
7616
7763
|
* await admin.prerender.invalidate({ paths: ['/u/abc123'] });
|
|
7764
|
+
* // Purge it on one site only:
|
|
7765
|
+
* await admin.prerender.invalidate({ paths: ['https://site-a.com/u/abc123'] });
|
|
7617
7766
|
* // Purge all snapshots:
|
|
7618
7767
|
* await admin.prerender.invalidate();
|
|
7619
7768
|
*/
|
|
@@ -9300,4 +9449,4 @@ declare class AdminTimeoutError extends Error {
|
|
|
9300
9449
|
declare const admin: AdminClient;
|
|
9301
9450
|
|
|
9302
9451
|
export { AdminApiError, AdminTimeoutError, admin, createAdminClient, admin as default };
|
|
9303
|
-
export type { AdminClient, AdminClientOptions, AdminContext, AgentThreadDetail, AgentThreadListItem, AgentThreadsGetResult, AgentThreadsListResult, AgentToolCall, AgentTranscriptMessage, AgentTurnError, AnalyticsAiHostRow, AnalyticsAiSourcesResult, AnalyticsAiVendorRow, AnalyticsBatchResult, AnalyticsCrawlersOverviewResult, AnalyticsCrawlersRecentResult, AnalyticsCrawlersRecentRow, AnalyticsCrawlersResult, AnalyticsCrawlersTimeseriesBucket, AnalyticsCrawlersTimeseriesResult, AnalyticsLiveResult, AnalyticsMapPoint, AnalyticsMapResult, AnalyticsMetric, AnalyticsQueryResult, AnalyticsQueryResultRow, AnalyticsSourceRow, AnalyticsSourcesResult, AppCronJobStatus, AppCronJobStatusReason, AppCronRunState, AppEmailSuppression, AppSecretRow, AppsListPage, AppsListResult, BoughtDomain, CrashGroup, CrashOccurrenceRow, CrashesGetResult, CrashesListResult, CrashesOccurrencesResult, CrashesStatsBucket, CrashesStatsResult, CronJobDecorated, CronOverviewResult, CronRunResult, CronRunSummary, DashboardLiveRelease, DashboardReleaseMethod, DashboardResult, DataLiftFromDevResult, DataLiftFromLiveResult, DataSourceConnector, DataSourceConnectorCredentials, DataSourceConnectorDeletions, DataSourceConnectorGetResult, DataSourceConnectorPolicy, DataSourceConnectorResult, DataSourceInspectReport, DataSourceInspectResult, DataSourceJob, DataSourceJobGetResult, DataSourceJobManifestTokenResult, DataSourceJobPlan, DataSourceJobResult, DataSourceJobSource, DataSourceJobState, DataSourceJobsListResult, DataSourceMapDeployResult, DataSourceMapTestDocument, DataSourceMapTestOutcome, DataSourceMapTestResult, DataSourceMapper, DataSourceObjectSelection, DataSourceQuarantineResult, DataSourceQuarantinedObject, DataSourceReader, DataSourceReaderDeliveries, DataSourceReaderRetryResult, DataSourceReaderStatusResult, DataSourceReaderTestDocument, DataSourceReaderTestResult, DataSourceRemapResult, DataSourceRereadResult, DataSourceSyncResult, DataSourcesBuildProgress, DataSourcesChunkingConfig, DataSourcesChunkingStrategy, DataSourcesConfigResult, DataSourcesConfigUpdateResult, DataSourcesCountResult, DataSourcesCreateResult, DataSourcesDeleteResult, DataSourcesDictionaryPushResult, DataSourcesDictionaryReport, DataSourcesDictionaryStatus, DataSourcesDocument, DataSourcesDocumentConfirmResult, DataSourcesDocumentDeleteManyResult, DataSourcesDocumentDeleteResult, DataSourcesDocumentSelector, DataSourcesDocumentStatus, DataSourcesDocumentsResult, DataSourcesDropResult, DataSourcesEntitiesResult, DataSourcesHydrateResult, DataSourcesHydration, DataSourcesIndex, DataSourcesIngestConfig, DataSourcesIngestUpdate, DataSourcesLinkResult, DataSourcesListEntry, DataSourcesListResult, DataSourcesMigration, DataSourcesMoveResult, DataSourcesPassage, DataSourcesPassagesResult, DataSourcesPlacement, DataSourcesPromoteResult, DataSourcesRelink, DataSourcesRetrievalConfig, DataSourcesRetrievalUpdate, DataSourcesRevectorizeResult, DataSourcesSampleResult, DataSourcesSearchCitation, DataSourcesSearchResult, DataSourcesSearchResultItem, DataSourcesUploadTokenResult, DatasetFile, DbHistoryResult, DbQueryResult, DiagnosticsAuditEnvironment, DiagnosticsDashboardResult, DiagnosticsFinding, DiagnosticsLighthouseScores, DiagnosticsPayload, DiagnosticsReleaseResult, DiagnosticsRuntimeFindings, DomainsCheckResult, DomainsCustomAddResult, DomainsCustomCheckResult, DomainsCustomHostnameUiStatus, DomainsCustomHostnameView, DomainsCustomListResult, DomainsCustomRemoveResult, DomainsCustomRetryResult, DomainsDnsInstructions, DomainsGetResult, DomainsSetResult, EmailBatchLifecycle, EmailBatchResult, EmailBatchSummary, EmailBatchesResult, EmailDomainBase, EmailEffectiveSender, EmailInboxResult, EmailListResult, EmailMessageKind, EmailMessageResult, EmailMessageStatus, EmailSenderTier, EmailSendingStatusResult, EmailStatsResult, EmailSummary, EmailSuppressResult, EmailSuppressionsResult, EmailUnsuppressResult, EvalAggregates, EvalCompareResult, EvalExpectation, EvalQueriesAddResult, EvalQueriesListResult, EvalQuery, EvalQueryResult, EvalQueryStyle, EvalRetrieval, EvalRun, EvalRunResult, EvalRunState, EvalRunsListResult, EvalSet, EvalSetGetResult, EvalSetResult, EvalSetState, EvalSetsListResult, EventChannelActivity, EventsChannelsListResult, EventsPublishResult, EventsTailFrame, FilesDeleteResult, FilesFileMeta, FilesListEntry, FilesListResult, FilesLsResult, FilesScanBadge, FilesScanFlagged, FilesScanStore, FilesStatResult, FilesStoreSummaryEntry, FilesUploadUrlResult, FilesUrlResult, FrontendErrorType, InboundDnsInstructions, InboundEmailDomainAddResult, InboundEmailDomainCheckResult, InboundEmailDomainDeleteResult, InboundEmailDomainUiStatus, InboundEmailDomainVerifyResult, InboundEmailDomainView, InboundEmailDomainsListResult, InboxEmailPreview, IssueAuthorKind, IssueCommentRow, IssueEventType, IssueRow, IssueStatus, IssuesCommentResult, IssuesCreateResult, IssuesDeleteResult, IssuesGetResult, IssuesListResult, IssuesUpdateResult, JewelPairRow, JewelPairSummaryRow, JewelVerdict, JewelsDatasetSummary, JewelsDryrunResult, JewelsExportResult, JewelsGradeResult, JewelsGrading, JewelsOverviewResult, JewelsPairResult, JewelsPairsResult, JewelsQueueResult, JewelsResolveResult, JewelsRunResult, JewelsRunsResult, JewelsTimeseriesBucket, JewelsTimeseriesResult, JewelsTrainResult, LiftedDatabase, MethodsInvokeResult, OperationProgress, OutboundDnsInstructions, OutboundDnsRecord, OutboundEmailDomainAddResult, OutboundEmailDomainCheckResult, OutboundEmailDomainDeleteResult, OutboundEmailDomainUiStatus, OutboundEmailDomainVerifyResult, OutboundEmailDomainView, OutboundEmailDomainsListResult, PlatformSuppression, PrerenderGetResult, PrerenderInvalidateResult, PrerenderPage, PrerenderPagesResult, PrerenderViewResult, PreviewShareLink, PreviewShareListResult, PreviewShareResult, PreviewShareRevokeResult, RegisteredDomainConnection, RegisteredDomainOffer, RegisteredDomainQuote, RegisteredDomainRecordType, RegisteredDomainRecords, RegisteredDomainStatus, RegisteredDomainView, RegisteredDomainZoneRecord, RegisteredDomainsBuyResult, RegisteredDomainsContactResult, RegisteredDomainsContactSetResult, RegisteredDomainsListResult, RegisteredDomainsQuoteResult, RegisteredDomainsRecordDeleteResult, RegisteredDomainsRecordResult, RegisteredDomainsSearchResult, RegisteredDomainsZoneResult, RegistrantContact, ReleaseFailureFields, ReleaseFragment, ReleasesByCommitResult, ReleasesGetResult, ReleasesListResult, RequestsGetResult, RequestsListResult, RequestsListRow, RequestsStatsMethodBucket, RequestsStatsMethodResult, RequestsStatsSummaryBucket, RequestsStatsSummaryResult, SecretsDeleteResult, SecretsGetResult, SecretsListResult, SecretsSetResult, SettingsResult, SuppressionSource, TaskTraceOutcome, TaskTraceSummary, TaskTranscriptMessage, TaskTurnError, TasksGetResult, TasksListResult, TrainingLogEntry, TrainingRunRow, TrainingRunStatus, UsageGroup, UsageGroupBy, UsageSummaryResult, UserAuthProvider, UserListItem, UserRecord, UsersCreateApiKeyResult, UsersListResult, UsersRevokeApiKeyResult, UsersSetRoleResult, V2AppSettings, V2BuildLogEntry, V2BuildStats, V2CommitInfo, V2EmailMessage, V2ReleaseStatus, VoiceAvailableNumber, VoiceNumbersBuyResult, VoiceNumbersListResult, VoiceNumbersReleaseResult, VoiceNumbersSearchResult, VoiceNumbersSetNameResult, VoicePhoneNumberStatus, VoicePhoneNumberView, VoiceResolvedPolicy, VoiceSessionChannel, VoiceSessionCost, VoiceSessionCostLine, VoiceSessionDetail, VoiceSessionGetResult, VoiceSessionListItem, VoiceSessionSip, VoiceSessionSpeechEntry, VoiceSessionStatus, VoiceSessionToolEntry, VoiceSessionTranscriptEntry, VoiceSessionsListResult, VoiceSettingsCeilings, VoiceSettingsGetResult, VoiceSettingsOverrides, VoiceSettingsSetResult, WorkspaceApp, WorkspaceRegistrantContact };
|
|
9452
|
+
export type { AdminClient, AdminClientOptions, AdminContext, AgentThreadDetail, AgentThreadListItem, AgentThreadsGetResult, AgentThreadsListResult, AgentToolCall, AgentTranscriptMessage, AgentTurnError, AnalyticsAiHostRow, AnalyticsAiSourcesResult, AnalyticsAiVendorRow, AnalyticsAverageMetric, AnalyticsBatchResult, AnalyticsCountMetric, AnalyticsCrawlersOverviewResult, AnalyticsCrawlersRecentResult, AnalyticsCrawlersRecentRow, AnalyticsCrawlersResult, AnalyticsCrawlersTimeseriesBucket, AnalyticsCrawlersTimeseriesResult, AnalyticsFunnelResult, AnalyticsFunnelStep, AnalyticsLiveResult, AnalyticsMapPoint, AnalyticsMapResult, AnalyticsMetric, AnalyticsPathsResult, AnalyticsQueryResult, AnalyticsQueryResultRow, AnalyticsSourceRow, AnalyticsSourcesResult, AnalyticsVisitReadMeta, AppCronJobStatus, AppCronJobStatusReason, AppCronRunState, AppEmailSuppression, AppSecretRow, AppsListPage, AppsListResult, BoughtDomain, CrashGroup, CrashOccurrenceRow, CrashesGetResult, CrashesListResult, CrashesOccurrencesResult, CrashesStatsBucket, CrashesStatsResult, CronJobDecorated, CronOverviewResult, CronRunResult, CronRunSummary, DashboardLiveRelease, DashboardReleaseMethod, DashboardResult, DataLiftFromDevResult, DataLiftFromLiveResult, DataSourceConnector, DataSourceConnectorCredentials, DataSourceConnectorDeletions, DataSourceConnectorGetResult, DataSourceConnectorPolicy, DataSourceConnectorResult, DataSourceInspectReport, DataSourceInspectResult, DataSourceJob, DataSourceJobGetResult, DataSourceJobManifestTokenResult, DataSourceJobPlan, DataSourceJobResult, DataSourceJobSource, DataSourceJobState, DataSourceJobsListResult, DataSourceMapDeployResult, DataSourceMapTestDocument, DataSourceMapTestOutcome, DataSourceMapTestResult, DataSourceMapper, DataSourceObjectSelection, DataSourceQuarantineResult, DataSourceQuarantinedObject, DataSourceReader, DataSourceReaderDeliveries, DataSourceReaderRetryResult, DataSourceReaderStatusResult, DataSourceReaderTestDocument, DataSourceReaderTestResult, DataSourceRemapResult, DataSourceRereadResult, DataSourceSyncResult, DataSourcesBuildProgress, DataSourcesChunkingConfig, DataSourcesChunkingStrategy, DataSourcesConfigResult, DataSourcesConfigUpdateResult, DataSourcesCountResult, DataSourcesCreateResult, DataSourcesDeleteResult, DataSourcesDictionaryPushResult, DataSourcesDictionaryReport, DataSourcesDictionaryStatus, DataSourcesDocument, DataSourcesDocumentConfirmResult, DataSourcesDocumentDeleteManyResult, DataSourcesDocumentDeleteResult, DataSourcesDocumentSelector, DataSourcesDocumentStatus, DataSourcesDocumentsResult, DataSourcesDropResult, DataSourcesEntitiesResult, DataSourcesHydrateResult, DataSourcesHydration, DataSourcesIndex, DataSourcesIngestConfig, DataSourcesIngestUpdate, DataSourcesLinkResult, DataSourcesListEntry, DataSourcesListResult, DataSourcesMigration, DataSourcesMoveResult, DataSourcesPassage, DataSourcesPassagesResult, DataSourcesPlacement, DataSourcesPromoteResult, DataSourcesRelink, DataSourcesRetrievalConfig, DataSourcesRetrievalUpdate, DataSourcesRevectorizeResult, DataSourcesSampleResult, DataSourcesSearchCitation, DataSourcesSearchResult, DataSourcesSearchResultItem, DataSourcesUploadTokenResult, DatasetFile, DbHistoryResult, DbQueryResult, DiagnosticsAuditEnvironment, DiagnosticsDashboardResult, DiagnosticsFinding, DiagnosticsLighthouseScores, DiagnosticsPayload, DiagnosticsReleaseResult, DiagnosticsRuntimeFindings, DomainsCheckResult, DomainsCustomAddResult, DomainsCustomCheckResult, DomainsCustomHostnameUiStatus, DomainsCustomHostnameView, DomainsCustomListResult, DomainsCustomRemoveResult, DomainsCustomRetryResult, DomainsDnsInstructions, DomainsGetResult, DomainsSetResult, EmailBatchLifecycle, EmailBatchResult, EmailBatchSummary, EmailBatchesResult, EmailDomainBase, EmailEffectiveSender, EmailInboxResult, EmailListResult, EmailMessageKind, EmailMessageResult, EmailMessageStatus, EmailSenderTier, EmailSendingStatusResult, EmailStatsResult, EmailSummary, EmailSuppressResult, EmailSuppressionsResult, EmailUnsuppressResult, EvalAggregates, EvalCompareResult, EvalExpectation, EvalQueriesAddResult, EvalQueriesListResult, EvalQuery, EvalQueryResult, EvalQueryStyle, EvalRetrieval, EvalRun, EvalRunResult, EvalRunState, EvalRunsListResult, EvalSet, EvalSetGetResult, EvalSetResult, EvalSetState, EvalSetsListResult, EventChannelActivity, EventsChannelsListResult, EventsPublishResult, EventsTailFrame, FilesDeleteResult, FilesFileMeta, FilesListEntry, FilesListResult, FilesLsResult, FilesScanBadge, FilesScanFlagged, FilesScanStore, FilesStatResult, FilesStoreSummaryEntry, FilesUploadUrlResult, FilesUrlResult, FrontendErrorType, InboundDnsInstructions, InboundEmailDomainAddResult, InboundEmailDomainCheckResult, InboundEmailDomainDeleteResult, InboundEmailDomainUiStatus, InboundEmailDomainVerifyResult, InboundEmailDomainView, InboundEmailDomainsListResult, InboxEmailPreview, IssueAuthorKind, IssueCommentRow, IssueEventType, IssueRow, IssueStatus, IssuesCommentResult, IssuesCreateResult, IssuesDeleteResult, IssuesGetResult, IssuesListResult, IssuesUpdateResult, JewelPairRow, JewelPairSummaryRow, JewelVerdict, JewelsDatasetSummary, JewelsDryrunResult, JewelsExportResult, JewelsGradeResult, JewelsGrading, JewelsOverviewResult, JewelsPairResult, JewelsPairsResult, JewelsQueueResult, JewelsResolveResult, JewelsRunResult, JewelsRunsResult, JewelsTimeseriesBucket, JewelsTimeseriesResult, JewelsTrainResult, LiftedDatabase, MethodsInvokeResult, OperationProgress, OutboundDnsInstructions, OutboundDnsRecord, OutboundEmailDomainAddResult, OutboundEmailDomainCheckResult, OutboundEmailDomainDeleteResult, OutboundEmailDomainUiStatus, OutboundEmailDomainVerifyResult, OutboundEmailDomainView, OutboundEmailDomainsListResult, PlatformSuppression, PrerenderGetResult, PrerenderInvalidateResult, PrerenderPage, PrerenderPagesResult, PrerenderViewResult, PreviewShareLink, PreviewShareListResult, PreviewShareResult, PreviewShareRevokeResult, RegisteredDomainConnection, RegisteredDomainOffer, RegisteredDomainQuote, RegisteredDomainRecordType, RegisteredDomainRecords, RegisteredDomainStatus, RegisteredDomainView, RegisteredDomainZoneRecord, RegisteredDomainsBuyResult, RegisteredDomainsContactResult, RegisteredDomainsContactSetResult, RegisteredDomainsListResult, RegisteredDomainsQuoteResult, RegisteredDomainsRecordDeleteResult, RegisteredDomainsRecordResult, RegisteredDomainsSearchResult, RegisteredDomainsZoneResult, RegistrantContact, ReleaseFailureFields, ReleaseFragment, ReleasesByCommitResult, ReleasesGetResult, ReleasesListResult, RequestsGetResult, RequestsListResult, RequestsListRow, RequestsStatsMethodBucket, RequestsStatsMethodResult, RequestsStatsSummaryBucket, RequestsStatsSummaryResult, SecretsDeleteResult, SecretsGetResult, SecretsListResult, SecretsSetResult, SettingsResult, SuppressionSource, TaskTraceOutcome, TaskTraceSummary, TaskTranscriptMessage, TaskTurnError, TasksGetResult, TasksListResult, TrainingLogEntry, TrainingRunRow, TrainingRunStatus, UsageGroup, UsageGroupBy, UsageSummaryResult, UserAuthProvider, UserListItem, UserRecord, UsersCreateApiKeyResult, UsersListResult, UsersRevokeApiKeyResult, UsersSetRoleResult, V2AppSettings, V2BuildLogEntry, V2BuildStats, V2CommitInfo, V2EmailMessage, V2ReleaseStatus, VoiceAvailableNumber, VoiceNumbersBuyResult, VoiceNumbersListResult, VoiceNumbersReleaseResult, VoiceNumbersSearchResult, VoiceNumbersSetNameResult, VoicePhoneNumberStatus, VoicePhoneNumberView, VoiceResolvedPolicy, VoiceSessionChannel, VoiceSessionCost, VoiceSessionCostLine, VoiceSessionDetail, VoiceSessionGetResult, VoiceSessionListItem, VoiceSessionSip, VoiceSessionSpeechEntry, VoiceSessionStatus, VoiceSessionToolEntry, VoiceSessionTranscriptEntry, VoiceSessionsListResult, VoiceSettingsCeilings, VoiceSettingsGetResult, VoiceSettingsOverrides, VoiceSettingsSetResult, WorkspaceApp, WorkspaceRegistrantContact };
|
package/dist/index.js
CHANGED
|
@@ -260,8 +260,10 @@ __export(analytics_exports, {
|
|
|
260
260
|
aiSources: () => aiSources,
|
|
261
261
|
batch: () => batch,
|
|
262
262
|
crawlers: () => crawlers,
|
|
263
|
+
funnel: () => funnel,
|
|
263
264
|
live: () => live,
|
|
264
265
|
map: () => map,
|
|
266
|
+
paths: () => paths,
|
|
265
267
|
query: () => query,
|
|
266
268
|
sources: () => sources
|
|
267
269
|
});
|
|
@@ -281,6 +283,22 @@ function batch(ctx, queries) {
|
|
|
281
283
|
{ queries }
|
|
282
284
|
);
|
|
283
285
|
}
|
|
286
|
+
function funnel(ctx, body) {
|
|
287
|
+
return call(
|
|
288
|
+
ctx,
|
|
289
|
+
"POST",
|
|
290
|
+
`/_internal/v2/apps/${ctx.appId}/insights/funnel`,
|
|
291
|
+
body
|
|
292
|
+
);
|
|
293
|
+
}
|
|
294
|
+
function paths(ctx, body) {
|
|
295
|
+
return call(
|
|
296
|
+
ctx,
|
|
297
|
+
"POST",
|
|
298
|
+
`/_internal/v2/apps/${ctx.appId}/insights/paths`,
|
|
299
|
+
body
|
|
300
|
+
);
|
|
301
|
+
}
|
|
284
302
|
function sources(ctx, params = {}) {
|
|
285
303
|
return call(
|
|
286
304
|
ctx,
|
|
@@ -2758,7 +2776,7 @@ function view(ctx, params) {
|
|
|
2758
2776
|
return call(
|
|
2759
2777
|
ctx,
|
|
2760
2778
|
"GET",
|
|
2761
|
-
`/_internal/v2/apps/${ctx.appId}/prerender/pages/view${qs({ path: params.path })}`
|
|
2779
|
+
`/_internal/v2/apps/${ctx.appId}/prerender/pages/view${qs({ path: params.path, host: params.host })}`
|
|
2762
2780
|
);
|
|
2763
2781
|
}
|
|
2764
2782
|
function invalidate(ctx, params = {}) {
|