zorihq 0.11.0 → 0.12.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 +12 -0
- package/package.json +1 -1
- package/resources/v1/analytics/analytics.d.mts +13 -43
- package/resources/v1/analytics/analytics.d.mts.map +1 -1
- package/resources/v1/analytics/analytics.d.ts +13 -43
- package/resources/v1/analytics/analytics.d.ts.map +1 -1
- package/resources/v1/analytics/analytics.js +4 -2
- package/resources/v1/analytics/analytics.js.map +1 -1
- package/resources/v1/analytics/analytics.mjs +4 -2
- package/resources/v1/analytics/analytics.mjs.map +1 -1
- package/resources/v1/analytics/events.d.mts +30 -42
- package/resources/v1/analytics/events.d.mts.map +1 -1
- package/resources/v1/analytics/events.d.ts +30 -42
- package/resources/v1/analytics/events.d.ts.map +1 -1
- package/resources/v1/analytics/events.js +8 -2
- package/resources/v1/analytics/events.js.map +1 -1
- package/resources/v1/analytics/events.mjs +8 -2
- package/resources/v1/analytics/events.mjs.map +1 -1
- package/resources/v1/analytics/retention.d.mts +39 -34
- package/resources/v1/analytics/retention.d.mts.map +1 -1
- package/resources/v1/analytics/retention.d.ts +39 -34
- package/resources/v1/analytics/retention.d.ts.map +1 -1
- package/resources/v1/analytics/retention.js +12 -6
- package/resources/v1/analytics/retention.js.map +1 -1
- package/resources/v1/analytics/retention.mjs +12 -6
- package/resources/v1/analytics/retention.mjs.map +1 -1
- package/resources/v1/analytics/sessions.d.mts +26 -24
- package/resources/v1/analytics/sessions.d.mts.map +1 -1
- package/resources/v1/analytics/sessions.d.ts +26 -24
- package/resources/v1/analytics/sessions.d.ts.map +1 -1
- package/resources/v1/analytics/sessions.js +8 -4
- package/resources/v1/analytics/sessions.js.map +1 -1
- package/resources/v1/analytics/sessions.mjs +8 -4
- package/resources/v1/analytics/sessions.mjs.map +1 -1
- package/resources/v1/analytics/users.d.mts +13 -5
- package/resources/v1/analytics/users.d.mts.map +1 -1
- package/resources/v1/analytics/users.d.ts +13 -5
- package/resources/v1/analytics/users.d.ts.map +1 -1
- package/resources/v1/analytics/users.js +4 -1
- package/resources/v1/analytics/users.js.map +1 -1
- package/resources/v1/analytics/users.mjs +4 -1
- package/resources/v1/analytics/users.mjs.map +1 -1
- package/resources/v1/analytics/visitors.d.mts +78 -64
- package/resources/v1/analytics/visitors.d.mts.map +1 -1
- package/resources/v1/analytics/visitors.d.ts +78 -64
- package/resources/v1/analytics/visitors.d.ts.map +1 -1
- package/resources/v1/analytics/visitors.js +24 -12
- package/resources/v1/analytics/visitors.js.map +1 -1
- package/resources/v1/analytics/visitors.mjs +24 -12
- package/resources/v1/analytics/visitors.mjs.map +1 -1
- package/resources/v1/index.d.mts +1 -1
- package/resources/v1/index.d.ts +1 -1
- package/resources/v1/index.js +4 -4
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs +1 -1
- package/resources/v1/payment-providers/index.d.mts +3 -0
- package/resources/v1/payment-providers/index.d.mts.map +1 -0
- package/resources/v1/payment-providers/index.d.ts +3 -0
- package/resources/v1/payment-providers/index.d.ts.map +1 -0
- package/resources/v1/payment-providers/index.js +9 -0
- package/resources/v1/payment-providers/index.js.map +1 -0
- package/resources/v1/payment-providers/index.mjs +4 -0
- package/resources/v1/payment-providers/index.mjs.map +1 -0
- package/resources/v1/payment-providers/payment-providers.d.mts +151 -0
- package/resources/v1/payment-providers/payment-providers.d.mts.map +1 -0
- package/resources/v1/payment-providers/payment-providers.d.ts +151 -0
- package/resources/v1/payment-providers/payment-providers.d.ts.map +1 -0
- package/resources/v1/payment-providers/payment-providers.js +98 -0
- package/resources/v1/payment-providers/payment-providers.js.map +1 -0
- package/resources/v1/payment-providers/payment-providers.mjs +93 -0
- package/resources/v1/payment-providers/payment-providers.mjs.map +1 -0
- package/resources/v1/payment-providers/stripe/app.d.mts +39 -0
- package/resources/v1/payment-providers/stripe/app.d.mts.map +1 -0
- package/resources/v1/payment-providers/stripe/app.d.ts +39 -0
- package/resources/v1/payment-providers/stripe/app.d.ts.map +1 -0
- package/resources/v1/payment-providers/stripe/app.js +24 -0
- package/resources/v1/payment-providers/stripe/app.js.map +1 -0
- package/resources/v1/payment-providers/stripe/app.mjs +20 -0
- package/resources/v1/payment-providers/stripe/app.mjs.map +1 -0
- package/resources/v1/payment-providers/stripe/index.d.mts +3 -0
- package/resources/v1/payment-providers/stripe/index.d.mts.map +1 -0
- package/resources/v1/payment-providers/stripe/index.d.ts +3 -0
- package/resources/v1/payment-providers/stripe/index.d.ts.map +1 -0
- package/resources/v1/payment-providers/stripe/index.js +9 -0
- package/resources/v1/payment-providers/stripe/index.js.map +1 -0
- package/resources/v1/payment-providers/stripe/index.mjs +4 -0
- package/resources/v1/payment-providers/stripe/index.mjs.map +1 -0
- package/resources/v1/payment-providers/stripe/stripe.d.mts +10 -0
- package/resources/v1/payment-providers/stripe/stripe.d.mts.map +1 -0
- package/resources/v1/payment-providers/stripe/stripe.d.ts +10 -0
- package/resources/v1/payment-providers/stripe/stripe.d.ts.map +1 -0
- package/resources/v1/payment-providers/stripe/stripe.js +17 -0
- package/resources/v1/payment-providers/stripe/stripe.js.map +1 -0
- package/resources/v1/payment-providers/stripe/stripe.mjs +12 -0
- package/resources/v1/payment-providers/stripe/stripe.mjs.map +1 -0
- package/resources/v1/payment-providers/stripe.d.mts +2 -0
- package/resources/v1/payment-providers/stripe.d.mts.map +1 -0
- package/resources/v1/payment-providers/stripe.d.ts +2 -0
- package/resources/v1/payment-providers/stripe.d.ts.map +1 -0
- package/resources/v1/payment-providers/stripe.js +6 -0
- package/resources/v1/payment-providers/stripe.js.map +1 -0
- package/resources/v1/payment-providers/stripe.mjs +3 -0
- package/resources/v1/payment-providers/stripe.mjs.map +1 -0
- package/resources/v1/payment-providers.d.mts +1 -149
- package/resources/v1/payment-providers.d.mts.map +1 -1
- package/resources/v1/payment-providers.d.ts +1 -149
- package/resources/v1/payment-providers.d.ts.map +1 -1
- package/resources/v1/payment-providers.js +2 -86
- package/resources/v1/payment-providers.js.map +1 -1
- package/resources/v1/payment-providers.mjs +1 -84
- package/resources/v1/payment-providers.mjs.map +1 -1
- package/resources/v1/revenue/cohort.d.mts +45 -0
- package/resources/v1/revenue/cohort.d.mts.map +1 -0
- package/resources/v1/revenue/cohort.d.ts +45 -0
- package/resources/v1/revenue/cohort.d.ts.map +1 -0
- package/resources/v1/revenue/cohort.js +24 -0
- package/resources/v1/revenue/cohort.js.map +1 -0
- package/resources/v1/revenue/cohort.mjs +20 -0
- package/resources/v1/revenue/cohort.mjs.map +1 -0
- package/resources/v1/revenue/index.d.mts +1 -0
- package/resources/v1/revenue/index.d.mts.map +1 -1
- package/resources/v1/revenue/index.d.ts +1 -0
- package/resources/v1/revenue/index.d.ts.map +1 -1
- package/resources/v1/revenue/index.js +3 -1
- package/resources/v1/revenue/index.js.map +1 -1
- package/resources/v1/revenue/index.mjs +1 -0
- package/resources/v1/revenue/index.mjs.map +1 -1
- package/resources/v1/revenue/revenue.d.mts +6 -75
- package/resources/v1/revenue/revenue.d.mts.map +1 -1
- package/resources/v1/revenue/revenue.d.ts +6 -75
- package/resources/v1/revenue/revenue.d.ts.map +1 -1
- package/resources/v1/revenue/revenue.js +4 -0
- package/resources/v1/revenue/revenue.js.map +1 -1
- package/resources/v1/revenue/revenue.mjs +4 -0
- package/resources/v1/revenue/revenue.mjs.map +1 -1
- package/resources/v1/v1.d.mts +2 -2
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +2 -2
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js +2 -2
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs +2 -2
- package/resources/v1/v1.mjs.map +1 -1
- package/src/resources/v1/analytics/analytics.ts +20 -43
- package/src/resources/v1/analytics/events.ts +42 -42
- package/src/resources/v1/analytics/retention.ts +59 -34
- package/src/resources/v1/analytics/sessions.ts +39 -24
- package/src/resources/v1/analytics/users.ts +21 -5
- package/src/resources/v1/analytics/visitors.ts +119 -64
- package/src/resources/v1/index.ts +1 -1
- package/src/resources/v1/payment-providers/index.ts +17 -0
- package/src/resources/v1/payment-providers/payment-providers.ts +235 -0
- package/src/resources/v1/payment-providers/stripe/app.ts +56 -0
- package/src/resources/v1/payment-providers/stripe/index.ts +4 -0
- package/src/resources/v1/payment-providers/stripe/stripe.ts +19 -0
- package/src/resources/v1/payment-providers/stripe.ts +3 -0
- package/src/resources/v1/payment-providers.ts +1 -228
- package/src/resources/v1/revenue/cohort.ts +72 -0
- package/src/resources/v1/revenue/index.ts +1 -0
- package/src/resources/v1/revenue/revenue.ts +14 -75
- package/src/resources/v1/v1.ts +15 -15
- 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
|
@@ -1,90 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
const path_1 = require("../../internal/utils/path.js");
|
|
7
|
-
class PaymentProviders extends resource_1.APIResource {
|
|
8
|
-
/**
|
|
9
|
-
* Connect a new payment provider to a project
|
|
10
|
-
*
|
|
11
|
-
* @example
|
|
12
|
-
* ```ts
|
|
13
|
-
* const paymentProviderResponse =
|
|
14
|
-
* await client.v1.paymentProviders.create({
|
|
15
|
-
* api_key: 'sk_test_xxxxx',
|
|
16
|
-
* project_id: '550e8400-e29b-41d4-a716-446655440000',
|
|
17
|
-
* provider_type: 'stripe',
|
|
18
|
-
* webhook_secret: 'whsec_xxxxx',
|
|
19
|
-
* });
|
|
20
|
-
* ```
|
|
21
|
-
*/
|
|
22
|
-
create(body, options) {
|
|
23
|
-
return this._client.post('/api/v1/payment-providers', { body, ...options });
|
|
24
|
-
}
|
|
25
|
-
/**
|
|
26
|
-
* Update payment provider credentials or settings
|
|
27
|
-
*
|
|
28
|
-
* @example
|
|
29
|
-
* ```ts
|
|
30
|
-
* const paymentProviderResponse =
|
|
31
|
-
* await client.v1.paymentProviders.update('id');
|
|
32
|
-
* ```
|
|
33
|
-
*/
|
|
34
|
-
update(id, body, options) {
|
|
35
|
-
return this._client.put((0, path_1.path) `/api/v1/payment-providers/${id}`, { body, ...options });
|
|
36
|
-
}
|
|
37
|
-
/**
|
|
38
|
-
* Get all payment providers for the organization
|
|
39
|
-
*
|
|
40
|
-
* @example
|
|
41
|
-
* ```ts
|
|
42
|
-
* const listPaymentProvidersResponse =
|
|
43
|
-
* await client.v1.paymentProviders.list();
|
|
44
|
-
* ```
|
|
45
|
-
*/
|
|
46
|
-
list(query = {}, options) {
|
|
47
|
-
return this._client.get('/api/v1/payment-providers', { query, ...options });
|
|
48
|
-
}
|
|
49
|
-
/**
|
|
50
|
-
* Disconnect a payment provider from a project
|
|
51
|
-
*
|
|
52
|
-
* @example
|
|
53
|
-
* ```ts
|
|
54
|
-
* const paymentProvider =
|
|
55
|
-
* await client.v1.paymentProviders.delete('id');
|
|
56
|
-
* ```
|
|
57
|
-
*/
|
|
58
|
-
delete(id, options) {
|
|
59
|
-
return this._client.delete((0, path_1.path) `/api/v1/payment-providers/${id}`, options);
|
|
60
|
-
}
|
|
61
|
-
/**
|
|
62
|
-
* Get a single payment provider by ID
|
|
63
|
-
*
|
|
64
|
-
* @example
|
|
65
|
-
* ```ts
|
|
66
|
-
* const paymentProviderResponse =
|
|
67
|
-
* await client.v1.paymentProviders.get('id');
|
|
68
|
-
* ```
|
|
69
|
-
*/
|
|
70
|
-
get(id, options) {
|
|
71
|
-
return this._client.get((0, path_1.path) `/api/v1/payment-providers/${id}`, options);
|
|
72
|
-
}
|
|
73
|
-
/**
|
|
74
|
-
* Get instructions for connecting a payment provider (OAuth URL or manual
|
|
75
|
-
* credentials)
|
|
76
|
-
*
|
|
77
|
-
* @example
|
|
78
|
-
* ```ts
|
|
79
|
-
* const providerInstructionsResponse =
|
|
80
|
-
* await client.v1.paymentProviders.instructions({
|
|
81
|
-
* provider_type: 'stripe',
|
|
82
|
-
* });
|
|
83
|
-
* ```
|
|
84
|
-
*/
|
|
85
|
-
instructions(query, options) {
|
|
86
|
-
return this._client.get('/api/v1/payment-providers/instructions', { query, ...options });
|
|
87
|
-
}
|
|
88
|
-
}
|
|
89
|
-
exports.PaymentProviders = PaymentProviders;
|
|
4
|
+
const tslib_1 = require("../../internal/tslib.js");
|
|
5
|
+
tslib_1.__exportStar(require("./payment-providers/index.js"), exports);
|
|
90
6
|
//# sourceMappingURL=payment-providers.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"payment-providers.js","sourceRoot":"","sources":["../../src/resources/v1/payment-providers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,
|
|
1
|
+
{"version":3,"file":"payment-providers.js","sourceRoot":"","sources":["../../src/resources/v1/payment-providers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,uEAA0C"}
|
|
@@ -1,86 +1,3 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
-
|
|
3
|
-
import { path } from "../../internal/utils/path.mjs";
|
|
4
|
-
export class PaymentProviders extends APIResource {
|
|
5
|
-
/**
|
|
6
|
-
* Connect a new payment provider to a project
|
|
7
|
-
*
|
|
8
|
-
* @example
|
|
9
|
-
* ```ts
|
|
10
|
-
* const paymentProviderResponse =
|
|
11
|
-
* await client.v1.paymentProviders.create({
|
|
12
|
-
* api_key: 'sk_test_xxxxx',
|
|
13
|
-
* project_id: '550e8400-e29b-41d4-a716-446655440000',
|
|
14
|
-
* provider_type: 'stripe',
|
|
15
|
-
* webhook_secret: 'whsec_xxxxx',
|
|
16
|
-
* });
|
|
17
|
-
* ```
|
|
18
|
-
*/
|
|
19
|
-
create(body, options) {
|
|
20
|
-
return this._client.post('/api/v1/payment-providers', { body, ...options });
|
|
21
|
-
}
|
|
22
|
-
/**
|
|
23
|
-
* Update payment provider credentials or settings
|
|
24
|
-
*
|
|
25
|
-
* @example
|
|
26
|
-
* ```ts
|
|
27
|
-
* const paymentProviderResponse =
|
|
28
|
-
* await client.v1.paymentProviders.update('id');
|
|
29
|
-
* ```
|
|
30
|
-
*/
|
|
31
|
-
update(id, body, options) {
|
|
32
|
-
return this._client.put(path `/api/v1/payment-providers/${id}`, { body, ...options });
|
|
33
|
-
}
|
|
34
|
-
/**
|
|
35
|
-
* Get all payment providers for the organization
|
|
36
|
-
*
|
|
37
|
-
* @example
|
|
38
|
-
* ```ts
|
|
39
|
-
* const listPaymentProvidersResponse =
|
|
40
|
-
* await client.v1.paymentProviders.list();
|
|
41
|
-
* ```
|
|
42
|
-
*/
|
|
43
|
-
list(query = {}, options) {
|
|
44
|
-
return this._client.get('/api/v1/payment-providers', { query, ...options });
|
|
45
|
-
}
|
|
46
|
-
/**
|
|
47
|
-
* Disconnect a payment provider from a project
|
|
48
|
-
*
|
|
49
|
-
* @example
|
|
50
|
-
* ```ts
|
|
51
|
-
* const paymentProvider =
|
|
52
|
-
* await client.v1.paymentProviders.delete('id');
|
|
53
|
-
* ```
|
|
54
|
-
*/
|
|
55
|
-
delete(id, options) {
|
|
56
|
-
return this._client.delete(path `/api/v1/payment-providers/${id}`, options);
|
|
57
|
-
}
|
|
58
|
-
/**
|
|
59
|
-
* Get a single payment provider by ID
|
|
60
|
-
*
|
|
61
|
-
* @example
|
|
62
|
-
* ```ts
|
|
63
|
-
* const paymentProviderResponse =
|
|
64
|
-
* await client.v1.paymentProviders.get('id');
|
|
65
|
-
* ```
|
|
66
|
-
*/
|
|
67
|
-
get(id, options) {
|
|
68
|
-
return this._client.get(path `/api/v1/payment-providers/${id}`, options);
|
|
69
|
-
}
|
|
70
|
-
/**
|
|
71
|
-
* Get instructions for connecting a payment provider (OAuth URL or manual
|
|
72
|
-
* credentials)
|
|
73
|
-
*
|
|
74
|
-
* @example
|
|
75
|
-
* ```ts
|
|
76
|
-
* const providerInstructionsResponse =
|
|
77
|
-
* await client.v1.paymentProviders.instructions({
|
|
78
|
-
* provider_type: 'stripe',
|
|
79
|
-
* });
|
|
80
|
-
* ```
|
|
81
|
-
*/
|
|
82
|
-
instructions(query, options) {
|
|
83
|
-
return this._client.get('/api/v1/payment-providers/instructions', { query, ...options });
|
|
84
|
-
}
|
|
85
|
-
}
|
|
2
|
+
export * from "./payment-providers/index.mjs";
|
|
86
3
|
//# sourceMappingURL=payment-providers.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"payment-providers.mjs","sourceRoot":"","sources":["../../src/resources/v1/payment-providers.ts"],"names":[],"mappings":"AAAA,sFAAsF
|
|
1
|
+
{"version":3,"file":"payment-providers.mjs","sourceRoot":"","sources":["../../src/resources/v1/payment-providers.ts"],"names":[],"mappings":"AAAA,sFAAsF"}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import { APIResource } from "../../../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../../../core/api-promise.mjs";
|
|
3
|
+
import { RequestOptions } from "../../../internal/request-options.mjs";
|
|
4
|
+
export declare class Cohort extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Analyze revenue metrics for a specific cohort of visitors, including total
|
|
7
|
+
* revenue, conversion rates, and time to first purchase
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* const response = await client.v1.revenue.cohort.getMetrics({
|
|
12
|
+
* project_id: 'project_id',
|
|
13
|
+
* visitor_ids: ['string'],
|
|
14
|
+
* });
|
|
15
|
+
* ```
|
|
16
|
+
*/
|
|
17
|
+
getMetrics(body: CohortGetMetricsParams, options?: RequestOptions): APIPromise<CohortGetMetricsResponse>;
|
|
18
|
+
}
|
|
19
|
+
export interface CohortGetMetricsResponse {
|
|
20
|
+
anonymous_customers?: number;
|
|
21
|
+
avg_order_value?: number;
|
|
22
|
+
avg_payments_per_customer?: number;
|
|
23
|
+
avg_revenue_per_customer?: number;
|
|
24
|
+
avg_revenue_per_visitor?: number;
|
|
25
|
+
avg_time_to_first_purchase_hours?: number;
|
|
26
|
+
conversion_rate?: number;
|
|
27
|
+
currency?: string;
|
|
28
|
+
identified_customers?: number;
|
|
29
|
+
median_time_to_first_purchase_hours?: number;
|
|
30
|
+
paying_customers?: number;
|
|
31
|
+
total_customers?: number;
|
|
32
|
+
total_payments?: number;
|
|
33
|
+
total_revenue?: number;
|
|
34
|
+
total_visitors?: number;
|
|
35
|
+
visitor_conversion_rate?: number;
|
|
36
|
+
}
|
|
37
|
+
export interface CohortGetMetricsParams {
|
|
38
|
+
project_id: string;
|
|
39
|
+
visitor_ids: Array<string>;
|
|
40
|
+
time_range?: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
41
|
+
}
|
|
42
|
+
export declare namespace Cohort {
|
|
43
|
+
export { type CohortGetMetricsResponse as CohortGetMetricsResponse, type CohortGetMetricsParams as CohortGetMetricsParams, };
|
|
44
|
+
}
|
|
45
|
+
//# sourceMappingURL=cohort.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cohort.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/revenue/cohort.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAGzG;AAED,MAAM,WAAW,wBAAwB;IACvC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC,gCAAgC,CAAC,EAAE,MAAM,CAAC;IAE1C,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,mCAAmC,CAAC,EAAE,MAAM,CAAC;IAE7C,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B,UAAU,CAAC,EAAE,WAAW,GAAG,OAAO,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;CACtF;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import { APIResource } from "../../../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../../../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../../../internal/request-options.js";
|
|
4
|
+
export declare class Cohort extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Analyze revenue metrics for a specific cohort of visitors, including total
|
|
7
|
+
* revenue, conversion rates, and time to first purchase
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* const response = await client.v1.revenue.cohort.getMetrics({
|
|
12
|
+
* project_id: 'project_id',
|
|
13
|
+
* visitor_ids: ['string'],
|
|
14
|
+
* });
|
|
15
|
+
* ```
|
|
16
|
+
*/
|
|
17
|
+
getMetrics(body: CohortGetMetricsParams, options?: RequestOptions): APIPromise<CohortGetMetricsResponse>;
|
|
18
|
+
}
|
|
19
|
+
export interface CohortGetMetricsResponse {
|
|
20
|
+
anonymous_customers?: number;
|
|
21
|
+
avg_order_value?: number;
|
|
22
|
+
avg_payments_per_customer?: number;
|
|
23
|
+
avg_revenue_per_customer?: number;
|
|
24
|
+
avg_revenue_per_visitor?: number;
|
|
25
|
+
avg_time_to_first_purchase_hours?: number;
|
|
26
|
+
conversion_rate?: number;
|
|
27
|
+
currency?: string;
|
|
28
|
+
identified_customers?: number;
|
|
29
|
+
median_time_to_first_purchase_hours?: number;
|
|
30
|
+
paying_customers?: number;
|
|
31
|
+
total_customers?: number;
|
|
32
|
+
total_payments?: number;
|
|
33
|
+
total_revenue?: number;
|
|
34
|
+
total_visitors?: number;
|
|
35
|
+
visitor_conversion_rate?: number;
|
|
36
|
+
}
|
|
37
|
+
export interface CohortGetMetricsParams {
|
|
38
|
+
project_id: string;
|
|
39
|
+
visitor_ids: Array<string>;
|
|
40
|
+
time_range?: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
|
|
41
|
+
}
|
|
42
|
+
export declare namespace Cohort {
|
|
43
|
+
export { type CohortGetMetricsResponse as CohortGetMetricsResponse, type CohortGetMetricsParams as CohortGetMetricsParams, };
|
|
44
|
+
}
|
|
45
|
+
//# sourceMappingURL=cohort.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cohort.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/revenue/cohort.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAGzG;AAED,MAAM,WAAW,wBAAwB;IACvC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC,gCAAgC,CAAC,EAAE,MAAM,CAAC;IAE1C,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,mCAAmC,CAAC,EAAE,MAAM,CAAC;IAE7C,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B,UAAU,CAAC,EAAE,WAAW,GAAG,OAAO,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;CACtF;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Cohort = void 0;
|
|
5
|
+
const resource_1 = require("../../../core/resource.js");
|
|
6
|
+
class Cohort extends resource_1.APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Analyze revenue metrics for a specific cohort of visitors, including total
|
|
9
|
+
* revenue, conversion rates, and time to first purchase
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```ts
|
|
13
|
+
* const response = await client.v1.revenue.cohort.getMetrics({
|
|
14
|
+
* project_id: 'project_id',
|
|
15
|
+
* visitor_ids: ['string'],
|
|
16
|
+
* });
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
19
|
+
getMetrics(body, options) {
|
|
20
|
+
return this._client.post('/api/v1/revenue/cohort/metrics', { body, ...options });
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
exports.Cohort = Cohort;
|
|
24
|
+
//# sourceMappingURL=cohort.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cohort.js","sourceRoot":"","sources":["../../../src/resources/v1/revenue/cohort.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,IAA4B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;CACF;AAhBD,wBAgBC"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../../core/resource.mjs";
|
|
3
|
+
export class Cohort extends APIResource {
|
|
4
|
+
/**
|
|
5
|
+
* Analyze revenue metrics for a specific cohort of visitors, including total
|
|
6
|
+
* revenue, conversion rates, and time to first purchase
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```ts
|
|
10
|
+
* const response = await client.v1.revenue.cohort.getMetrics({
|
|
11
|
+
* project_id: 'project_id',
|
|
12
|
+
* visitor_ids: ['string'],
|
|
13
|
+
* });
|
|
14
|
+
* ```
|
|
15
|
+
*/
|
|
16
|
+
getMetrics(body, options) {
|
|
17
|
+
return this._client.post('/api/v1/revenue/cohort/metrics', { body, ...options });
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
//# sourceMappingURL=cohort.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cohort.mjs","sourceRoot":"","sources":["../../../src/resources/v1/revenue/cohort.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,IAA4B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;CACF"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export { Attribution, type AttributionByOriginParams, type AttributionByUtmParams } from "./attribution.mjs";
|
|
2
|
+
export { Cohort, type CohortGetMetricsResponse, type CohortGetMetricsParams } from "./cohort.mjs";
|
|
2
3
|
export { Conversion, type ConversionMetricsParams } from "./conversion.mjs";
|
|
3
4
|
export { Customers, type CustomerProfileParams, type CustomerTopParams } from "./customers.mjs";
|
|
4
5
|
export { Revenue, type AttributionByOriginResponse, type AttributionByUtmResponse, type ConversionMetricsResponse, type CustomerProfileResponse, type DashboardResponse, type OriginAttributionDataPoint, type Payment, type RevenueOverTimeDataPoint, type TimelineDataPoint, type TimelineResponse, type TopCustomer, type TopCustomersResponse, type UtmAttributionDataPoint, type RevenueDashboardParams, type RevenueTimelineParams, } from "./revenue.mjs";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/revenue/index.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE,KAAK,yBAAyB,EAAE,KAAK,sBAAsB,EAAE;OAC5E,EAAE,UAAU,EAAE,KAAK,uBAAuB,EAAE;OAC5C,EAAE,SAAS,EAAE,KAAK,qBAAqB,EAAE,KAAK,iBAAiB,EAAE;OACjE,EACL,OAAO,EACP,KAAK,2BAA2B,EAChC,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,iBAAiB,EACtB,KAAK,0BAA0B,EAC/B,KAAK,OAAO,EACZ,KAAK,wBAAwB,EAC7B,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,GAC3B"}
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/revenue/index.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE,KAAK,yBAAyB,EAAE,KAAK,sBAAsB,EAAE;OAC5E,EAAE,MAAM,EAAE,KAAK,wBAAwB,EAAE,KAAK,sBAAsB,EAAE;OACtE,EAAE,UAAU,EAAE,KAAK,uBAAuB,EAAE;OAC5C,EAAE,SAAS,EAAE,KAAK,qBAAqB,EAAE,KAAK,iBAAiB,EAAE;OACjE,EACL,OAAO,EACP,KAAK,2BAA2B,EAChC,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,iBAAiB,EACtB,KAAK,0BAA0B,EAC/B,KAAK,OAAO,EACZ,KAAK,wBAAwB,EAC7B,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,GAC3B"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export { Attribution, type AttributionByOriginParams, type AttributionByUtmParams } from "./attribution.js";
|
|
2
|
+
export { Cohort, type CohortGetMetricsResponse, type CohortGetMetricsParams } from "./cohort.js";
|
|
2
3
|
export { Conversion, type ConversionMetricsParams } from "./conversion.js";
|
|
3
4
|
export { Customers, type CustomerProfileParams, type CustomerTopParams } from "./customers.js";
|
|
4
5
|
export { Revenue, type AttributionByOriginResponse, type AttributionByUtmResponse, type ConversionMetricsResponse, type CustomerProfileResponse, type DashboardResponse, type OriginAttributionDataPoint, type Payment, type RevenueOverTimeDataPoint, type TimelineDataPoint, type TimelineResponse, type TopCustomer, type TopCustomersResponse, type UtmAttributionDataPoint, type RevenueDashboardParams, type RevenueTimelineParams, } from "./revenue.js";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/revenue/index.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE,KAAK,yBAAyB,EAAE,KAAK,sBAAsB,EAAE;OAC5E,EAAE,UAAU,EAAE,KAAK,uBAAuB,EAAE;OAC5C,EAAE,SAAS,EAAE,KAAK,qBAAqB,EAAE,KAAK,iBAAiB,EAAE;OACjE,EACL,OAAO,EACP,KAAK,2BAA2B,EAChC,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,iBAAiB,EACtB,KAAK,0BAA0B,EAC/B,KAAK,OAAO,EACZ,KAAK,wBAAwB,EAC7B,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,GAC3B"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/revenue/index.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE,KAAK,yBAAyB,EAAE,KAAK,sBAAsB,EAAE;OAC5E,EAAE,MAAM,EAAE,KAAK,wBAAwB,EAAE,KAAK,sBAAsB,EAAE;OACtE,EAAE,UAAU,EAAE,KAAK,uBAAuB,EAAE;OAC5C,EAAE,SAAS,EAAE,KAAK,qBAAqB,EAAE,KAAK,iBAAiB,EAAE;OACjE,EACL,OAAO,EACP,KAAK,2BAA2B,EAChC,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,iBAAiB,EACtB,KAAK,0BAA0B,EAC/B,KAAK,OAAO,EACZ,KAAK,wBAAwB,EAC7B,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,GAC3B"}
|
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.Revenue = exports.Customers = exports.Conversion = exports.Attribution = void 0;
|
|
4
|
+
exports.Revenue = exports.Customers = exports.Conversion = exports.Cohort = exports.Attribution = void 0;
|
|
5
5
|
var attribution_1 = require("./attribution.js");
|
|
6
6
|
Object.defineProperty(exports, "Attribution", { enumerable: true, get: function () { return attribution_1.Attribution; } });
|
|
7
|
+
var cohort_1 = require("./cohort.js");
|
|
8
|
+
Object.defineProperty(exports, "Cohort", { enumerable: true, get: function () { return cohort_1.Cohort; } });
|
|
7
9
|
var conversion_1 = require("./conversion.js");
|
|
8
10
|
Object.defineProperty(exports, "Conversion", { enumerable: true, get: function () { return conversion_1.Conversion; } });
|
|
9
11
|
var customers_1 = require("./customers.js");
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/v1/revenue/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAAyG;AAAhG,0GAAA,WAAW,OAAA;AACpB,8CAAwE;AAA/D,wGAAA,UAAU,OAAA;AACnB,4CAA4F;AAAnF,sGAAA,SAAS,OAAA;AAClB,wCAiBmB;AAhBjB,kGAAA,OAAO,OAAA"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/v1/revenue/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAAyG;AAAhG,0GAAA,WAAW,OAAA;AACpB,sCAA8F;AAArF,gGAAA,MAAM,OAAA;AACf,8CAAwE;AAA/D,wGAAA,UAAU,OAAA;AACnB,4CAA4F;AAAnF,sGAAA,SAAS,OAAA;AAClB,wCAiBmB;AAhBjB,kGAAA,OAAO,OAAA"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
export { Attribution } from "./attribution.mjs";
|
|
3
|
+
export { Cohort } from "./cohort.mjs";
|
|
3
4
|
export { Conversion } from "./conversion.mjs";
|
|
4
5
|
export { Customers } from "./customers.mjs";
|
|
5
6
|
export { Revenue, } from "./revenue.mjs";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/v1/revenue/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAA+D;OAC5E,EAAE,UAAU,EAAgC;OAC5C,EAAE,SAAS,EAAsD;OACjE,EACL,OAAO,GAgBR"}
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/v1/revenue/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAA+D;OAC5E,EAAE,MAAM,EAA8D;OACtE,EAAE,UAAU,EAAgC;OAC5C,EAAE,SAAS,EAAsD;OACjE,EACL,OAAO,GAgBR"}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { APIResource } from "../../../core/resource.mjs";
|
|
2
2
|
import * as AttributionAPI from "./attribution.mjs";
|
|
3
3
|
import { Attribution, AttributionByOriginParams, AttributionByUtmParams } from "./attribution.mjs";
|
|
4
|
+
import * as CohortAPI from "./cohort.mjs";
|
|
5
|
+
import { Cohort, CohortGetMetricsParams, CohortGetMetricsResponse } from "./cohort.mjs";
|
|
4
6
|
import * as ConversionAPI from "./conversion.mjs";
|
|
5
7
|
import { Conversion, ConversionMetricsParams } from "./conversion.mjs";
|
|
6
8
|
import * as CustomersAPI from "./customers.mjs";
|
|
@@ -11,6 +13,7 @@ export declare class Revenue extends APIResource {
|
|
|
11
13
|
attribution: AttributionAPI.Attribution;
|
|
12
14
|
customers: CustomersAPI.Customers;
|
|
13
15
|
conversion: ConversionAPI.Conversion;
|
|
16
|
+
cohort: CohortAPI.Cohort;
|
|
14
17
|
/**
|
|
15
18
|
* Get key revenue metrics including total revenue, conversion rate, and average
|
|
16
19
|
* order value
|
|
@@ -44,23 +47,11 @@ export interface AttributionByUtmResponse {
|
|
|
44
47
|
}
|
|
45
48
|
export interface ConversionMetricsResponse {
|
|
46
49
|
avg_purchases_per_customer?: number;
|
|
47
|
-
/**
|
|
48
|
-
* Time to conversion
|
|
49
|
-
*/
|
|
50
50
|
avg_time_to_first_purchase_hours?: number;
|
|
51
|
-
/**
|
|
52
|
-
* % of visitors who paid
|
|
53
|
-
*/
|
|
54
51
|
conversion_rate?: number;
|
|
55
|
-
/**
|
|
56
|
-
* Customer value
|
|
57
|
-
*/
|
|
58
52
|
customer_lifetime_value?: number;
|
|
59
53
|
median_time_to_first_purchase_hours?: number;
|
|
60
54
|
paying_customers?: number;
|
|
61
|
-
/**
|
|
62
|
-
* Repeat purchase metrics
|
|
63
|
-
*/
|
|
64
55
|
repeat_purchase_rate?: number;
|
|
65
56
|
total_visitors?: number;
|
|
66
57
|
}
|
|
@@ -70,9 +61,6 @@ export interface CustomerProfileResponse {
|
|
|
70
61
|
email?: string;
|
|
71
62
|
external_id?: string;
|
|
72
63
|
first_payment_date?: string;
|
|
73
|
-
/**
|
|
74
|
-
* Attribution
|
|
75
|
-
*/
|
|
76
64
|
first_traffic_origin?: string;
|
|
77
65
|
first_utm_campaign?: string;
|
|
78
66
|
first_utm_medium?: string;
|
|
@@ -80,78 +68,33 @@ export interface CustomerProfileResponse {
|
|
|
80
68
|
last_payment_date?: string;
|
|
81
69
|
name?: string;
|
|
82
70
|
payment_count?: number;
|
|
83
|
-
/**
|
|
84
|
-
* Payment history
|
|
85
|
-
*/
|
|
86
71
|
payments?: Array<Payment>;
|
|
87
|
-
/**
|
|
88
|
-
* Revenue over time (last 90 days)
|
|
89
|
-
*/
|
|
90
72
|
revenue_over_time?: Array<RevenueOverTimeDataPoint>;
|
|
91
|
-
/**
|
|
92
|
-
* Revenue summary
|
|
93
|
-
*/
|
|
94
73
|
total_revenue?: number;
|
|
95
74
|
user_id?: string;
|
|
96
|
-
/**
|
|
97
|
-
* Identity
|
|
98
|
-
*/
|
|
99
75
|
visitor_id?: string;
|
|
100
76
|
}
|
|
101
77
|
export interface DashboardResponse {
|
|
102
|
-
/**
|
|
103
|
-
* Average metrics
|
|
104
|
-
*/
|
|
105
78
|
avg_order_value?: number;
|
|
106
|
-
/**
|
|
107
|
-
* Average revenue per paying customer
|
|
108
|
-
*/
|
|
109
79
|
avg_revenue_per_customer?: number;
|
|
110
80
|
avg_revenue_per_identified_customer?: number;
|
|
111
|
-
/**
|
|
112
|
-
* Average revenue per session
|
|
113
|
-
*/
|
|
114
81
|
avg_revenue_per_session?: number;
|
|
115
|
-
/**
|
|
116
|
-
* % of visitors who paid
|
|
117
|
-
*/
|
|
118
82
|
conversion_rate?: number;
|
|
119
83
|
currency?: string;
|
|
120
84
|
identified_customer_revenue?: number;
|
|
121
|
-
/**
|
|
122
|
-
* Identified customers (have email/user_id)
|
|
123
|
-
*/
|
|
124
85
|
identified_customers?: number;
|
|
125
|
-
/**
|
|
126
|
-
* Customer metrics
|
|
127
|
-
*/
|
|
128
86
|
paying_customers?: number;
|
|
129
|
-
/**
|
|
130
|
-
* Count of successful payments
|
|
131
|
-
*/
|
|
132
87
|
total_payments?: number;
|
|
133
|
-
/**
|
|
134
|
-
* Core revenue metrics
|
|
135
|
-
*/
|
|
136
88
|
total_revenue?: number;
|
|
137
89
|
}
|
|
138
90
|
export interface OriginAttributionDataPoint {
|
|
139
|
-
/**
|
|
140
|
-
* Average revenue per paying customer
|
|
141
|
-
*/
|
|
142
91
|
avg_revenue_per_customer?: number;
|
|
143
|
-
/**
|
|
144
|
-
* paying_customers / unique_visitors \* 100
|
|
145
|
-
*/
|
|
146
92
|
conversion_rate?: number;
|
|
147
93
|
currency?: string;
|
|
148
94
|
origin?: string;
|
|
149
95
|
paying_customers?: number;
|
|
150
96
|
payment_count?: number;
|
|
151
97
|
revenue_percentage?: number;
|
|
152
|
-
/**
|
|
153
|
-
* Revenue in smallest currency unit (cents)
|
|
154
|
-
*/
|
|
155
98
|
total_revenue?: number;
|
|
156
99
|
unique_visitors?: number;
|
|
157
100
|
}
|
|
@@ -173,9 +116,6 @@ export interface TimelineDataPoint {
|
|
|
173
116
|
currency?: string;
|
|
174
117
|
payment_count?: number;
|
|
175
118
|
timestamp?: string;
|
|
176
|
-
/**
|
|
177
|
-
* Revenue in smallest currency unit (cents)
|
|
178
|
-
*/
|
|
179
119
|
total_revenue?: number;
|
|
180
120
|
}
|
|
181
121
|
export interface TimelineResponse {
|
|
@@ -184,6 +124,7 @@ export interface TimelineResponse {
|
|
|
184
124
|
export interface TopCustomer {
|
|
185
125
|
avg_order_value?: number;
|
|
186
126
|
currency?: string;
|
|
127
|
+
customer_id?: string;
|
|
187
128
|
email?: string;
|
|
188
129
|
external_id?: string;
|
|
189
130
|
first_payment_date?: string;
|
|
@@ -192,33 +133,22 @@ export interface TopCustomer {
|
|
|
192
133
|
location_country_iso?: string;
|
|
193
134
|
name?: string;
|
|
194
135
|
payment_count?: number;
|
|
195
|
-
/**
|
|
196
|
-
* Total revenue in smallest currency unit (cents)
|
|
197
|
-
*/
|
|
198
136
|
total_revenue?: number;
|
|
199
137
|
user_id?: string;
|
|
200
138
|
visitor_id?: string;
|
|
139
|
+
visitor_ids?: Array<string>;
|
|
201
140
|
}
|
|
202
141
|
export interface TopCustomersResponse {
|
|
203
142
|
customers?: Array<TopCustomer>;
|
|
204
143
|
total?: number;
|
|
205
144
|
}
|
|
206
145
|
export interface UtmAttributionDataPoint {
|
|
207
|
-
/**
|
|
208
|
-
* Average revenue per paying customer
|
|
209
|
-
*/
|
|
210
146
|
avg_revenue_per_customer?: number;
|
|
211
|
-
/**
|
|
212
|
-
* paying_customers / unique_visitors \* 100
|
|
213
|
-
*/
|
|
214
147
|
conversion_rate?: number;
|
|
215
148
|
currency?: string;
|
|
216
149
|
paying_customers?: number;
|
|
217
150
|
payment_count?: number;
|
|
218
151
|
revenue_percentage?: number;
|
|
219
|
-
/**
|
|
220
|
-
* Revenue in smallest currency unit (cents)
|
|
221
|
-
*/
|
|
222
152
|
total_revenue?: number;
|
|
223
153
|
unique_visitors?: number;
|
|
224
154
|
utm_value?: string;
|
|
@@ -248,5 +178,6 @@ export declare namespace Revenue {
|
|
|
248
178
|
export { Attribution as Attribution, type AttributionByOriginParams as AttributionByOriginParams, type AttributionByUtmParams as AttributionByUtmParams, };
|
|
249
179
|
export { Customers as Customers, type CustomerProfileParams as CustomerProfileParams, type CustomerTopParams as CustomerTopParams, };
|
|
250
180
|
export { Conversion as Conversion, type ConversionMetricsParams as ConversionMetricsParams };
|
|
181
|
+
export { Cohort as Cohort, type CohortGetMetricsResponse as CohortGetMetricsResponse, type CohortGetMetricsParams as CohortGetMetricsParams, };
|
|
251
182
|
}
|
|
252
183
|
//# sourceMappingURL=revenue.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"revenue.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/revenue/revenue.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,EAAE,WAAW,EAAE,yBAAyB,EAAE,sBAAsB,EAAE;OAClE,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE,uBAAuB,EAAE;OACvC,KAAK,YAAY;OACjB,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,SAAS,EAAE;OACvD,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;
|
|
1
|
+
{"version":3,"file":"revenue.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/revenue/revenue.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,EAAE,WAAW,EAAE,yBAAyB,EAAE,sBAAsB,EAAE;OAClE,KAAK,SAAS;OACd,EAAE,MAAM,EAAE,sBAAsB,EAAE,wBAAwB,EAAE;OAC5D,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE,uBAAuB,EAAE;OACvC,KAAK,YAAY;OACjB,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,SAAS,EAAE;OACvD,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;IAClF,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;OAUG;IACH,SAAS,CAAC,KAAK,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAIjG;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,KAAK,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;CAG/F;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,CAAC,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,yBAAyB;IACxC,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC,gCAAgC,CAAC,EAAE,MAAM,CAAC;IAE1C,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC,mCAAmC,CAAC,EAAE,MAAM,CAAC;IAE7C,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,uBAAuB;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAE1B,iBAAiB,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAEpD,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC,mCAAmC,CAAC,EAAE,MAAM,CAAC;IAE7C,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,0BAA0B;IACzC,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,OAAO;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,wBAAwB;IACvC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,WAAW;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAE/B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,uBAAuB;IACtC,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;CACrF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,WAAW,GAAG,OAAO,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,CAAC;CACrF;AAOD,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;IAEF,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;IAEF,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EAAE,UAAU,IAAI,UAAU,EAAE,KAAK,uBAAuB,IAAI,uBAAuB,EAAE,CAAC;IAE7F,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|