diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 9211a0424..44f94a6c5 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -23,6 +23,7 @@ jobs: node-version: 22 cache: "pnpm" - run: pnpm install + - run: pnpm openapi:generate - run: pnpm openapi:check --explicit - run: pnpm check:api-client - run: pnpm build-packages diff --git a/.gitignore b/.gitignore index 15ff7b885..d036ae122 100644 --- a/.gitignore +++ b/.gitignore @@ -21,6 +21,7 @@ next-env.d.ts /build /public/script.js /public/recorder.js +/public/openapi.json /geo /dist /packages/*/dist diff --git a/packages/api-client/src/generated/types.ts b/packages/api-client/src/generated/types.ts index ecadee0df..52387e1b6 100644 --- a/packages/api-client/src/generated/types.ts +++ b/packages/api-client/src/generated/types.ts @@ -2875,12 +2875,15 @@ export type webhooks = Record; export interface components { schemas: { ActiveVisitors: { + /** @description Unique visitor counts for the selected period. */ visitors: number; }; /** @description Standard Umami API error response. */ ApiError: { + /** @description Error details returned when the operation fails. */ error: { code: string; + /** @description Human-readable explanation of the result. */ message: string; status: number; } & { @@ -2888,10 +2891,15 @@ export interface components { }; }; CreateWebsiteRequest: { + /** @description Domain name associated with the resource. */ domain: string; + /** @description Unique identifier of the resource. */ id?: string | null; + /** @description Display name of the resource. */ name: string; + /** @description Identifier used to access a shared resource. */ shareId?: string | null; + /** @description ID of the associated team. */ teamId?: string | null; }; LoginRequest: { @@ -2902,27 +2910,45 @@ export interface components { }; LoginResponse: | { + /** @description Temporary login token used to complete two-factor authentication. */ partialToken: string; - /** @constant */ + /** + * @description Whether login requires a second authentication factor. + * @constant + */ requiresTwoFactor: true; } | { token: string; + /** @description User associated with the resource. */ user: components['schemas']['LoginUser']; }; LoginTeam: { - /** Format: uuid */ + /** + * Format: uuid + * @description Unique identifier of the resource. + */ id: string; + /** @description URL of the logo image. */ logoUrl: string | null; + /** @description Display name of the resource. */ name: string; }; LoginUser: { + /** @description Date and time the record was created. */ createdAt: string | null; - /** Format: uuid */ + /** + * Format: uuid + * @description Unique identifier of the resource. + */ id: string; + /** @description Whether the user has administrator privileges. */ isAdmin: boolean; + /** @description Permission role assigned to the user. */ role: string; + /** @description Teams associated with the user. */ teams: components['schemas']['LoginTeam'][]; + /** @description Username of the account. */ username: string; }; MetricRow: { @@ -2934,30 +2960,43 @@ export interface components { }; MetricRows: components['schemas']['MetricRow'][]; OAuthAuthorizationDecision: { + /** @description OAuth client identifier. */ client_id: string; + /** @description PKCE challenge derived from the code verifier. */ code_challenge?: string; + /** @description Method used to derive the PKCE challenge; use S256. */ code_challenge_method?: string; /** @enum {string} */ decision: 'approve' | 'deny'; + /** @description Registered redirect URI to receive the authorization response. */ redirect_uri?: string; + /** @description Resource URI identifying the API targeted by the OAuth request. */ resource?: string; + /** @description OAuth authorization response type; use code. */ response_type?: string; + /** @description Space-separated OAuth permissions. */ scope?: string; + /** @description Client-provided value returned unchanged to correlate the authorization response. */ state?: string; }; OAuthAuthorizationDetails: { client: { + /** @description Unique identifier of the resource. */ id: string; logoUri?: string; + /** @description Display name of the resource. */ name: string; /** @enum {string} */ source: 'metadata-document' | 'registered'; uri?: string; }; redirectUri: string; + /** @description Resource URI identifying the API targeted by the OAuth request. */ resource: string; scopes: { + /** @description Description of the resource. */ description: string; + /** @description Space-separated OAuth permissions. */ scope: string; }[]; }; @@ -2967,87 +3006,146 @@ export interface components { OAuthClientRegistrationRequest: { /** @enum {string} */ application_type?: 'web' | 'native'; + /** @description Human-readable name of the OAuth client. */ client_name: string; + /** @description URL of the OAuth client homepage. */ client_uri?: string; + /** @description OAuth grant types supported by the client. */ grant_types?: string[]; + /** @description URL of the OAuth client logo. */ logo_uri?: string; + /** @description Redirect URIs registered for the OAuth client. */ redirect_uris: string[]; + /** @description Authorization response types supported by the client. */ response_types?: string[]; + /** @description Space-separated OAuth permissions. */ scope?: string; software_id?: string; software_version?: string; - /** @constant */ + /** + * @description Client authentication method used at the token endpoint. + * @constant + */ token_endpoint_auth_method?: 'none'; }; OAuthClientRegistrationResponse: { /** @enum {string} */ application_type?: 'web' | 'native'; + /** @description OAuth client identifier. */ client_id: string; client_id_issued_at: number; + /** @description Human-readable name of the OAuth client. */ client_name: string; + /** @description URL of the OAuth client homepage. */ client_uri?: string; + /** @description OAuth grant types supported by the client. */ grant_types: string[]; + /** @description URL of the OAuth client logo. */ logo_uri?: string; + /** @description Redirect URIs registered for the OAuth client. */ redirect_uris: string[]; + /** @description Authorization response types supported by the client. */ response_types: string[]; + /** @description Space-separated OAuth permissions. */ scope?: string; software_id?: string; software_version?: string; - /** @constant */ + /** + * @description Client authentication method used at the token endpoint. + * @constant + */ token_endpoint_auth_method: 'none'; }; OAuthErrorResponse: { + /** @description Error details returned when the operation fails. */ error: string; + /** @description Human-readable explanation of the OAuth error. */ error_description?: string; }; OAuthRevocationRequest: { token: string; + /** @description Hint indicating whether the revoked token is an access or refresh token. */ token_type_hint?: string; }; OAuthTokenRequest: { + /** @description OAuth client identifier. */ client_id?: string; code?: string; + /** @description Original PKCE verifier used to obtain the authorization code. */ code_verifier?: string; - /** @enum {string} */ + /** + * @description OAuth grant used to obtain or refresh an access token. + * @enum {string} + */ grant_type: 'authorization_code' | 'refresh_token'; + /** @description Registered redirect URI to receive the authorization response. */ redirect_uri?: string; + /** @description OAuth refresh token used to obtain a new access token. */ refresh_token?: string; + /** @description Resource URI identifying the API targeted by the OAuth request. */ resource?: string; + /** @description Space-separated OAuth permissions. */ scope?: string; }; OAuthTokenResponse: { + /** @description OAuth access token used to authorize API requests. */ access_token: string; + /** @description Access token lifetime in seconds. */ expires_in: number; + /** @description OAuth refresh token used to obtain a new access token. */ refresh_token: string; + /** @description Space-separated OAuth permissions. */ scope: string; - /** @constant */ + /** + * @description Authorization scheme for the access token. + * @constant + */ token_type: 'Bearer'; }; /** @description Successful operation response. */ Ok: { - /** @constant */ + /** + * @description Whether the operation succeeded. + * @constant + */ ok: true; }; ReplayConfig: { + /** @description CSS selector for elements excluded from recordings. */ blockSelector?: string; + /** @description Whether heatmap recording is enabled. */ heatmapEnabled?: boolean; + /** @description Fraction of sessions to record for heatmaps, from 0 to 1. */ heatmapSampleRate?: number; - /** @enum {string} */ + /** + * @description Privacy masking level used by the recorder: strict or moderate. + * @enum {string} + */ maskLevel?: 'strict' | 'moderate'; maxDuration?: number; + /** @description Whether session replay recording is enabled. */ replayEnabled?: boolean; + /** @description Fraction of sessions to record for replay, from 0 to 1. */ sampleRate?: number; } & { [key: string]: unknown; }; ReplayConfigInput: { + /** @description CSS selector for elements excluded from recordings. */ blockSelector?: string; + /** @description Whether heatmap recording is enabled. */ heatmapEnabled?: boolean; + /** @description Fraction of sessions to record for heatmaps, from 0 to 1. */ heatmapSampleRate?: number; - /** @enum {string} */ + /** + * @description Privacy masking level used by the recorder: strict or moderate. + * @enum {string} + */ maskLevel?: 'strict' | 'moderate'; maxDuration?: number; + /** @description Whether session replay recording is enabled. */ replayEnabled?: boolean; + /** @description Fraction of sessions to record for replay, from 0 to 1. */ sampleRate?: number; }; TimeSeriesPoint: { @@ -3057,133 +3155,244 @@ export interface components { y: number; }; UpdateWebsiteRequest: { + /** @description Domain name associated with the resource. */ domain?: string; + /** @description Display name of the resource. */ name?: string; + /** @description Session replay and heatmap recording configuration. */ replayConfig?: components['schemas']['ReplayConfigInput'] | null; + /** @description Identifier used to access a shared resource. */ shareId?: string | null; }; Website: { + /** @description Date and time the record was created. */ createdAt: string | null; + /** @description ID of the user who created the resource. */ createdBy: string | null; + /** @description Date and time the record was deleted, if applicable. */ deletedAt: string | null; + /** @description Domain name associated with the resource. */ domain: string | null; - /** Format: uuid */ + /** + * Format: uuid + * @description Unique identifier of the resource. + */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Whether recording is enabled for the website. */ recorderEnabled: boolean; + /** @description Session replay and heatmap recording configuration. */ replayConfig: components['schemas']['ReplayConfig'] | null; + /** @description Date and time the website analytics were last reset. */ resetAt: string | null; + /** @description Identifier used to access a shared resource. */ shareId: string | null; + /** @description ID of the associated team. */ teamId: string | null; + /** @description Date and time the record was last updated. */ updatedAt: string | null; + /** @description User associated with the resource. */ user?: components['schemas']['WebsiteUser']; + /** @description ID of the associated user. */ userId: string | null; }; WebsiteEvent: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string | null; + /** @description Name of the custom event. */ eventName?: string | null; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType: number; + /** @description Hostname on which the activity occurred. */ hostname?: string | null; - /** Format: uuid */ + /** + * Format: uuid + * @description Unique identifier of the resource. + */ id: string; + /** @description Title of the page. */ pageTitle?: string | null; + /** @description Domain of the referring page. */ referrerDomain?: string | null; - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the visitor session. + */ sessionId: string; + /** @description Path portion of the page URL. */ urlPath?: string | null; + /** @description Query string portion of the page URL. */ urlQuery?: string | null; - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the website. + */ websiteId: string; } & { [key: string]: unknown; }; WebsiteEventPage: { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: components['schemas']['WebsiteEvent'][]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; }; WebsitePage: { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: components['schemas']['Website'][]; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; }; WebsitePageviews: { /** @description Present when `compare` was requested. */ compare?: { - /** Format: date-time */ + /** + * Format: date-time + * @description End of the date range as an ISO 8601 date or date-time. + */ endDate: string; + /** @description Pageview counts for the selected period. */ pageviews: components['schemas']['TimeSeriesPoint'][]; sessions: components['schemas']['TimeSeriesPoint'][]; - /** Format: date-time */ + /** + * Format: date-time + * @description Start of the date range as an ISO 8601 date or date-time. + */ startDate: string; }; - /** Format: date-time */ + /** + * Format: date-time + * @description End of the date range as an ISO 8601 date or date-time. + */ endDate?: string; + /** @description Pageview counts for the selected period. */ pageviews: components['schemas']['TimeSeriesPoint'][]; sessions: components['schemas']['TimeSeriesPoint'][]; - /** Format: date-time */ + /** + * Format: date-time + * @description Start of the date range as an ISO 8601 date or date-time. + */ startDate?: string; }; WebsiteSession: { + /** @description Browser used by the visitor. */ browser: string | null; + /** @description City of the visitor. */ city: string | null; + /** @description Country code of the visitor. */ country: string | null; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Device category used by the visitor. */ device: string | null; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string | null; events?: number; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time of the first recorded activity. + */ firstAt: string; + /** @description Hostname on which the activity occurred. */ hostname: string | null; - /** Format: uuid */ + /** + * Format: uuid + * @description Unique identifier of the resource. + */ id: string; + /** @description Preferred language reported by the visitor browser. */ language: string | null; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time of the most recent recorded activity. + */ lastAt: string; + /** @description Operating system used by the visitor. */ os: string | null; + /** @description Region or subdivision of the visitor. */ region: string | null; + /** @description Screen resolution of the visitor device. */ screen: string | null; + /** @description Pageview counts for the selected period. */ views: number; + /** @description Visit counts for the selected period. */ visits: number; - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the website. + */ websiteId: string; } & { [key: string]: unknown; }; WebsiteSessionPage: { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: components['schemas']['WebsiteSession'][]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; }; WebsiteStats: { + /** @description Number of visits with only one pageview. */ bounces: number; /** @description The same totals for the comparison period (previous period by default). */ comparison: components['schemas']['WebsiteStatsValues']; + /** @description Pageview counts for the selected period. */ pageviews: number; + /** @description Total visit duration in seconds. */ totaltime: number; + /** @description Unique visitor counts for the selected period. */ visitors: number; + /** @description Visit counts for the selected period. */ visits: number; }; WebsiteStatsValues: { + /** @description Number of visits with only one pageview. */ bounces: number; + /** @description Pageview counts for the selected period. */ pageviews: number; + /** @description Total visit duration in seconds. */ totaltime: number; + /** @description Unique visitor counts for the selected period. */ visitors: number; + /** @description Visit counts for the selected period. */ visits: number; }; WebsiteUser: { - /** Format: uuid */ + /** + * Format: uuid + * @description Unique identifier of the resource. + */ id: string; + /** @description Username of the account. */ username: string; }; }; @@ -3332,6 +3541,7 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Password used to authenticate the account. */ password: string; token: string; }; @@ -3346,14 +3556,20 @@ export interface operations { content: { 'application/json': | { + /** @description Error details returned when the operation fails. */ error: { code: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Time until which further authentication attempts are blocked. + */ lockedUntil: string; + /** @description Human-readable explanation of the result. */ message: string; }; } | { + /** @description Whether the operation succeeded. */ ok: boolean; }; }; @@ -3437,10 +3653,15 @@ export interface operations { }; content: { 'application/json': { + /** @description Error details returned when the operation fails. */ error: { code: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Time until which further authentication attempts are blocked. + */ lockedUntil: string; + /** @description Human-readable explanation of the result. */ message: string; }; }; @@ -3482,6 +3703,7 @@ export interface operations { }; content: { 'application/json': { + /** @description Whether the operation succeeded. */ ok: boolean; }; }; @@ -3547,14 +3769,20 @@ export interface operations { content: { 'application/json': | { + /** @description Error details returned when the operation fails. */ error: { code: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Time until which further authentication attempts are blocked. + */ lockedUntil: string; + /** @description Human-readable explanation of the result. */ message: string; }; } | { + /** @description Single-use backup codes for two-factor authentication. */ backupCodes: string[]; }; }; @@ -3620,10 +3848,15 @@ export interface operations { }; content: { 'application/json': { + /** @description Error details returned when the operation fails. */ error: { code: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Time until which further authentication attempts are blocked. + */ lockedUntil: string; + /** @description Human-readable explanation of the result. */ message: string; }; }; @@ -3665,7 +3898,9 @@ export interface operations { }; content: { 'application/json': { + /** @description Secret key for manually configuring an authenticator app. */ manualKey: string; + /** @description Data URL of the QR code for authenticator setup. */ qrCodeDataUrl: string; }; }; @@ -3761,17 +3996,27 @@ export interface operations { content: { 'application/json': | { + /** @description Whether two-factor authentication is required for all users. */ globalRequired: boolean; + /** @description Whether two-factor authentication has been configured. */ isConfigured: boolean; + /** @description Whether two-factor authentication is enabled. */ isEnabled: boolean; + /** @description Whether two-factor authentication is required for this user. */ isRequired: boolean; + /** @description Reason two-factor authentication is required. */ requiredReason: null; } | { + /** @description Whether two-factor authentication is required for all users. */ globalRequired: boolean; + /** @description Whether two-factor authentication has been configured. */ isConfigured: boolean; + /** @description Whether two-factor authentication is enabled. */ isEnabled: boolean; + /** @description Whether two-factor authentication is required for this user. */ isRequired: boolean; + /** @description Reason two-factor authentication is required. */ requiredReason: string; }; }; @@ -3810,6 +4055,7 @@ export interface operations { token: string; } | { + /** @description Single-use backup code for two-factor authentication. */ backupCode: string; }; }; @@ -3823,26 +4069,43 @@ export interface operations { content: { 'application/json': | { + /** @description Error details returned when the operation fails. */ error: { code: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Time until which further authentication attempts are blocked. + */ lockedUntil: string; + /** @description Human-readable explanation of the result. */ message: string; }; } | { token: string; + /** @description User associated with the resource. */ user: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Whether the user has administrator privileges. */ isAdmin: boolean; + /** @description Permission role assigned to the user. */ role: string; + /** @description Teams associated with the user. */ teams: { + /** @description Unique identifier of the resource. */ id: string; + /** @description URL of the logo image. */ logoUrl: string; + /** @description Display name of the resource. */ name: string; }[]; + /** @description Username of the account. */ username: string; }; }; @@ -3909,10 +4172,15 @@ export interface operations { }; content: { 'application/json': { + /** @description Error details returned when the operation fails. */ error: { code: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Time until which further authentication attempts are blocked. + */ lockedUntil: string; + /** @description Human-readable explanation of the result. */ message: string; }; }; @@ -3960,6 +4228,7 @@ export interface operations { }; content: { 'application/json': { + /** @description Whether the operation succeeded. */ ok: boolean; required: unknown; }; @@ -4042,11 +4311,17 @@ export interface operations { getAdminTeams: { parameters: { query?: { + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: 'true' | 'false'; }; header?: never; @@ -4062,25 +4337,47 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { + /** @description Code used to join the team. */ accessCode: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description URL of the logo image. */ logoUrl: string; + /** @description Display name of the resource. */ name: string; + /** @description Whether two-factor authentication is required. */ twoFactorRequired: boolean; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -4128,6 +4425,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the associated team. */ teamId: string; }; cookie?: never; @@ -4147,8 +4445,11 @@ export interface operations { }; content: { 'application/json': { + /** @description Whether the operation succeeded. */ ok: boolean; + /** @description ID of the associated team. */ teamId: string; + /** @description Whether two-factor authentication is required. */ twoFactorRequired: unknown; }; }; @@ -4230,11 +4531,17 @@ export interface operations { getAdminUsers: { parameters: { query?: { + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: 'true' | 'false'; }; header?: never; @@ -4250,23 +4557,38 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { _count?: { websites: number; }; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Permission role assigned to the user. */ role: string; + /** @description Whether two-factor authentication is required. */ twoFactorRequired: boolean; + /** @description Username of the account. */ username: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -4314,6 +4636,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the associated user. */ userId: string; }; cookie?: never; @@ -4327,6 +4650,7 @@ export interface operations { }; content: { 'application/json': { + /** @description Whether two-factor authentication is enabled. */ isEnabled: boolean; }; }; @@ -4374,6 +4698,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the associated user. */ userId: string; }; cookie?: never; @@ -4393,8 +4718,11 @@ export interface operations { }; content: { 'application/json': { + /** @description Whether the operation succeeded. */ ok: boolean; + /** @description Whether two-factor authentication is required. */ twoFactorRequired: unknown; + /** @description ID of the associated user. */ userId: string; }; }; @@ -4478,6 +4806,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the associated user. */ userId: string; }; cookie?: never; @@ -4491,13 +4820,16 @@ export interface operations { }; content: { 'application/json': { + /** @description Whether the operation succeeded. */ ok: boolean; reset: { + /** @description Single-use backup codes for two-factor authentication. */ backupCodes: unknown; otpUsed: unknown; rateLimit: unknown; twoFactorAuth: unknown; }; + /** @description ID of the associated user. */ userId: string; }; }; @@ -4543,11 +4875,17 @@ export interface operations { getAdminWebsites: { parameters: { query?: { + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: 'true' | 'false'; }; header?: never; @@ -4563,17 +4901,31 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: ({ - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description ID of the user who created the resource. */ createdBy: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Domain name associated with the resource. */ domain: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Whether recording is enabled for the website. */ recorderEnabled: boolean; + /** @description Session replay and heatmap recording configuration. */ replayConfig: | string | number @@ -4593,34 +4945,59 @@ export interface operations { | { length: number; }; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the website analytics were last reset. + */ resetAt: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; } & { + /** @description User who created the resource. */ createUser?: { + /** @description Unique identifier of the resource. */ id: string; + /** @description Username of the account. */ username: string; }; + /** @description Identifier used to access a shared resource. */ shareId: string; + /** @description Team associated with the resource. */ team?: { + /** @description Members of the team. */ members: { + /** @description Permission role assigned to the user. */ role: string; + /** @description ID of the associated user. */ userId: string; }[]; }; + /** @description User associated with the resource. */ user?: { + /** @description Unique identifier of the resource. */ id: string; + /** @description Username of the account. */ username: string; }; })[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -4757,7 +5134,10 @@ export interface operations { }; content: { 'application/json': { - /** @constant */ + /** + * @description Whether the operation succeeded. + * @constant + */ ok: true; }; }; @@ -4799,6 +5179,7 @@ export interface operations { content: { 'application/json': { token: string; + /** @description User associated with the resource. */ user: unknown; }; }; @@ -4844,6 +5225,7 @@ export interface operations { getSubscription: { parameters: { query?: { + /** @description ID of the associated team. */ teamId?: string; }; header?: never; @@ -4860,8 +5242,10 @@ export interface operations { content: { 'application/json': | { + /** @description Error details returned when the operation fails. */ error: { code: string; + /** @description Human-readable explanation of the result. */ message: string; status: number; }; @@ -4929,6 +5313,7 @@ export interface operations { }; content: { 'application/json': { + /** @description Teams associated with the user. */ teams: unknown; }; }; @@ -5024,11 +5409,17 @@ export interface operations { getBoards: { parameters: { query?: { + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: 'true' | 'false'; }; header?: never; @@ -5044,13 +5435,22 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Description of the resource. */ description: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -5070,17 +5470,28 @@ export interface operations { | { length: number; }; + /** @description ID of the associated team. */ teamId: string; type: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -5133,18 +5544,32 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Description of the resource. */ description?: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters?: { - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the tracked link. + */ linkId?: string; - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the tracking pixel. + */ pixelId?: string; - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the website. + */ websiteId?: string; }; + /** @description ID of the associated team. */ teamId?: string | null; type: never | 'open'; + /** @description ID of the associated user. */ userId?: string | null; }; }; @@ -5157,11 +5582,18 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Description of the resource. */ description: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -5181,10 +5613,15 @@ export interface operations { | { length: number; }; + /** @description ID of the associated team. */ teamId: string; type: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }; }; @@ -5232,6 +5669,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the board. */ boardId: string; }; cookie?: never; @@ -5245,11 +5683,18 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Description of the resource. */ description: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -5269,10 +5714,15 @@ export interface operations { | { length: number; }; + /** @description ID of the associated team. */ teamId: string; type: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }; }; @@ -5302,6 +5752,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the board. */ boardId: string; }; cookie?: never; @@ -5309,8 +5760,11 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Description of the resource. */ description?: string; + /** @description Display name of the resource. */ name?: string; + /** @description Configuration parameters for the resource. */ parameters?: Record; type?: never | 'open'; }; @@ -5324,11 +5778,18 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Description of the resource. */ description: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -5348,10 +5809,15 @@ export interface operations { | { length: number; }; + /** @description ID of the associated team. */ teamId: string; type: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }; }; @@ -5417,6 +5883,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the board. */ boardId: string; }; cookie?: never; @@ -5430,7 +5897,10 @@ export interface operations { }; content: { 'application/json': { - /** @constant */ + /** + * @description Whether the operation succeeded. + * @constant + */ ok: true; }; }; @@ -5460,6 +5930,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the board. */ boardId: string; }; cookie?: never; @@ -5467,8 +5938,11 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Description of the resource. */ description?: string; + /** @description Display name of the resource. */ name?: string; + /** @description Configuration parameters for the resource. */ parameters?: Record; }; }; @@ -5481,11 +5955,18 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Description of the resource. */ description: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -5505,10 +5986,15 @@ export interface operations { | { length: number; }; + /** @description ID of the associated team. */ teamId: string; type: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }; }; @@ -5554,37 +6040,66 @@ export interface operations { getBoardShares: { parameters: { query?: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description Filter by page title. */ title?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the board. */ boardId: string; }; cookie?: never; @@ -5598,13 +6113,22 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description ID of the resource being shared. */ entityId: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -5624,16 +6148,27 @@ export interface operations { | { length: number; }; + /** @description Type of resource made available by the share. */ shareType: number; + /** @description URL slug used to access the resource. */ slug: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -5681,6 +6216,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the board. */ boardId: string; }; cookie?: never; @@ -5688,7 +6224,9 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters?: { [key: string]: unknown; }; @@ -5703,11 +6241,18 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description ID of the resource being shared. */ entityId: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -5727,9 +6272,14 @@ export interface operations { | { length: number; }; + /** @description Type of resource made available by the share. */ shareType: number; + /** @description URL slug used to access the resource. */ slug: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; }; }; @@ -5818,11 +6368,18 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Description of the dashboard. */ description: string; + /** @description Dashboard board ID, equal to the owning user ID. */ id: string; + /** @description Display name of the dashboard. */ name: string; + /** @description Dashboard configuration, including components, layout, and saved reports. */ parameters: | string | number @@ -5842,10 +6399,16 @@ export interface operations { | { length: number; }; + /** @description ID of the associated team, if any. */ teamId: string; + /** @description Board type used for the dashboard. */ type: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the user who owns the dashboard. */ userId: string; }; }; @@ -5880,8 +6443,11 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Description of the dashboard. */ description?: string; + /** @description Display name of the dashboard. */ name?: string; + /** @description Dashboard configuration, including components, layout, and saved reports. */ parameters?: Record; }; }; @@ -5894,11 +6460,18 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Description of the dashboard. */ description: string; + /** @description Dashboard board ID, equal to the owning user ID. */ id: string; + /** @description Display name of the dashboard. */ name: string; + /** @description Dashboard configuration, including components, layout, and saved reports. */ parameters: | string | number @@ -5918,10 +6491,16 @@ export interface operations { | { length: number; }; + /** @description ID of the associated team, if any. */ teamId: string; + /** @description Board type used for the dashboard. */ type: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the user who owns the dashboard. */ userId: string; }; }; @@ -5980,6 +6559,7 @@ export interface operations { }; content: { 'application/json': { + /** @description Whether the operation succeeded. */ ok: boolean; }; }; @@ -5989,11 +6569,17 @@ export interface operations { getLinks: { parameters: { query?: { + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: 'true' | 'false'; }; header?: never; @@ -6009,26 +6595,49 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description URL slug used to access the resource. */ slug: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description URL associated with the resource. */ url: string; + /** @description ID of the associated user. */ userId: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -6081,10 +6690,15 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Unique identifier of the resource. */ id?: string | null; + /** @description Display name of the resource. */ name: string; + /** @description URL slug used to access the resource. */ slug: string; + /** @description ID of the associated team. */ teamId?: string | null; + /** @description URL associated with the resource. */ url: string; }; }; @@ -6097,17 +6711,32 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description URL slug used to access the resource. */ slug: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description URL associated with the resource. */ url: string; + /** @description ID of the associated user. */ userId: string; }; }; @@ -6155,6 +6784,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the tracked link. */ linkId: string; }; cookie?: never; @@ -6168,17 +6798,32 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description URL slug used to access the resource. */ slug: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description URL associated with the resource. */ url: string; + /** @description ID of the associated user. */ userId: string; }; }; @@ -6208,6 +6853,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the tracked link. */ linkId: string; }; cookie?: never; @@ -6215,8 +6861,11 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Display name of the resource. */ name?: string; + /** @description URL slug used to access the resource. */ slug?: string; + /** @description URL associated with the resource. */ url?: string; }; }; @@ -6229,17 +6878,32 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description URL slug used to access the resource. */ slug: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description URL associated with the resource. */ url: string; + /** @description ID of the associated user. */ userId: string; }; }; @@ -6305,6 +6969,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the tracked link. */ linkId: string; }; cookie?: never; @@ -6318,7 +6983,10 @@ export interface operations { }; content: { 'application/json': { - /** @constant */ + /** + * @description Whether the operation succeeded. + * @constant + */ ok: true; }; }; @@ -6346,37 +7014,66 @@ export interface operations { getLinkShares: { parameters: { query?: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description Filter by page title. */ title?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the tracked link. */ linkId: string; }; cookie?: never; @@ -6390,13 +7087,22 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description ID of the resource being shared. */ entityId: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -6416,16 +7122,27 @@ export interface operations { | { length: number; }; + /** @description Type of resource made available by the share. */ shareType: number; + /** @description URL slug used to access the resource. */ slug: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -6473,6 +7190,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the tracked link. */ linkId: string; }; cookie?: never; @@ -6480,7 +7198,9 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters?: { [key: string]: unknown; }; @@ -6495,11 +7215,18 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description ID of the resource being shared. */ entityId: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -6519,9 +7246,14 @@ export interface operations { | { length: number; }; + /** @description Type of resource made available by the share. */ shareType: number; + /** @description URL slug used to access the resource. */ slug: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; }; }; @@ -6567,9 +7299,13 @@ export interface operations { getLinksCharts: { parameters: { query: { + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt?: number; + /** @description Comma-separated resource IDs. Provide between 1 and 20 IDs. */ ids: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt?: number; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; }; header?: never; @@ -6585,6 +7321,7 @@ export interface operations { }; content: { 'application/json': { + /** @description Data returned by the operation. */ data: { [key: string]: { total: number; @@ -6648,8 +7385,11 @@ export interface operations { }; content: { 'application/json': { + /** @description API key authentication details. */ apiKey?: { + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; }; authType?: 'session' | 'share' | 'api-key' | 'oauth'; @@ -6659,25 +7399,36 @@ export interface operations { tokenId?: string; }; shareToken?: { + /** @description ID of the board. */ boardId?: string; + /** @description ID of the tracked link. */ linkId?: string; linkIds?: string[]; + /** @description Configuration parameters for the resource. */ parameters?: { allowFilter?: boolean; theme?: 'light' | 'dark'; } & { [key: string]: false | true | 'light' | 'dark'; }; + /** @description ID of the tracking pixel. */ pixelId?: string; pixelIds?: string[]; + /** @description Type of resource made available by the share. */ shareType?: number; + /** @description ID of the website. */ websiteId?: string; websiteIds?: string[]; }; + /** @description User associated with the resource. */ user?: { + /** @description Unique identifier of the resource. */ id: string; + /** @description Whether the user has administrator privileges. */ isAdmin: boolean; + /** @description Permission role assigned to the user. */ role: string; + /** @description Username of the account. */ username: string; }; }; @@ -6719,12 +7470,21 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Visible prefix used to identify an API key. */ keyPrefix: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the credential was last used. + */ lastUsedAt: string; + /** @description Display name of the resource. */ name: string; }[]; }; @@ -6777,6 +7537,7 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Display name of the resource. */ name: unknown; }; }; @@ -6789,11 +7550,17 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Unique identifier of the resource. */ id: string; key: string; + /** @description Visible prefix used to identify an API key. */ keyPrefix: string; + /** @description Display name of the resource. */ name: string; }; }; @@ -6859,6 +7626,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the API key. */ keyId: string; }; cookie?: never; @@ -6872,7 +7640,10 @@ export interface operations { }; content: { 'application/json': { - /** @constant */ + /** + * @description Whether the operation succeeded. + * @constant + */ ok: true; }; }; @@ -6925,7 +7696,9 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Current account password. */ currentPassword: string; + /** @description New password to set for the account. */ newPassword: string; }; }; @@ -6938,10 +7711,16 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Permission role assigned to the user. */ role: string; + /** @description Username of the account. */ username: string; }; }; @@ -6987,10 +7766,15 @@ export interface operations { getMyTeams: { parameters: { query?: { + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Whether to sort results in descending order. */ sortDescending?: 'true' | 'false'; }; header?: never; @@ -7006,25 +7790,47 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { + /** @description Code used to join the team. */ accessCode: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description URL of the logo image. */ logoUrl: string; + /** @description Display name of the resource. */ name: string; + /** @description Whether two-factor authentication is required. */ twoFactorRequired: boolean; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -7070,11 +7876,17 @@ export interface operations { getMyWebsites: { parameters: { query?: { + /** @description Set a non-empty value to include websites accessible through team membership. */ includeTeams?: string; + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Whether to sort results in descending order. */ sortDescending?: 'true' | 'false'; }; header?: never; @@ -7090,17 +7902,31 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: ({ - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description ID of the user who created the resource. */ createdBy: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Domain name associated with the resource. */ domain: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Whether recording is enabled for the website. */ recorderEnabled: boolean; + /** @description Session replay and heatmap recording configuration. */ replayConfig: | string | number @@ -7120,34 +7946,59 @@ export interface operations { | { length: number; }; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the website analytics were last reset. + */ resetAt: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; } & { + /** @description User who created the resource. */ createUser?: { + /** @description Unique identifier of the resource. */ id: string; + /** @description Username of the account. */ username: string; }; + /** @description Identifier used to access a shared resource. */ shareId: string; + /** @description Team associated with the resource. */ team?: { + /** @description Members of the team. */ members: { + /** @description Permission role assigned to the user. */ role: string; + /** @description ID of the associated user. */ userId: string; }[]; }; + /** @description User associated with the resource. */ user?: { + /** @description Unique identifier of the resource. */ id: string; + /** @description Username of the account. */ username: string; }; })[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -7193,13 +8044,21 @@ export interface operations { describeOAuthAuthorization: { parameters: { query: { + /** @description OAuth client identifier. */ client_id: string; + /** @description PKCE challenge derived from the code verifier. */ code_challenge?: string; + /** @description Method used to derive the PKCE challenge; use S256. */ code_challenge_method?: string; + /** @description Registered redirect URI to receive the authorization response. */ redirect_uri?: string; + /** @description Resource URI identifying the API targeted by the OAuth request. */ resource?: string; + /** @description OAuth authorization response type; use code. */ response_type?: string; + /** @description Space-separated OAuth permissions. */ scope?: string; + /** @description Client-provided value returned unchanged to correlate the authorization response. */ state?: string; }; header?: never; @@ -7419,11 +8278,17 @@ export interface operations { getPixels: { parameters: { query?: { + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: 'true' | 'false'; }; header?: never; @@ -7439,25 +8304,47 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description URL slug used to access the resource. */ slug: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -7510,9 +8397,13 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Unique identifier of the resource. */ id?: string | null; + /** @description Display name of the resource. */ name: string; + /** @description URL slug used to access the resource. */ slug: string; + /** @description ID of the associated team. */ teamId?: string | null; }; }; @@ -7525,16 +8416,30 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description URL slug used to access the resource. */ slug: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }; }; @@ -7582,6 +8487,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the tracking pixel. */ pixelId: string; }; cookie?: never; @@ -7595,16 +8501,30 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description URL slug used to access the resource. */ slug: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }; }; @@ -7634,6 +8554,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the tracking pixel. */ pixelId: string; }; cookie?: never; @@ -7641,7 +8562,9 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Display name of the resource. */ name?: string; + /** @description URL slug used to access the resource. */ slug?: string; }; }; @@ -7654,16 +8577,30 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description URL slug used to access the resource. */ slug: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }; }; @@ -7729,6 +8666,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the tracking pixel. */ pixelId: string; }; cookie?: never; @@ -7742,7 +8680,10 @@ export interface operations { }; content: { 'application/json': { - /** @constant */ + /** + * @description Whether the operation succeeded. + * @constant + */ ok: true; }; }; @@ -7770,37 +8711,66 @@ export interface operations { getPixelShares: { parameters: { query?: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description Filter by page title. */ title?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the tracking pixel. */ pixelId: string; }; cookie?: never; @@ -7814,13 +8784,22 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description ID of the resource being shared. */ entityId: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -7840,16 +8819,27 @@ export interface operations { | { length: number; }; + /** @description Type of resource made available by the share. */ shareType: number; + /** @description URL slug used to access the resource. */ slug: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -7897,6 +8887,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the tracking pixel. */ pixelId: string; }; cookie?: never; @@ -7904,7 +8895,9 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters?: { [key: string]: unknown; }; @@ -7919,11 +8912,18 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description ID of the resource being shared. */ entityId: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -7943,9 +8943,14 @@ export interface operations { | { length: number; }; + /** @description Type of resource made available by the share. */ shareType: number; + /** @description URL slug used to access the resource. */ slug: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; }; }; @@ -7991,9 +8996,13 @@ export interface operations { getPixelsCharts: { parameters: { query: { + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt?: number; + /** @description Comma-separated resource IDs. Provide between 1 and 20 IDs. */ ids: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt?: number; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; }; header?: never; @@ -8009,6 +9018,7 @@ export interface operations { }; content: { 'application/json': { + /** @description Data returned by the operation. */ data: { [key: string]: { total: number; @@ -8059,36 +9069,64 @@ export interface operations { getRealtime: { parameters: { query?: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -8107,26 +9145,38 @@ export interface operations { }; events: { __type: 'event' | 'session' | 'pageview'; + /** @description Browser used by the visitor. */ browser: string; + /** @description Country code of the visitor. */ country: string; + /** @description Date and time the record was created. */ createdAt: string; + /** @description Device category used by the visitor. */ device: string; + /** @description Name of the custom event. */ eventName: string; + /** @description Hostname on which the activity occurred. */ hostname: string; + /** @description Operating system used by the visitor. */ os: string; + /** @description Domain of the referring page. */ referrerDomain: string; + /** @description ID of the visitor session. */ sessionId: string; + /** @description Path portion of the page URL. */ urlPath: string; }[]; referrers: { [key: string]: number; }; series: { + /** @description Pageview counts for the selected period. */ views: { t: string; x: string; y: number; }[]; + /** @description Unique visitor counts for the selected period. */ visitors: { t: string; x: string; @@ -8137,7 +9187,9 @@ export interface operations { totals: { countries: number; events: number; + /** @description Pageview counts for the selected period. */ views: number; + /** @description Unique visitor counts for the selected period. */ visitors: number; }; urls: { @@ -8208,28 +9260,40 @@ export interface operations { payload: { events: ( | { + /** @description Page height in pixels. */ pageH?: number; + /** @description Page width in pixels. */ pageW?: number; + /** @description Horizontal position on the page in pixels. */ pageX?: number; + /** @description Vertical position on the page in pixels. */ pageY?: number; timestamp?: number; /** @constant */ type: 'click'; + /** @description URL associated with the resource. */ url: string; + /** @description Viewport height in pixels. */ viewportH?: number; + /** @description Viewport width in pixels. */ viewportW?: number; x?: number; y?: number; } | { + /** @description Page height in pixels. */ pageH?: number; + /** @description Page width in pixels. */ pageW?: number; scrollPct?: number; timestamp?: number; /** @constant */ type: 'scroll'; + /** @description URL associated with the resource. */ url: string; + /** @description Viewport height in pixels. */ viewportH?: number; + /** @description Viewport width in pixels. */ viewportW?: number; } )[]; @@ -8251,9 +9315,11 @@ export interface operations { content: { 'application/json': | { + /** @description Whether the operation succeeded. */ ok: boolean; } | { + /** @description Whether the operation succeeded. */ ok: boolean; reason: string; } @@ -8339,10 +9405,15 @@ export interface operations { getReports: { parameters: { query: { + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Type of resource or analytics dimension to return. */ type?: string; + /** @description ID of the website. */ websiteId: string; }; header?: never; @@ -8358,13 +9429,22 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: ({ - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Description of the resource. */ description: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -8385,21 +9465,34 @@ export interface operations { length: number; }; type: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; + /** @description ID of the website. */ websiteId: string; } & { website?: { + /** @description Domain name associated with the resource. */ domain: string; + /** @description ID of the associated user. */ userId: string; }; })[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -8452,13 +9545,19 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Description of the resource. */ description?: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: { [key: string]: unknown; }; type: string; - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the website. + */ websiteId: string; }; }; @@ -8471,11 +9570,18 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Description of the resource. */ description: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -8496,9 +9602,14 @@ export interface operations { length: number; }; type: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; + /** @description ID of the website. */ websiteId: string; }; }; @@ -8546,6 +9657,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the saved report. */ reportId: string; }; cookie?: never; @@ -8559,11 +9671,18 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Description of the resource. */ description: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -8584,9 +9703,14 @@ export interface operations { length: number; }; type: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; + /** @description ID of the website. */ websiteId: string; }; }; @@ -8634,6 +9758,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the saved report. */ reportId: string; }; cookie?: never; @@ -8641,13 +9766,19 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Description of the resource. */ description?: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: { [key: string]: unknown; }; type: string; - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the website. + */ websiteId: string; }; }; @@ -8660,11 +9791,18 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Description of the resource. */ description: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -8685,9 +9823,14 @@ export interface operations { length: number; }; type: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; + /** @description ID of the website. */ websiteId: string; }; }; @@ -8753,6 +9896,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the saved report. */ reportId: string; }; cookie?: never; @@ -8766,7 +9910,10 @@ export interface operations { }; content: { 'application/json': { - /** @constant */ + /** + * @description Whether the operation succeeded. + * @constant + */ ok: true; }; }; @@ -8819,14 +9966,19 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Filters applied to the analytics data. */ filters: { [key: string]: unknown; }; + /** @description Configuration parameters for the resource. */ parameters: { [key: string]: unknown; }; type: string; - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the website. + */ websiteId: string; }; }; @@ -8840,35 +9992,46 @@ export interface operations { content: { 'application/json': { paidAds: { + /** @description Display name of the resource. */ name: string; value: number; }[]; + /** @description URL of the referring page. */ referrer: { + /** @description Display name of the resource. */ name: string; value: number; }[]; total: { + /** @description Pageview counts for the selected period. */ pageviews: number; + /** @description Unique visitor counts for the selected period. */ visitors: number; + /** @description Visit counts for the selected period. */ visits: number; }; utm_campaign: { + /** @description Display name of the resource. */ name: string; value: number; }[]; utm_content: { + /** @description Display name of the resource. */ name: string; value: number; }[]; utm_medium: { + /** @description Display name of the resource. */ name: string; value: number; }[]; utm_source: { + /** @description Display name of the resource. */ name: string; value: number; }[]; utm_term: { + /** @description Display name of the resource. */ name: string; value: number; }[]; @@ -8923,14 +10086,19 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Filters applied to the analytics data. */ filters: { [key: string]: unknown; }; + /** @description Configuration parameters for the resource. */ parameters: { [key: string]: unknown; }; type: string; - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the website. + */ websiteId: string; }; }; @@ -8943,10 +10111,15 @@ export interface operations { }; content: { 'application/json': ({ + /** @description Number of visits with only one pageview. */ bounces: number; + /** @description Total visit duration in seconds. */ totaltime: number; + /** @description Pageview counts for the selected period. */ views: number; + /** @description Unique visitor counts for the selected period. */ visitors: number; + /** @description Visit counts for the selected period. */ visits: number; } & { [key: string]: string | number; @@ -9001,14 +10174,19 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Filters applied to the analytics data. */ filters: { [key: string]: unknown; }; + /** @description Configuration parameters for the resource. */ parameters: { [key: string]: unknown; }; type: string; - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the website. + */ websiteId: string; }; }; @@ -9023,6 +10201,7 @@ export interface operations { 'application/json': { dropoff: number; dropped: number; + /** @description Filters applied to the analytics data. */ filters?: { operator: string; property: string; @@ -9032,6 +10211,7 @@ export interface operations { remaining: number; type: string; value: string; + /** @description Unique visitor counts for the selected period. */ visitors: number; }[]; }; @@ -9084,14 +10264,19 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Filters applied to the analytics data. */ filters: { [key: string]: unknown; }; + /** @description Configuration parameters for the resource. */ parameters: { [key: string]: unknown; }; type: string; - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the website. + */ websiteId: string; }; }; @@ -9157,14 +10342,19 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Filters applied to the analytics data. */ filters: { [key: string]: unknown; }; + /** @description Configuration parameters for the resource. */ parameters: { [key: string]: unknown; }; type: string; - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the website. + */ websiteId: string; }; }; @@ -9179,17 +10369,26 @@ export interface operations { 'application/json': { mode: 'click' | 'scroll'; pages: { + /** @description Number of matching records. */ count: number; sessions: number; + /** @description Path portion of the page URL. */ urlPath: string; }[]; points: { + /** @description Number of matching records. */ count: number; + /** @description Page height in pixels. */ pageH: number; + /** @description Page width in pixels. */ pageW: number; + /** @description Horizontal position on the page in pixels. */ pageX: number; + /** @description Vertical position on the page in pixels. */ pageY: number; + /** @description Viewport height in pixels. */ viewportH: number; + /** @description Viewport width in pixels. */ viewportW: number; x: number; y: number; @@ -9197,26 +10396,40 @@ export interface operations { scroll: { buckets: { depth: number; + /** @description Page height in pixels. */ pageH: number; + /** @description Page width in pixels. */ pageW: number; sessions: number; + /** @description Viewport height in pixels. */ viewportH: number; + /** @description Viewport width in pixels. */ viewportW: number; }[]; + /** @description Page height in pixels. */ pageH: number; + /** @description Page width in pixels. */ pageW: number; totalSessions: number; + /** @description Viewport height in pixels. */ viewportH: number; + /** @description Viewport width in pixels. */ viewportW: number; }; snapshot: { + /** @description Unique identifier of the resource. */ id: string; /** @constant */ kind: 'iframe'; + /** @description Page height in pixels. */ pageH: number; + /** @description Page width in pixels. */ pageW: number; + /** @description URL associated with the resource. */ url: string; + /** @description Viewport height in pixels. */ viewportH: number; + /** @description Viewport width in pixels. */ viewportW: number; }; }; @@ -9270,14 +10483,19 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Filters applied to the analytics data. */ filters: { [key: string]: unknown; }; + /** @description Configuration parameters for the resource. */ parameters: { [key: string]: unknown; }; type: string; - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the website. + */ websiteId: string; }; }; @@ -9290,6 +10508,7 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; e1: string; e2: string; @@ -9349,14 +10568,19 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Filters applied to the analytics data. */ filters: { [key: string]: unknown; }; + /** @description Configuration parameters for the resource. */ parameters: { [key: string]: unknown; }; type: string; - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the website. + */ websiteId: string; }; }; @@ -9426,14 +10650,19 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Filters applied to the analytics data. */ filters: { [key: string]: unknown; }; + /** @description Configuration parameters for the resource. */ parameters: { [key: string]: unknown; }; type: string; - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the website. + */ websiteId: string; }; }; @@ -9450,6 +10679,7 @@ export interface operations { day: number; percentage: number; returnVisitors: number; + /** @description Unique visitor counts for the selected period. */ visitors: number; }[]; }; @@ -9502,14 +10732,19 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Filters applied to the analytics data. */ filters: { [key: string]: unknown; }; + /** @description Configuration parameters for the resource. */ parameters: { [key: string]: unknown; }; type: string; - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the website. + */ websiteId: string; }; }; @@ -9523,25 +10758,34 @@ export interface operations { content: { 'application/json': { channel: { + /** @description Display name of the resource. */ name: string; value: number; }[]; chart: { + /** @description Number of matching records. */ count: number; t: string; x: string; y: number; }[]; + /** @description Country code of the visitor. */ country: { + /** @description Display name of the resource. */ name: string; value: number; }[]; + /** @description URL of the referring page. */ referrer: { + /** @description Display name of the resource. */ name: string; value: number; }[]; + /** @description Region or subdivision of the visitor. */ region: { + /** @description Country code of the visitor. */ country: string; + /** @description Display name of the resource. */ name: string; value: number; }[]; @@ -9597,14 +10841,19 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Filters applied to the analytics data. */ filters: { [key: string]: unknown; }; + /** @description Configuration parameters for the resource. */ parameters: { [key: string]: unknown; }; type: string; - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the website. + */ websiteId: string; }; }; @@ -9694,31 +10943,44 @@ export interface operations { content: { 'application/json': { payload: { + /** @description Browser used by the visitor. */ browser?: string; cls?: number; + /** @description Data returned by the operation. */ data?: { [key: string]: unknown; }; + /** @description Device category used by the visitor. */ device?: string; fcp?: number; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Unique identifier of the resource. */ id?: string; inp?: number; ip?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; lcp?: number; /** Format: uuid */ link?: string; + /** @description Display name of the resource. */ name?: unknown; + /** @description Operating system used by the visitor. */ os?: string; /** Format: uuid */ pixel?: string; + /** @description URL of the referring page. */ referrer?: string; + /** @description Screen resolution of the visitor device. */ screen?: string; + /** @description Tag attached to the tracked activity. */ tag?: unknown; timestamp?: number; + /** @description Title of the page. */ title?: string; ttfb?: number; + /** @description URL associated with the resource. */ url?: string; userAgent?: string; /** Format: uuid */ @@ -9742,7 +11004,9 @@ export interface operations { } | { cache: unknown; + /** @description ID of the visitor session. */ sessionId: unknown; + /** @description ID of the visit. */ visitId: unknown; }; }; @@ -9813,13 +11077,20 @@ export interface operations { requestBody: { content: { 'application/json': { - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the resource being shared. + */ entityId: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: { [key: string]: unknown; }; + /** @description Type of resource made available by the share. */ shareType: number; + /** @description URL slug used to access the resource. */ slug?: string; }; }; @@ -9832,11 +11103,18 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description ID of the resource being shared. */ entityId: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -9856,9 +11134,14 @@ export interface operations { | { length: number; }; + /** @description Type of resource made available by the share. */ shareType: number; + /** @description URL slug used to access the resource. */ slug: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; }; }; @@ -9906,6 +11189,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description URL slug used to access the resource. */ slug: string; }; cookie?: never; @@ -9948,6 +11232,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description Identifier used to access a shared resource. */ shareId: string; }; cookie?: never; @@ -9961,11 +11246,18 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description ID of the resource being shared. */ entityId: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -9985,9 +11277,14 @@ export interface operations { | { length: number; }; + /** @description Type of resource made available by the share. */ shareType: number; + /** @description URL slug used to access the resource. */ slug: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; }; }; @@ -10017,6 +11314,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description Identifier used to access a shared resource. */ shareId: string; }; cookie?: never; @@ -10024,10 +11322,13 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: { [key: string]: unknown; }; + /** @description URL slug used to access the resource. */ slug: string; }; }; @@ -10040,11 +11341,18 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description ID of the resource being shared. */ entityId: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -10064,9 +11372,14 @@ export interface operations { | { length: number; }; + /** @description Type of resource made available by the share. */ shareType: number; + /** @description URL slug used to access the resource. */ slug: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; }; }; @@ -10132,6 +11445,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description Identifier used to access a shared resource. */ shareId: string; }; cookie?: never; @@ -10145,7 +11459,10 @@ export interface operations { }; content: { 'application/json': { - /** @constant */ + /** + * @description Whether the operation succeeded. + * @constant + */ ok: true; }; }; @@ -10173,10 +11490,15 @@ export interface operations { getTeams: { parameters: { query?: { + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Whether to sort results in descending order. */ sortDescending?: 'true' | 'false'; }; header?: never; @@ -10192,25 +11514,47 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { + /** @description Code used to join the team. */ accessCode: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description URL of the logo image. */ logoUrl: string; + /** @description Display name of the resource. */ name: string; + /** @description Whether two-factor authentication is required. */ twoFactorRequired: boolean; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -10263,6 +11607,7 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Display name of the resource. */ name: string; /** Format: uuid */ ownerId?: string; @@ -10278,26 +11623,50 @@ export interface operations { content: { 'application/json': [ { + /** @description Code used to join the team. */ accessCode: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description URL of the logo image. */ logoUrl: string; + /** @description Display name of the resource. */ name: string; + /** @description Whether two-factor authentication is required. */ twoFactorRequired: boolean; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; }, { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Permission role assigned to the user. */ role: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }, ]; @@ -10346,6 +11715,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the associated team. */ teamId: string; }; cookie?: never; @@ -10359,16 +11729,30 @@ export interface operations { }; content: { 'application/json': { + /** @description Code used to join the team. */ accessCode: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description URL of the logo image. */ logoUrl: string; + /** @description Display name of the resource. */ name: string; + /** @description Whether two-factor authentication is required. */ twoFactorRequired: boolean; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; }; }; @@ -10416,6 +11800,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the associated team. */ teamId: string; }; cookie?: never; @@ -10423,7 +11808,9 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Code used to join the team. */ accessCode?: string; + /** @description Display name of the resource. */ name?: string; }; }; @@ -10436,16 +11823,30 @@ export interface operations { }; content: { 'application/json': { + /** @description Code used to join the team. */ accessCode: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description URL of the logo image. */ logoUrl: string; + /** @description Display name of the resource. */ name: string; + /** @description Whether two-factor authentication is required. */ twoFactorRequired: boolean; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; }; }; @@ -10493,6 +11894,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the associated team. */ teamId: string; }; cookie?: never; @@ -10506,7 +11908,10 @@ export interface operations { }; content: { 'application/json': { - /** @constant */ + /** + * @description Whether the operation succeeded. + * @constant + */ ok: true; }; }; @@ -10534,15 +11939,22 @@ export interface operations { getTeamBoards: { parameters: { query?: { + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: 'true' | 'false'; }; header?: never; path: { + /** @description ID of the associated team. */ teamId: string; }; cookie?: never; @@ -10556,13 +11968,22 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Description of the resource. */ description: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -10582,17 +12003,28 @@ export interface operations { | { length: number; }; + /** @description ID of the associated team. */ teamId: string; type: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -10638,15 +12070,22 @@ export interface operations { getTeamLinks: { parameters: { query?: { + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: 'true' | 'false'; }; header?: never; path: { + /** @description ID of the associated team. */ teamId: string; }; cookie?: never; @@ -10660,26 +12099,49 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description URL slug used to access the resource. */ slug: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description URL associated with the resource. */ url: string; + /** @description ID of the associated user. */ userId: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -10725,15 +12187,22 @@ export interface operations { getTeamPixels: { parameters: { query?: { + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: 'true' | 'false'; }; header?: never; path: { + /** @description ID of the associated team. */ teamId: string; }; cookie?: never; @@ -10747,25 +12216,47 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description URL slug used to access the resource. */ slug: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -10811,13 +12302,18 @@ export interface operations { getTeamUsers: { parameters: { query?: { + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Search text used to filter results. */ search?: string; }; header?: never; path: { + /** @description ID of the associated team. */ teamId: string; }; cookie?: never; @@ -10831,27 +12327,48 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: ({ - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Permission role assigned to the user. */ role: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; } & { + /** @description User associated with the resource. */ user?: { + /** @description Unique identifier of the resource. */ id: string; + /** @description Username of the account. */ username: string; }; })[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -10899,6 +12416,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the associated team. */ teamId: string; }; cookie?: never; @@ -10906,9 +12424,15 @@ export interface operations { requestBody: { content: { 'application/json': { - /** @enum {string} */ + /** + * @description Permission role assigned to the user. + * @enum {string} + */ role: 'team-member' | 'team-view-only' | 'team-manager'; - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the associated user. + */ userId: string; }; }; @@ -10921,13 +12445,23 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Permission role assigned to the user. */ role: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }; }; @@ -10975,7 +12509,9 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the associated team. */ teamId: string; + /** @description ID of the associated user. */ userId: string; }; cookie?: never; @@ -10989,13 +12525,23 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Permission role assigned to the user. */ role: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }; }; @@ -11025,7 +12571,9 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the associated team. */ teamId: string; + /** @description ID of the associated user. */ userId: string; }; cookie?: never; @@ -11033,7 +12581,10 @@ export interface operations { requestBody: { content: { 'application/json': { - /** @enum {string} */ + /** + * @description Permission role assigned to the user. + * @enum {string} + */ role: 'team-member' | 'team-view-only' | 'team-manager'; }; }; @@ -11046,13 +12597,23 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Permission role assigned to the user. */ role: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }; }; @@ -11100,7 +12661,9 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the associated team. */ teamId: string; + /** @description ID of the associated user. */ userId: string; }; cookie?: never; @@ -11114,7 +12677,10 @@ export interface operations { }; content: { 'application/json': { - /** @constant */ + /** + * @description Whether the operation succeeded. + * @constant + */ ok: true; }; }; @@ -11160,15 +12726,22 @@ export interface operations { getTeamWebsites: { parameters: { query?: { + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: 'true' | 'false'; }; header?: never; path: { + /** @description ID of the associated team. */ teamId: string; }; cookie?: never; @@ -11182,17 +12755,31 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: ({ - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description ID of the user who created the resource. */ createdBy: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Domain name associated with the resource. */ domain: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Whether recording is enabled for the website. */ recorderEnabled: boolean; + /** @description Session replay and heatmap recording configuration. */ replayConfig: | string | number @@ -11212,34 +12799,59 @@ export interface operations { | { length: number; }; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the website analytics were last reset. + */ resetAt: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; } & { + /** @description User who created the resource. */ createUser?: { + /** @description Unique identifier of the resource. */ id: string; + /** @description Username of the account. */ username: string; }; + /** @description Identifier used to access a shared resource. */ shareId: string; + /** @description Team associated with the resource. */ team?: { + /** @description Members of the team. */ members: { + /** @description Permission role assigned to the user. */ role: string; + /** @description ID of the associated user. */ userId: string; }[]; }; + /** @description User associated with the resource. */ user?: { + /** @description Unique identifier of the resource. */ id: string; + /** @description Username of the account. */ username: string; }; })[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -11292,6 +12904,7 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Code used to join the team. */ accessCode: string; }; }; @@ -11304,13 +12917,23 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Permission role assigned to the user. */ role: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }; }; @@ -11381,11 +13004,19 @@ export interface operations { requestBody: { content: { 'application/json': { - /** Format: uuid */ + /** + * Format: uuid + * @description Unique identifier of the resource. + */ id?: string; + /** @description Password used to authenticate the account. */ password: string; - /** @enum {string} */ + /** + * @description Permission role assigned to the user. + * @enum {string} + */ role: 'admin' | 'user' | 'view-only'; + /** @description Username of the account. */ username: string; }; }; @@ -11398,8 +13029,11 @@ export interface operations { }; content: { 'application/json': { + /** @description Unique identifier of the resource. */ id: string; + /** @description Permission role assigned to the user. */ role: string; + /** @description Username of the account. */ username: string; }; }; @@ -11447,6 +13081,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the associated user. */ userId: string; }; cookie?: never; @@ -11461,14 +13096,21 @@ export interface operations { content: { 'application/json': { _count: { + /** @description API keys associated with the user. */ apiKeys: number; + /** @description Boards associated with the user. */ boards: number; + /** @description ID of the user who created the resource. */ createdBy: number; + /** @description Tracked links associated with the user. */ links: number; oauthAuthorizationCodes: number; oauthRefreshTokens: number; + /** @description Tracking pixels associated with the user. */ pixels: number; + /** @description Saved reports associated with the user. */ reports: number; + /** @description Teams associated with the user. */ teams: number; twoFactorAuth: number; twoFactorBackupCodes: number; @@ -11476,23 +13118,42 @@ export interface operations { twoFactorRateLimit: number; websites: number; }; + /** @description API keys associated with the user. */ apiKeys: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Unique identifier of the resource. */ id: string; keyHash: string; + /** @description Visible prefix used to identify an API key. */ keyPrefix: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the credential was last used. + */ lastUsedAt: string; + /** @description Display name of the resource. */ name: string; + /** @description ID of the associated user. */ userId: string; }[]; + /** @description Boards associated with the user. */ boards: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Description of the resource. */ description: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -11512,24 +13173,45 @@ export interface operations { | { length: number; }; + /** @description ID of the associated team. */ teamId: string; type: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }[]; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description ID of the user who created the resource. */ createdBy: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description ID of the user who created the resource. */ createdBy: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Domain name associated with the resource. */ domain: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Whether recording is enabled for the website. */ recorderEnabled: boolean; + /** @description Session replay and heatmap recording configuration. */ replayConfig: | string | number @@ -11549,26 +13231,51 @@ export interface operations { | { length: number; }; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the website analytics were last reset. + */ resetAt: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }[]; + /** @description Unique identifier of the resource. */ id: string; + /** @description Tracked links associated with the user. */ links: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description URL slug used to access the resource. */ slug: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description URL associated with the resource. */ url: string; + /** @description ID of the associated user. */ userId: string; }[]; oauthAuthorizationCodes: { @@ -11576,54 +13283,107 @@ export interface operations { codeChallenge: string; codeChallengeMethod: string; codeHash: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the credential expires. + */ expiresAt: string; + /** @description Unique identifier of the resource. */ id: string; redirectUri: string; + /** @description Resource URI identifying the API targeted by the OAuth request. */ resource: string; + /** @description Space-separated OAuth permissions. */ scope: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the code was used. + */ usedAt: string; + /** @description ID of the associated user. */ userId: string; }[]; oauthRefreshTokens: { clientId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the credential expires. + */ expiresAt: string; + /** @description Unique identifier of the resource. */ id: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the credential was last used. + */ lastUsedAt: string; + /** @description Resource URI identifying the API targeted by the OAuth request. */ resource: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the credential was revoked. + */ revokedAt: string; + /** @description Space-separated OAuth permissions. */ scope: string; tokenHash: string; + /** @description ID of the associated user. */ userId: string; }[]; + /** @description Password used to authenticate the account. */ password: string; + /** @description Tracking pixels associated with the user. */ pixels: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description URL slug used to access the resource. */ slug: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }[]; + /** @description Saved reports associated with the user. */ reports: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Description of the resource. */ description: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -11644,68 +13404,126 @@ export interface operations { length: number; }; type: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; + /** @description ID of the website. */ websiteId: string; }[]; + /** @description Permission role assigned to the user. */ role: string; + /** @description Teams associated with the user. */ teams: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Permission role assigned to the user. */ role: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }[]; twoFactorAuth: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Whether two-factor authentication is enabled. */ isEnabled: boolean; secret: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }; twoFactorBackupCodes: { codeHash: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Unique identifier of the resource. */ id: string; used: boolean; + /** @description ID of the associated user. */ userId: string; }[]; twoFactorOtpUseds: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the credential expires. + */ expiresAt: string; + /** @description Unique identifier of the resource. */ id: string; otp: string; + /** @description ID of the associated user. */ userId: string; }[]; twoFactorRateLimit: { attempts: number; + /** @description Unique identifier of the resource. */ id: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Time until which further authentication attempts are blocked. + */ lockedUntil: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }; + /** @description Whether two-factor authentication is required. */ twoFactorRequired: boolean; + /** @description Username of the account. */ username: string; websites: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description ID of the user who created the resource. */ createdBy: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Domain name associated with the resource. */ domain: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Whether recording is enabled for the website. */ recorderEnabled: boolean; + /** @description Session replay and heatmap recording configuration. */ replayConfig: | string | number @@ -11725,11 +13543,19 @@ export interface operations { | { length: number; }; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the website analytics were last reset. + */ resetAt: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }[]; }; @@ -11760,6 +13586,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the associated user. */ userId: string; }; cookie?: never; @@ -11767,9 +13594,14 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Password used to authenticate the account. */ password?: string; - /** @enum {string} */ + /** + * @description Permission role assigned to the user. + * @enum {string} + */ role?: 'admin' | 'user' | 'view-only'; + /** @description Username of the account. */ username?: string; }; }; @@ -11782,10 +13614,16 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Permission role assigned to the user. */ role: string; + /** @description Username of the account. */ username: string; }; }; @@ -11851,6 +13689,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the associated user. */ userId: string; }; cookie?: never; @@ -11864,7 +13703,10 @@ export interface operations { }; content: { 'application/json': { - /** @constant */ + /** + * @description Whether the operation succeeded. + * @constant + */ ok: true; }; }; @@ -11910,14 +13752,20 @@ export interface operations { getUserTeams: { parameters: { query?: { + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Whether to sort results in descending order. */ sortDescending?: 'true' | 'false'; }; header?: never; path: { + /** @description ID of the associated user. */ userId: string; }; cookie?: never; @@ -11931,25 +13779,47 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { + /** @description Code used to join the team. */ accessCode: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description URL of the logo image. */ logoUrl: string; + /** @description Display name of the resource. */ name: string; + /** @description Whether two-factor authentication is required. */ twoFactorRequired: boolean; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -11995,16 +13865,24 @@ export interface operations { getUserWebsites: { parameters: { query?: { + /** @description Set a non-empty value to include websites accessible through team membership. */ includeTeams?: string; + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: 'true' | 'false'; }; header?: never; path: { + /** @description ID of the associated user. */ userId: string; }; cookie?: never; @@ -12018,17 +13896,31 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: ({ - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description ID of the user who created the resource. */ createdBy: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Domain name associated with the resource. */ domain: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Whether recording is enabled for the website. */ recorderEnabled: boolean; + /** @description Session replay and heatmap recording configuration. */ replayConfig: | string | number @@ -12048,34 +13940,59 @@ export interface operations { | { length: number; }; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the website analytics were last reset. + */ resetAt: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; } & { + /** @description User who created the resource. */ createUser?: { + /** @description Unique identifier of the resource. */ id: string; + /** @description Username of the account. */ username: string; }; + /** @description Identifier used to access a shared resource. */ shareId: string; + /** @description Team associated with the resource. */ team?: { + /** @description Members of the team. */ members: { + /** @description Permission role assigned to the user. */ role: string; + /** @description ID of the associated user. */ userId: string; }[]; }; + /** @description User associated with the resource. */ user?: { + /** @description Unique identifier of the resource. */ id: string; + /** @description Username of the account. */ username: string; }; })[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -12123,11 +14040,17 @@ export interface operations { query?: { /** @description When present, include websites accessible through owned or managed teams. */ includeTeams?: string; + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: 'true' | 'false'; }; header?: never; @@ -12450,15 +14373,22 @@ export interface operations { getWebsiteAnnotations: { parameters: { query?: { + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt?: number; + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt?: number; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -12472,25 +14402,44 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { + /** @description Whether the annotation applies to the entire day. */ allDay: boolean; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; /** Format: date-time */ date: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Text of the annotation. */ note: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; + /** @description ID of the website. */ websiteId: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -12538,6 +14487,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -12545,9 +14495,11 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Whether the annotation applies to the entire day. */ allDay?: boolean; /** Format: date-time */ date: string; + /** @description Text of the annotation. */ note: string; }; }; @@ -12560,16 +14512,27 @@ export interface operations { }; content: { 'application/json': { + /** @description Whether the annotation applies to the entire day. */ allDay: boolean; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; /** Format: date-time */ date: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Text of the annotation. */ note: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; + /** @description ID of the website. */ websiteId: string; }; }; @@ -12617,7 +14580,9 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the annotation. */ annotationId: string; + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -12631,16 +14596,27 @@ export interface operations { }; content: { 'application/json': { + /** @description Whether the annotation applies to the entire day. */ allDay: boolean; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; /** Format: date-time */ date: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Text of the annotation. */ note: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; + /** @description ID of the website. */ websiteId: string; }; }; @@ -12688,7 +14664,9 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the annotation. */ annotationId: string; + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -12696,9 +14674,11 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Whether the annotation applies to the entire day. */ allDay?: boolean; /** Format: date-time */ date: string; + /** @description Text of the annotation. */ note: string; }; }; @@ -12711,16 +14691,27 @@ export interface operations { }; content: { 'application/json': { + /** @description Whether the annotation applies to the entire day. */ allDay: boolean; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; /** Format: date-time */ date: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Text of the annotation. */ note: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; + /** @description ID of the website. */ websiteId: string; }; }; @@ -12786,7 +14777,9 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the annotation. */ annotationId: string; + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -12800,7 +14793,10 @@ export interface operations { }; content: { 'application/json': { - /** @constant */ + /** + * @description Whether the operation succeeded. + * @constant + */ ok: true; }; }; @@ -12848,6 +14844,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -12861,9 +14858,15 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description End of the date range as an ISO 8601 date or date-time. + */ endDate: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Start of the date range as an ISO 8601 date or date-time. + */ startDate: string; }; }; @@ -12891,39 +14894,70 @@ export interface operations { getEventData: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description Filter by page title. */ title?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -12937,21 +14971,35 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { + /** @description ID of the event. */ eventId: string; + /** @description Name of the custom event. */ eventName: string; + /** @description Custom properties recorded with the event. */ eventProperties: { + /** @description Date and time the record was created. */ createdAt: string; + /** @description Name of the custom property. */ dataKey: string; + /** @description Data type of the custom property. */ dataType: number; + /** @description Custom property value stored as a date-time. */ dateValue: string; + /** @description Custom property value stored as a number. */ numberValue: number; + /** @description Custom property value stored as a string. */ stringValue: string; }[]; + /** @description ID of the website. */ websiteId: string; }[]; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; }; }; @@ -12997,42 +15045,76 @@ export interface operations { getEventDataPivot: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Name of the custom event. */ eventName: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -13046,21 +15128,36 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { + /** @description Date and time the record was created. */ createdAt: string; + /** @description ID of the event. */ eventId: string; + /** @description Name of the custom event. */ eventName: string; + /** @description Names of the custom properties. */ propertyKeys: string[]; + /** @description Values of the custom properties. */ propertyValues: string[]; + /** @description ID of the visitor session. */ sessionId: string; + /** @description Path portion of the page URL. */ urlPath: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -13106,40 +15203,72 @@ export interface operations { getEventDataArraySeries: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Name of the custom event. */ eventName: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Name of the custom event or session property. */ propertyName: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -13200,39 +15329,70 @@ export interface operations { getEventDataDateSeries: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Name of the custom event. */ eventName: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Name of the custom event or session property. */ propertyName: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -13292,41 +15452,74 @@ export interface operations { getEventDataNumericSeries: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Name of the custom event. */ eventName: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Numeric aggregation to calculate for the selected property. */ metric?: 'sum' | 'avg' | 'count'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Name of the custom event or session property. */ propertyName: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -13386,38 +15579,68 @@ export interface operations { getEventDataNumericStats: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Name of the custom event. */ eventName: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Name of the custom event or session property. */ propertyName: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description Filter by page title. */ title?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -13431,9 +15654,13 @@ export interface operations { }; content: { 'application/json': { + /** @description Arithmetic mean of the numeric property values. */ average: number; + /** @description Maximum numeric property value. */ max: number; + /** @description Median of the numeric property values. */ median: number; + /** @description Minimum numeric property value. */ min: number; total: number; }; @@ -13480,40 +15707,72 @@ export interface operations { getEventDataPropertySeries: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Name of the custom event. */ eventName: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Name of the custom event or session property. */ propertyName: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -13576,7 +15835,9 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the event. */ eventId: string; + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -13590,20 +15851,33 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Name of the custom property. */ dataKey: string; + /** @description Data type of the custom property. */ dataType: number; - /** Format: date-time */ + /** + * Format: date-time + * @description Custom property value stored as a date-time. + */ dateValue: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Custom property value stored as a number. */ numberValue: { d: number[]; e: number; s: number; }; + /** @description Custom property value stored as a string. */ stringValue: string; + /** @description ID of the website event. */ websiteEventId: string; + /** @description ID of the website. */ websiteId: string; }[]; }; @@ -13631,36 +15905,64 @@ export interface operations { getEventDataEvents: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description Filter by page title. */ title?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -13674,9 +15976,13 @@ export interface operations { }; content: { 'application/json': { + /** @description Data type of the custom property. */ dataType: number; + /** @description Name of the custom event. */ eventName?: string; + /** @description Name of the custom event or session property. */ propertyName: string; + /** @description Value of the custom property. */ propertyValue?: string; total: number; }[]; @@ -13723,37 +16029,66 @@ export interface operations { getEventDataFields: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Name of the custom event. */ eventName?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description Filter by page title. */ title?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -13767,7 +16102,9 @@ export interface operations { }; content: { 'application/json': { + /** @description Data type of the custom property. */ dataType: number; + /** @description Name of the custom event or session property. */ propertyName: string; total: number; }[]; @@ -13814,36 +16151,64 @@ export interface operations { getEventDataProperties: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description Filter by page title. */ title?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -13857,8 +16222,11 @@ export interface operations { }; content: { 'application/json': { + /** @description Data type of the custom property. */ dataType: number; + /** @description Name of the custom event. */ eventName: string; + /** @description Name of the custom event or session property. */ propertyName: string; total: number; }[]; @@ -13905,36 +16273,64 @@ export interface operations { getEventDataStats: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description Filter by page title. */ title?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -13995,39 +16391,70 @@ export interface operations { getEventDataValues: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Data type of the custom property. */ dataType?: number; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Name of the custom event. */ eventName?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Name of the custom event or session property. */ propertyName: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description Filter by page title. */ title?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -14087,41 +16514,77 @@ export interface operations { getWebsiteEvents: { parameters: { query?: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Comparison period: prev for the previous period or yoy for the same period last year. */ compare?: 'prev' | 'yoy'; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt?: number; + /** @description End of the date range as an ISO 8601 date or date-time. */ endDate?: string; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description Search text used to filter results. */ search?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt?: number; + /** @description Start of the date range as an ISO 8601 date or date-time. */ startDate?: string; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; @@ -14183,39 +16646,70 @@ export interface operations { getWebsiteEventSeries: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Maximum number of rows to return. */ limit?: number; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone: string; + /** @description Filter by page title. */ title?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -14276,41 +16770,74 @@ export interface operations { getWebsiteEventStats: { parameters: { query?: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Comparison period: prev for the previous period or yoy for the same period last year. */ compare?: 'prev' | 'yoy'; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt?: number; + /** @description End of the date range as an ISO 8601 date or date-time. */ endDate?: string; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt?: number; + /** @description Start of the date range as an ISO 8601 date or date-time. */ startDate?: string; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -14324,11 +16851,16 @@ export interface operations { }; content: { 'application/json': { + /** @description Data returned by the operation. */ data: { + /** @description Analytics for the comparison period. */ comparison: { events: number; + /** @description Number of unique events. */ uniqueEvents: number; + /** @description Unique visitor counts for the selected period. */ visitors: number; + /** @description Visit counts for the selected period. */ visits: number; }[]; length: number; @@ -14377,19 +16909,30 @@ export interface operations { exportWebsite: { parameters: { query?: { + /** @description Comparison period: prev for the previous period or yoy for the same period last year. */ compare?: 'prev' | 'yoy'; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt?: number; + /** @description End of the date range as an ISO 8601 date or date-time. */ endDate?: string; + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt?: number; + /** @description Start of the date range as an ISO 8601 date or date-time. */ startDate?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -14457,42 +17000,77 @@ export interface operations { getWebsiteMetrics: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Comparison period: prev for the previous period or yoy for the same period last year. */ compare?: 'prev' | 'yoy'; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt?: number; + /** @description End of the date range as an ISO 8601 date or date-time. */ endDate?: string; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Maximum number of rows to return. */ limit?: number; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Number of rows to skip before returning results. */ offset?: number; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description Search text used to filter results. */ search?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt?: number; + /** @description Start of the date range as an ISO 8601 date or date-time. */ startDate?: string; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; /** @description Dimension to rank: path, entry, exit, title, query, hostname, referrer, domain, channel, event, tag, browser, os, device, screen, language, country, region, city, distinctId, utmSource, utmMedium, utmCampaign, utmContent, utmTerm. */ type: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; @@ -14554,45 +17132,82 @@ export interface operations { getWebsiteExpandedMetrics: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Comparison period: prev for the previous period or yoy for the same period last year. */ compare?: 'prev' | 'yoy'; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt?: number; + /** @description End of the date range as an ISO 8601 date or date-time. */ endDate?: string; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Maximum number of rows to return. */ limit?: number; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Number of rows to skip before returning results. */ offset?: number; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description Search text used to filter results. */ search?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt?: number; + /** @description Start of the date range as an ISO 8601 date or date-time. */ startDate?: string; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description Type of resource or analytics dimension to return. */ type: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -14606,11 +17221,17 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of visits with only one pageview. */ bounces: number; + /** @description Display name of the resource. */ name: string; + /** @description Pageview counts for the selected period. */ pageviews: number; + /** @description Total visit duration in seconds. */ totaltime: number; + /** @description Unique visitor counts for the selected period. */ visitors: number; + /** @description Visit counts for the selected period. */ visits: number; }[]; }; @@ -14656,37 +17277,69 @@ export interface operations { getWebsitePageviews: { parameters: { query?: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Comparison period: prev for the previous period or yoy for the same period last year. */ compare?: 'prev' | 'yoy'; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt?: number; + /** @description End of the date range as an ISO 8601 date or date-time. */ endDate?: string; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt?: number; + /** @description Start of the date range as an ISO 8601 date or date-time. */ startDate?: string; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; @@ -14750,6 +17403,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -14767,13 +17421,19 @@ export interface operations { enabled: boolean; } | { + /** @description CSS selector for elements excluded from recordings. */ blockSelector: string; enabled: boolean; + /** @description Whether heatmap recording is enabled. */ heatmapEnabled: boolean; + /** @description Fraction of sessions to record for heatmaps, from 0 to 1. */ heatmapSampleRate: number; + /** @description Privacy masking level used by the recorder: strict or moderate. */ maskLevel: 'strict' | 'moderate'; maxDuration: number; + /** @description Whether session replay recording is enabled. */ replayEnabled: boolean; + /** @description Fraction of sessions to record for replay, from 0 to 1. */ sampleRate: number; }; }; @@ -14783,46 +17443,84 @@ export interface operations { getWebsiteReplays: { parameters: { query?: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Comparison period: prev for the previous period or yoy for the same period last year. */ compare?: 'prev' | 'yoy'; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt?: number; + /** @description End of the date range as an ISO 8601 date or date-time. */ endDate?: string; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Minimum replay duration in seconds. */ minDuration?: number; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description Search text used to filter results. */ search?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt?: number; + /** @description Start of the date range as an ISO 8601 date or date-time. */ startDate?: string; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -14836,28 +17534,50 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { + /** @description Browser used by the visitor. */ browser: string; + /** @description Number of stored recording chunks. */ chunkCount: number; + /** @description City of the visitor. */ city: string; + /** @description Country code of the visitor. */ country: string; + /** @description Date and time the record was created. */ createdAt: string; + /** @description Device category used by the visitor. */ device: string; + /** @description Replay duration in milliseconds. */ duration: number; + /** @description Date and time the recording ended. */ endedAt: string; + /** @description Number of recorded replay events. */ eventCount: number; + /** @description Unique identifier of the resource. */ id: string; + /** @description Operating system used by the visitor. */ os: string; + /** @description ID of the visitor session. */ sessionId: string; + /** @description Date and time the recording started. */ startedAt: string; + /** @description ID of the website. */ websiteId: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -14905,7 +17625,9 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the session replay. */ replayId: string; + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -14919,13 +17641,22 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of stored recording chunks. */ chunkCount: number; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the recording ended. + */ endedAt: string; + /** @description Number of recorded replay events. */ eventCount: number; events: unknown[]; + /** @description ID of the visitor session. */ sessionId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the recording started. + */ startedAt: string; }; }; @@ -14953,13 +17684,18 @@ export interface operations { getWebsiteSavedReplays: { parameters: { query?: { + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Search text used to filter results. */ search?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -14973,22 +17709,40 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the visit. */ visitId: string; + /** @description ID of the website. */ websiteId: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -15036,7 +17790,9 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the session replay. */ replayId: string; + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -15050,6 +17806,7 @@ export interface operations { }; content: { 'application/json': { + /** @description Whether the replay has been saved. */ isSaved: boolean; }; }; @@ -15079,7 +17836,9 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the session replay. */ replayId: string; + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -15087,7 +17846,9 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Whether the replay has been saved. */ isSaved: boolean; + /** @description Display name of the resource. */ name?: string; }; }; @@ -15100,6 +17861,7 @@ export interface operations { }; content: { 'application/json': { + /** @description Whether the operation succeeded. */ ok: boolean; }; }; @@ -15145,13 +17907,18 @@ export interface operations { getWebsiteReports: { parameters: { query?: { + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Type of resource or analytics dimension to return. */ type?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -15165,13 +17932,22 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: ({ - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Description of the resource. */ description: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -15192,21 +17968,34 @@ export interface operations { length: number; }; type: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; + /** @description ID of the website. */ websiteId: string; } & { website?: { + /** @description Domain name associated with the resource. */ domain: string; + /** @description ID of the associated user. */ userId: string; }; })[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -15254,6 +18043,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -15267,7 +18057,10 @@ export interface operations { }; content: { 'application/json': { - /** @constant */ + /** + * @description Whether the operation succeeded. + * @constant + */ ok: true; }; }; @@ -15295,42 +18088,76 @@ export interface operations { getWebsiteRevenueChart: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Comparison period: prev for the previous period or yoy for the same period last year. */ compare?: 'prev' | 'yoy'; + /** @description Country code of the visitor. */ country?: string; + /** @description Currency code used for revenue values. */ currency: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt?: number; + /** @description End of the date range as an ISO 8601 date or date-time. */ endDate?: string; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt?: number; + /** @description Start of the date range as an ISO 8601 date or date-time. */ startDate?: string; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -15345,6 +18172,7 @@ export interface operations { content: { 'application/json': { chart: { + /** @description Number of matching records. */ count: number; t: string; x: string; @@ -15394,43 +18222,78 @@ export interface operations { getWebsiteRevenueMetrics: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Comparison period: prev for the previous period or yoy for the same period last year. */ compare?: 'prev' | 'yoy'; + /** @description Country code of the visitor. */ country?: string; + /** @description Currency code used for revenue values. */ currency: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt?: number; + /** @description End of the date range as an ISO 8601 date or date-time. */ endDate?: string; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt?: number; + /** @description Start of the date range as an ISO 8601 date or date-time. */ startDate?: string; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description Type of resource or analytics dimension to return. */ type: 'country' | 'region' | 'referrer' | 'channel'; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -15445,11 +18308,14 @@ export interface operations { content: { 'application/json': | { + /** @description Display name of the resource. */ name: string; value: number; }[] | { + /** @description Country code of the visitor. */ country: string; + /** @description Display name of the resource. */ name: string; value: number; }[]; @@ -15496,46 +18362,84 @@ export interface operations { getWebsiteRevenueSessions: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Comparison period: prev for the previous period or yoy for the same period last year. */ compare?: 'prev' | 'yoy'; + /** @description Country code of the visitor. */ country?: string; + /** @description Currency code used for revenue values. */ currency: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt?: number; + /** @description End of the date range as an ISO 8601 date or date-time. */ endDate?: string; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description Search text used to filter results. */ search?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt?: number; + /** @description Start of the date range as an ISO 8601 date or date-time. */ startDate?: string; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -15549,31 +18453,55 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { + /** @description Browser used by the visitor. */ browser: string; + /** @description City of the visitor. */ city: string; + /** @description Country code of the visitor. */ country: string; + /** @description Date and time the record was created. */ createdAt: string; + /** @description Device category used by the visitor. */ device: string; events: number; + /** @description Date and time of the first recorded activity. */ firstAt: string; + /** @description Hostname on which the activity occurred. */ hostname: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Preferred language reported by the visitor browser. */ language: string; + /** @description Date and time of the most recent recorded activity. */ lastAt: string; + /** @description Operating system used by the visitor. */ os: string; + /** @description Region or subdivision of the visitor. */ region: string; + /** @description Screen resolution of the visitor device. */ screen: string; + /** @description Pageview counts for the selected period. */ views: number; + /** @description Visit counts for the selected period. */ visits: number; + /** @description ID of the website. */ websiteId: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -15619,42 +18547,76 @@ export interface operations { getWebsiteRevenueStats: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Comparison period: prev for the previous period or yoy for the same period last year. */ compare?: 'prev' | 'yoy'; + /** @description Country code of the visitor. */ country?: string; + /** @description Currency code used for revenue values. */ currency: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt?: number; + /** @description End of the date range as an ISO 8601 date or date-time. */ endDate?: string; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt?: number; + /** @description Start of the date range as an ISO 8601 date or date-time. */ startDate?: string; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -15668,6 +18630,7 @@ export interface operations { }; content: { 'application/json': { + /** @description Analytics for the comparison period. */ comparison: unknown; }; }; @@ -15713,11 +18676,14 @@ export interface operations { getWebsiteSegments: { parameters: { query: { + /** @description Search text used to filter results. */ search?: string; + /** @description Type of resource or analytics dimension to return. */ type: 'segment' | 'cohort'; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -15731,12 +18697,20 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -15757,15 +18731,25 @@ export interface operations { length: number; }; type: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the website. */ websiteId: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -15813,6 +18797,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -15820,17 +18805,23 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: { action?: { type: string; value: string; }; dateRange?: string; + /** @description Filters applied to the analytics data. */ filters?: { [key: string]: unknown; }[]; - /** @enum {string} */ + /** + * @description Whether records must match all filters or any filter. + * @enum {string} + */ match?: 'all' | 'any'; }; /** @enum {string} */ @@ -15846,10 +18837,16 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -15870,8 +18867,12 @@ export interface operations { length: number; }; type: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the website. */ websiteId: string; }; }; @@ -15919,7 +18920,9 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the saved segment or cohort. */ segmentId: string; + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -15933,10 +18936,16 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -15957,8 +18966,12 @@ export interface operations { length: number; }; type: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the website. */ websiteId: string; }; }; @@ -16006,7 +19019,9 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the saved segment or cohort. */ segmentId: string; + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -16014,7 +19029,9 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: { [key: string]: unknown; }; @@ -16031,10 +19048,16 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -16055,8 +19078,12 @@ export interface operations { length: number; }; type: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the website. */ websiteId: string; }; }; @@ -16122,7 +19149,9 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the saved segment or cohort. */ segmentId: string; + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -16136,7 +19165,10 @@ export interface operations { }; content: { 'application/json': { - /** @constant */ + /** + * @description Whether the operation succeeded. + * @constant + */ ok: true; }; }; @@ -16182,42 +19214,76 @@ export interface operations { getSessionDataPivot: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Filter by page URL path. */ path?: string; + /** @description Name of the custom event or session property. */ propertyName: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -16231,19 +19297,32 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { + /** @description Date and time the record was created. */ createdAt: string; + /** @description Custom identifier assigned to the visitor. */ distinctId: string; + /** @description Names of the custom properties. */ propertyKeys: string[]; + /** @description Values of the custom properties. */ propertyValues: string[]; + /** @description ID of the visitor session. */ sessionId: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -16289,39 +19368,70 @@ export interface operations { getSessionDataArraySeries: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Name of the custom event or session property. */ propertyName: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -16382,38 +19492,68 @@ export interface operations { getSessionDataDateSeries: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Name of the custom event or session property. */ propertyName: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -16473,40 +19613,72 @@ export interface operations { getSessionDataNumericSeries: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Numeric aggregation to calculate for the selected property. */ metric?: 'sum' | 'avg' | 'count'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Name of the custom event or session property. */ propertyName: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -16566,38 +19738,68 @@ export interface operations { getSessionDataNumericStats: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Name of the custom event or session property. */ propertyName: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -16611,9 +19813,13 @@ export interface operations { }; content: { 'application/json': { + /** @description Arithmetic mean of the numeric property values. */ average: number; + /** @description Maximum numeric property value. */ max: number; + /** @description Median of the numeric property values. */ median: number; + /** @description Minimum numeric property value. */ min: number; total: number; }; @@ -16660,37 +19866,66 @@ export interface operations { getSessionDataProperties: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Name of the custom event or session property. */ propertyName?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description Filter by page title. */ title?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -16704,7 +19939,9 @@ export interface operations { }; content: { 'application/json': { + /** @description Data type of the custom property. */ dataType: number; + /** @description Name of the custom event or session property. */ propertyName: string; total: number; }[]; @@ -16751,39 +19988,70 @@ export interface operations { getSessionDataPropertySeries: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Name of the custom event or session property. */ propertyName: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -16844,39 +20112,70 @@ export interface operations { getSessionDataStats: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Name of the custom event or session property. */ propertyName: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -16894,7 +20193,9 @@ export interface operations { events: number; label: string; sessions: number; + /** @description Pageview counts for the selected period. */ views: number; + /** @description Visit counts for the selected period. */ visits: number; }[]; }; @@ -16940,38 +20241,68 @@ export interface operations { getSessionDataValues: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Data type of the custom property. */ dataType?: number; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Name of the custom event or session property. */ propertyName?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description Filter by page title. */ title?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -17031,41 +20362,77 @@ export interface operations { getWebsiteSessions: { parameters: { query?: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Comparison period: prev for the previous period or yoy for the same period last year. */ compare?: 'prev' | 'yoy'; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt?: number; + /** @description End of the date range as an ISO 8601 date or date-time. */ endDate?: string; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description Search text used to filter results. */ search?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt?: number; + /** @description Start of the date range as an ISO 8601 date or date-time. */ startDate?: string; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; @@ -17129,7 +20496,9 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the visitor session. */ sessionId: string; + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -17191,7 +20560,9 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the visitor session. */ sessionId: string; + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -17205,7 +20576,10 @@ export interface operations { }; content: { 'application/json': { - /** @constant */ + /** + * @description Whether the operation succeeded. + * @constant + */ ok: true; }; }; @@ -17269,13 +20643,18 @@ export interface operations { getWebsiteSessionActivity: { parameters: { query: { + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; }; header?: never; path: { + /** @description ID of the visitor session. */ sessionId: string; + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -17289,15 +20668,24 @@ export interface operations { }; content: { 'application/json': { + /** @description Date and time the record was created. */ createdAt: string; + /** @description ID of the event. */ eventId: string; + /** @description Name of the custom event. */ eventName: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType: number; hasData: boolean; + /** @description Hostname on which the activity occurred. */ hostname: string; + /** @description Domain of the referring page. */ referrerDomain: string; + /** @description Path portion of the page URL. */ urlPath: string; + /** @description Query string portion of the page URL. */ urlQuery: string; + /** @description ID of the visit. */ visitId: string; }[]; }; @@ -17345,7 +20733,9 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the visitor session. */ sessionId: string; + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -17359,13 +20749,21 @@ export interface operations { }; content: { 'application/json': { + /** @description Date and time the record was created. */ createdAt: string; + /** @description Name of the custom property. */ dataKey: string; + /** @description Data type of the custom property. */ dataType: number; + /** @description Custom property value stored as a date-time. */ dateValue: string; + /** @description Custom property value stored as a number. */ numberValue: number; + /** @description ID of the visitor session. */ sessionId: string; + /** @description Custom property value stored as a string. */ stringValue: string; + /** @description ID of the website. */ websiteId: string; }[]; }; @@ -17393,21 +20791,34 @@ export interface operations { getWebsiteSessionReplays: { parameters: { query?: { + /** @description Comparison period: prev for the previous period or yoy for the same period last year. */ compare?: 'prev' | 'yoy'; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt?: number; + /** @description End of the date range as an ISO 8601 date or date-time. */ endDate?: string; + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt?: number; + /** @description Start of the date range as an ISO 8601 date or date-time. */ startDate?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; }; header?: never; path: { + /** @description ID of the visitor session. */ sessionId: string; + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -17421,28 +20832,50 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { + /** @description Browser used by the visitor. */ browser: string; + /** @description Number of stored recording chunks. */ chunkCount: number; + /** @description City of the visitor. */ city: string; + /** @description Country code of the visitor. */ country: string; + /** @description Date and time the record was created. */ createdAt: string; + /** @description Device category used by the visitor. */ device: string; + /** @description Replay duration in milliseconds. */ duration: number; + /** @description Date and time the recording ended. */ endedAt: string; + /** @description Number of recorded replay events. */ eventCount: number; + /** @description Unique identifier of the resource. */ id: string; + /** @description Operating system used by the visitor. */ os: string; + /** @description ID of the visitor session. */ sessionId: string; + /** @description Date and time the recording started. */ startedAt: string; + /** @description ID of the website. */ websiteId: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -17488,36 +20921,64 @@ export interface operations { getWebsiteSessionStats: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description Filter by page title. */ title?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -17574,37 +21035,66 @@ export interface operations { getWebsiteSessionsWeekly: { parameters: { query: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt: number; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt: number; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone: string; + /** @description Filter by page title. */ title?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -17661,37 +21151,66 @@ export interface operations { getWebsiteShares: { parameters: { query?: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Maximum number of results to include. */ maxResults?: number; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Page number, starting at 1. */ page?: number; + /** @description Number of results per page. */ pageSize?: number; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description Filter by page title. */ title?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -17705,13 +21224,22 @@ export interface operations { }; content: { 'application/json': { + /** @description Number of matching records. */ count: number; + /** @description Data returned by the operation. */ data: { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description ID of the resource being shared. */ entityId: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -17731,16 +21259,27 @@ export interface operations { | { length: number; }; + /** @description Type of resource made available by the share. */ shareType: number; + /** @description URL slug used to access the resource. */ slug: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; }[]; + /** @description Whether the results were truncated by the maximum result limit. */ isCapped?: boolean; + /** @description Field to sort the results by. */ orderBy?: string; + /** @description Page number, starting at 1. */ page: number; + /** @description Number of results per page. */ pageSize: number; + /** @description Search text used to filter results. */ search?: string; + /** @description Whether to sort results in descending order. */ sortDescending?: boolean; }; }; @@ -17788,6 +21327,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -17795,7 +21335,9 @@ export interface operations { requestBody: { content: { 'application/json': { + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters?: { [key: string]: unknown; }; @@ -17810,11 +21352,18 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description ID of the resource being shared. */ entityId: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Configuration parameters for the resource. */ parameters: | string | number @@ -17834,9 +21383,14 @@ export interface operations { | { length: number; }; + /** @description Type of resource made available by the share. */ shareType: number; + /** @description URL slug used to access the resource. */ slug: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; }; }; @@ -17882,37 +21436,69 @@ export interface operations { getWebsiteStats: { parameters: { query?: { + /** @description Browser used by the visitor. */ browser?: string; + /** @description City of the visitor. */ city?: string; + /** @description ID of a saved cohort used to filter visitors. */ cohort?: string; + /** @description Comparison period: prev for the previous period or yoy for the same period last year. */ compare?: 'prev' | 'yoy'; + /** @description Country code of the visitor. */ country?: string; + /** @description Device category used by the visitor. */ device?: string; + /** @description Custom identifier assigned to the visitor. */ distinctId?: string; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt?: number; + /** @description End of the date range as an ISO 8601 date or date-time. */ endDate?: string; + /** @description Filter by custom event name. */ event?: string; + /** @description Event type: 1 for a pageview or 2 for a custom event. */ eventType?: number; + /** @description Set a non-empty value to exclude visits with only one pageview. */ excludeBounce?: string; + /** @description Hostname on which the activity occurred. */ hostname?: string; + /** @description Preferred language reported by the visitor browser. */ language?: string; + /** @description Whether records must match all filters or any filter. */ match?: 'all' | 'any'; + /** @description Operating system used by the visitor. */ os?: string; + /** @description Filter by page URL path. */ path?: string; + /** @description Filter by page URL query string. */ query?: string; + /** @description Filter by referring URL. */ referrer?: string; + /** @description Region or subdivision of the visitor. */ region?: string; + /** @description ID of a saved segment used to filter results. */ segment?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt?: number; + /** @description Start of the date range as an ISO 8601 date or date-time. */ startDate?: string; + /** @description Tag attached to the tracked activity. */ tag?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Filter by page title. */ title?: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; + /** @description UTM campaign name. */ utmCampaign?: string; + /** @description UTM campaign content. */ utmContent?: string; + /** @description UTM campaign medium. */ utmMedium?: string; + /** @description UTM campaign source. */ utmSource?: string; + /** @description UTM campaign search term. */ utmTerm?: string; }; header?: never; @@ -17976,6 +21562,7 @@ export interface operations { query?: never; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -17983,9 +21570,15 @@ export interface operations { requestBody: { content: { 'application/json': { - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the associated team. + */ teamId?: string; - /** Format: uuid */ + /** + * Format: uuid + * @description ID of the associated user. + */ userId?: string; }; }; @@ -17998,15 +21591,27 @@ export interface operations { }; content: { 'application/json': { - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was created. + */ createdAt: string; + /** @description ID of the user who created the resource. */ createdBy: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was deleted, if applicable. + */ deletedAt: string; + /** @description Domain name associated with the resource. */ domain: string; + /** @description Unique identifier of the resource. */ id: string; + /** @description Display name of the resource. */ name: string; + /** @description Whether recording is enabled for the website. */ recorderEnabled: boolean; + /** @description Session replay and heatmap recording configuration. */ replayConfig: | string | number @@ -18026,11 +21631,19 @@ export interface operations { | { length: number; }; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the website analytics were last reset. + */ resetAt: string; + /** @description ID of the associated team. */ teamId: string; - /** Format: date-time */ + /** + * Format: date-time + * @description Date and time the record was last updated. + */ updatedAt: string; + /** @description ID of the associated user. */ userId: string; }; }; @@ -18076,18 +21689,28 @@ export interface operations { getWebsiteValues: { parameters: { query: { + /** @description Comparison period: prev for the previous period or yoy for the same period last year. */ compare?: 'prev' | 'yoy'; + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt?: number; + /** @description End of the date range as an ISO 8601 date or date-time. */ endDate?: string; + /** @description Search text used to filter results. */ search?: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt?: number; + /** @description Start of the date range as an ISO 8601 date or date-time. */ startDate?: string; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; + /** @description Type of resource or analytics dimension to return. */ type: string; + /** @description Time interval used to group results: minute, hour, day, month, or year. */ unit?: string; }; header?: never; path: { + /** @description ID of the website. */ websiteId: string; }; cookie?: never; @@ -18144,9 +21767,13 @@ export interface operations { getWebsitesCharts: { parameters: { query: { + /** @description End of the date range as a Unix timestamp in milliseconds. */ endAt?: number; + /** @description Comma-separated resource IDs. Provide between 1 and 20 IDs. */ ids: string; + /** @description Start of the date range as a Unix timestamp in milliseconds. */ startAt?: number; + /** @description IANA time zone used to interpret dates and group results, for example America/New_York. */ timezone?: string; }; header?: never; @@ -18162,6 +21789,7 @@ export interface operations { }; content: { 'application/json': { + /** @description Data returned by the operation. */ data: { [key: string]: { total: number; diff --git a/public/openapi.json b/public/openapi.json deleted file mode 100644 index c3e7e943d..000000000 --- a/public/openapi.json +++ /dev/null @@ -1,38242 +0,0 @@ -{ - "components": { - "responses": { - "BadRequestResponse": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "ForbiddenResponse": { - "content": { - "application/json": { - "example": { - "error": { - "code": "forbidden", - "message": "Forbidden.", - "status": 403 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Forbidden." - }, - "NotFoundResponse": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - }, - "PayloadTooLargeResponse": { - "content": { - "application/json": { - "example": { - "error": { - "code": "payload-too-large", - "message": "Payload too large.", - "status": 413 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Payload too large." - }, - "ServerErrorResponse": { - "content": { - "application/json": { - "example": { - "error": { - "code": "server-error", - "message": "Server error.", - "status": 500 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Server error." - }, - "ServiceUnavailableResponse": { - "content": { - "application/json": { - "example": { - "error": { - "code": "service-unavailable", - "message": "Service unavailable.", - "status": 503 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Service unavailable." - }, - "UnauthorizedResponse": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "schemas": { - "ActiveVisitors": { - "additionalProperties": false, - "properties": { - "visitors": { - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "visitors" - ], - "type": "object" - }, - "ApiError": { - "additionalProperties": false, - "description": "Standard Umami API error response.", - "properties": { - "error": { - "additionalProperties": {}, - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "status": { - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - } - }, - "required": [ - "message", - "code", - "status" - ], - "type": "object" - } - }, - "required": [ - "error" - ], - "type": "object" - }, - "CreateWebsiteRequest": { - "properties": { - "domain": { - "maxLength": 500, - "pattern": "^(localhost(:[1-9]\\d{0,4})?|((?=[a-z0-9-_]{1,63}\\.)(xn--)?[a-z0-9-_]+(-[a-z0-9-_]+)*\\.)+(xn--)?[a-z0-9-_]{2,63})$", - "type": "string" - }, - "id": { - "anyOf": [ - { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - }, - { - "type": "null" - } - ] - }, - "name": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "shareId": { - "anyOf": [ - { - "maxLength": 50, - "type": "string" - }, - { - "type": "null" - } - ] - }, - "teamId": { - "anyOf": [ - { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - }, - { - "type": "null" - } - ] - } - }, - "required": [ - "name", - "domain" - ], - "type": "object" - }, - "LoginRequest": { - "properties": { - "password": { - "description": "Umami password.", - "type": "string" - }, - "username": { - "description": "Umami username.", - "type": "string" - } - }, - "required": [ - "username", - "password" - ], - "type": "object" - }, - "LoginResponse": { - "anyOf": [ - { - "additionalProperties": false, - "properties": { - "partialToken": { - "type": "string" - }, - "requiresTwoFactor": { - "const": true, - "type": "boolean" - } - }, - "required": [ - "requiresTwoFactor", - "partialToken" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "token": { - "type": "string" - }, - "user": { - "$ref": "#/components/schemas/LoginUser" - } - }, - "required": [ - "token", - "user" - ], - "type": "object" - } - ] - }, - "LoginTeam": { - "additionalProperties": false, - "properties": { - "id": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - }, - "logoUrl": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "name", - "logoUrl" - ], - "type": "object" - }, - "LoginUser": { - "additionalProperties": false, - "properties": { - "createdAt": { - "anyOf": [ - { - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", - "type": "string" - }, - { - "type": "null" - } - ] - }, - "id": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - }, - "isAdmin": { - "type": "boolean" - }, - "role": { - "type": "string" - }, - "teams": { - "items": { - "$ref": "#/components/schemas/LoginTeam" - }, - "type": "array" - }, - "username": { - "type": "string" - } - }, - "required": [ - "id", - "username", - "role", - "createdAt", - "isAdmin", - "teams" - ], - "type": "object" - }, - "MetricRow": { - "additionalProperties": false, - "properties": { - "t": { - "type": "string" - }, - "x": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Dimension value (e.g. a path or country)." - }, - "y": { - "description": "Count of views/events or unique visitors.", - "type": "number" - } - }, - "required": [ - "x", - "y" - ], - "type": "object" - }, - "MetricRows": { - "items": { - "$ref": "#/components/schemas/MetricRow" - }, - "type": "array" - }, - "OAuthAuthorizationDecision": { - "properties": { - "client_id": { - "maxLength": 2048, - "type": "string" - }, - "code_challenge": { - "maxLength": 128, - "type": "string" - }, - "code_challenge_method": { - "maxLength": 10, - "type": "string" - }, - "decision": { - "enum": [ - "approve", - "deny" - ], - "type": "string" - }, - "redirect_uri": { - "maxLength": 2048, - "type": "string" - }, - "resource": { - "maxLength": 2048, - "type": "string" - }, - "response_type": { - "type": "string" - }, - "scope": { - "maxLength": 500, - "type": "string" - }, - "state": { - "maxLength": 1024, - "type": "string" - } - }, - "required": [ - "client_id", - "decision" - ], - "type": "object" - }, - "OAuthAuthorizationDetails": { - "additionalProperties": false, - "properties": { - "client": { - "additionalProperties": false, - "properties": { - "id": { - "type": "string" - }, - "logoUri": { - "type": "string" - }, - "name": { - "type": "string" - }, - "source": { - "enum": [ - "metadata-document", - "registered" - ], - "type": "string" - }, - "uri": { - "type": "string" - } - }, - "required": [ - "id", - "name", - "source" - ], - "type": "object" - }, - "redirectUri": { - "type": "string" - }, - "resource": { - "type": "string" - }, - "scopes": { - "items": { - "additionalProperties": false, - "properties": { - "description": { - "type": "string" - }, - "scope": { - "type": "string" - } - }, - "required": [ - "scope", - "description" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "client", - "scopes", - "redirectUri", - "resource" - ], - "type": "object" - }, - "OAuthAuthorizationRedirect": { - "additionalProperties": false, - "properties": { - "redirectUrl": { - "type": "string" - } - }, - "required": [ - "redirectUrl" - ], - "type": "object" - }, - "OAuthClientRegistrationRequest": { - "properties": { - "application_type": { - "enum": [ - "web", - "native" - ], - "type": "string" - }, - "client_name": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "client_uri": { - "maxLength": 2048, - "type": "string" - }, - "grant_types": { - "items": { - "type": "string" - }, - "type": "array" - }, - "logo_uri": { - "maxLength": 2048, - "type": "string" - }, - "redirect_uris": { - "items": { - "maxLength": 2048, - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - }, - "response_types": { - "items": { - "type": "string" - }, - "type": "array" - }, - "scope": { - "maxLength": 500, - "type": "string" - }, - "software_id": { - "maxLength": 255, - "type": "string" - }, - "software_version": { - "maxLength": 255, - "type": "string" - }, - "token_endpoint_auth_method": { - "const": "none", - "type": "string" - } - }, - "required": [ - "redirect_uris", - "client_name" - ], - "type": "object" - }, - "OAuthClientRegistrationResponse": { - "additionalProperties": false, - "properties": { - "application_type": { - "enum": [ - "web", - "native" - ], - "type": "string" - }, - "client_id": { - "type": "string" - }, - "client_id_issued_at": { - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "client_name": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "client_uri": { - "maxLength": 2048, - "type": "string" - }, - "grant_types": { - "items": { - "type": "string" - }, - "type": "array" - }, - "logo_uri": { - "maxLength": 2048, - "type": "string" - }, - "redirect_uris": { - "items": { - "maxLength": 2048, - "type": "string" - }, - "maxItems": 20, - "minItems": 1, - "type": "array" - }, - "response_types": { - "items": { - "type": "string" - }, - "type": "array" - }, - "scope": { - "maxLength": 500, - "type": "string" - }, - "software_id": { - "maxLength": 255, - "type": "string" - }, - "software_version": { - "maxLength": 255, - "type": "string" - }, - "token_endpoint_auth_method": { - "const": "none", - "type": "string" - } - }, - "required": [ - "redirect_uris", - "client_name", - "token_endpoint_auth_method", - "grant_types", - "response_types", - "client_id", - "client_id_issued_at" - ], - "type": "object" - }, - "OAuthErrorResponse": { - "additionalProperties": false, - "properties": { - "error": { - "type": "string" - }, - "error_description": { - "type": "string" - } - }, - "required": [ - "error" - ], - "type": "object" - }, - "OAuthRevocationRequest": { - "properties": { - "token": { - "type": "string" - }, - "token_type_hint": { - "type": "string" - } - }, - "required": [ - "token" - ], - "type": "object" - }, - "OAuthTokenRequest": { - "properties": { - "client_id": { - "type": "string" - }, - "code": { - "type": "string" - }, - "code_verifier": { - "type": "string" - }, - "grant_type": { - "enum": [ - "authorization_code", - "refresh_token" - ], - "type": "string" - }, - "redirect_uri": { - "type": "string" - }, - "refresh_token": { - "type": "string" - }, - "resource": { - "type": "string" - }, - "scope": { - "type": "string" - } - }, - "required": [ - "grant_type" - ], - "type": "object" - }, - "OAuthTokenResponse": { - "additionalProperties": false, - "properties": { - "access_token": { - "type": "string" - }, - "expires_in": { - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "refresh_token": { - "type": "string" - }, - "scope": { - "type": "string" - }, - "token_type": { - "const": "Bearer", - "type": "string" - } - }, - "required": [ - "access_token", - "token_type", - "expires_in", - "refresh_token", - "scope" - ], - "type": "object" - }, - "Ok": { - "additionalProperties": false, - "description": "Successful operation response.", - "properties": { - "ok": { - "const": true, - "type": "boolean" - } - }, - "required": [ - "ok" - ], - "type": "object" - }, - "ReplayConfig": { - "additionalProperties": {}, - "properties": { - "blockSelector": { - "type": "string" - }, - "heatmapEnabled": { - "type": "boolean" - }, - "heatmapSampleRate": { - "maximum": 1, - "minimum": 0, - "type": "number" - }, - "maskLevel": { - "enum": [ - "strict", - "moderate" - ], - "type": "string" - }, - "maxDuration": { - "exclusiveMinimum": 0, - "maximum": 9007199254740991, - "type": "integer" - }, - "replayEnabled": { - "type": "boolean" - }, - "sampleRate": { - "maximum": 1, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "ReplayConfigInput": { - "properties": { - "blockSelector": { - "type": "string" - }, - "heatmapEnabled": { - "type": "boolean" - }, - "heatmapSampleRate": { - "maximum": 1, - "minimum": 0, - "type": "number" - }, - "maskLevel": { - "enum": [ - "strict", - "moderate" - ], - "type": "string" - }, - "maxDuration": { - "exclusiveMinimum": 0, - "maximum": 9007199254740991, - "type": "integer" - }, - "replayEnabled": { - "type": "boolean" - }, - "sampleRate": { - "maximum": 1, - "minimum": 0, - "type": "number" - } - }, - "type": "object" - }, - "TimeSeriesPoint": { - "additionalProperties": false, - "properties": { - "x": { - "description": "Bucket start (ISO date/time).", - "type": "string" - }, - "y": { - "description": "Value for the bucket.", - "type": "number" - } - }, - "required": [ - "x", - "y" - ], - "type": "object" - }, - "UpdateWebsiteRequest": { - "properties": { - "domain": { - "maxLength": 500, - "pattern": "^(localhost(:[1-9]\\d{0,4})?|((?=[a-z0-9-_]{1,63}\\.)(xn--)?[a-z0-9-_]+(-[a-z0-9-_]+)*\\.)+(xn--)?[a-z0-9-_]{2,63})$", - "type": "string" - }, - "name": { - "maxLength": 100, - "minLength": 1, - "type": "string" - }, - "replayConfig": { - "anyOf": [ - { - "$ref": "#/components/schemas/ReplayConfigInput" - }, - { - "type": "null" - } - ] - }, - "shareId": { - "anyOf": [ - { - "maxLength": 50, - "type": "string" - }, - { - "type": "null" - } - ] - } - }, - "type": "object" - }, - "Website": { - "additionalProperties": false, - "properties": { - "createdAt": { - "anyOf": [ - { - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", - "type": "string" - }, - { - "type": "null" - } - ] - }, - "createdBy": { - "anyOf": [ - { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - }, - { - "type": "null" - } - ] - }, - "deletedAt": { - "anyOf": [ - { - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", - "type": "string" - }, - { - "type": "null" - } - ] - }, - "domain": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "id": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - }, - "name": { - "type": "string" - }, - "recorderEnabled": { - "type": "boolean" - }, - "replayConfig": { - "anyOf": [ - { - "$ref": "#/components/schemas/ReplayConfig" - }, - { - "type": "null" - } - ] - }, - "resetAt": { - "anyOf": [ - { - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", - "type": "string" - }, - { - "type": "null" - } - ] - }, - "shareId": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "teamId": { - "anyOf": [ - { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - }, - { - "type": "null" - } - ] - }, - "updatedAt": { - "anyOf": [ - { - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", - "type": "string" - }, - { - "type": "null" - } - ] - }, - "user": { - "$ref": "#/components/schemas/WebsiteUser" - }, - "userId": { - "anyOf": [ - { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - }, - { - "type": "null" - } - ] - } - }, - "required": [ - "id", - "name", - "domain", - "resetAt", - "userId", - "teamId", - "createdBy", - "createdAt", - "updatedAt", - "deletedAt", - "recorderEnabled", - "replayConfig", - "shareId" - ], - "type": "object" - }, - "WebsiteEvent": { - "additionalProperties": {}, - "properties": { - "createdAt": { - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", - "type": "string" - }, - "distinctId": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "eventName": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "eventType": { - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "hostname": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "id": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - }, - "pageTitle": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "referrerDomain": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "sessionId": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - }, - "urlPath": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "urlQuery": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "websiteId": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - } - }, - "required": [ - "id", - "websiteId", - "sessionId", - "createdAt", - "eventType" - ], - "type": "object" - }, - "WebsiteEventPage": { - "additionalProperties": false, - "properties": { - "count": { - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" - }, - "data": { - "items": { - "$ref": "#/components/schemas/WebsiteEvent" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "page": { - "exclusiveMinimum": 0, - "maximum": 9007199254740991, - "type": "integer" - }, - "pageSize": { - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - }, - "WebsitePage": { - "additionalProperties": false, - "properties": { - "count": { - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" - }, - "data": { - "items": { - "$ref": "#/components/schemas/Website" - }, - "type": "array" - }, - "orderBy": { - "type": "string" - }, - "page": { - "exclusiveMinimum": 0, - "maximum": 9007199254740991, - "type": "integer" - }, - "pageSize": { - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" - }, - "search": { - "type": "string" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - }, - "WebsitePageviews": { - "additionalProperties": false, - "properties": { - "compare": { - "additionalProperties": false, - "description": "Present when `compare` was requested.", - "properties": { - "endDate": { - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", - "type": "string" - }, - "pageviews": { - "items": { - "$ref": "#/components/schemas/TimeSeriesPoint" - }, - "type": "array" - }, - "sessions": { - "items": { - "$ref": "#/components/schemas/TimeSeriesPoint" - }, - "type": "array" - }, - "startDate": { - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", - "type": "string" - } - }, - "required": [ - "pageviews", - "sessions", - "startDate", - "endDate" - ], - "type": "object" - }, - "endDate": { - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", - "type": "string" - }, - "pageviews": { - "items": { - "$ref": "#/components/schemas/TimeSeriesPoint" - }, - "type": "array" - }, - "sessions": { - "items": { - "$ref": "#/components/schemas/TimeSeriesPoint" - }, - "type": "array" - }, - "startDate": { - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", - "type": "string" - } - }, - "required": [ - "pageviews", - "sessions" - ], - "type": "object" - }, - "WebsiteSession": { - "additionalProperties": {}, - "properties": { - "browser": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "city": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "country": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "createdAt": { - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", - "type": "string" - }, - "device": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "distinctId": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "events": { - "type": "number" - }, - "firstAt": { - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", - "type": "string" - }, - "hostname": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "id": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - }, - "language": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "lastAt": { - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", - "type": "string" - }, - "os": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "region": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "screen": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "views": { - "type": "number" - }, - "visits": { - "type": "number" - }, - "websiteId": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - } - }, - "required": [ - "id", - "websiteId", - "hostname", - "browser", - "os", - "device", - "screen", - "language", - "country", - "region", - "city", - "firstAt", - "lastAt", - "visits", - "views", - "createdAt" - ], - "type": "object" - }, - "WebsiteSessionPage": { - "additionalProperties": false, - "properties": { - "count": { - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" - }, - "data": { - "items": { - "$ref": "#/components/schemas/WebsiteSession" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "page": { - "exclusiveMinimum": 0, - "maximum": 9007199254740991, - "type": "integer" - }, - "pageSize": { - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - }, - "WebsiteStats": { - "additionalProperties": false, - "properties": { - "bounces": { - "type": "number" - }, - "comparison": { - "$ref": "#/components/schemas/WebsiteStatsValues", - "description": "The same totals for the comparison period (previous period by default)." - }, - "pageviews": { - "type": "number" - }, - "totaltime": { - "type": "number" - }, - "visitors": { - "type": "number" - }, - "visits": { - "type": "number" - } - }, - "required": [ - "pageviews", - "visitors", - "visits", - "bounces", - "totaltime", - "comparison" - ], - "type": "object" - }, - "WebsiteStatsValues": { - "additionalProperties": false, - "properties": { - "bounces": { - "type": "number" - }, - "pageviews": { - "type": "number" - }, - "totaltime": { - "type": "number" - }, - "visitors": { - "type": "number" - }, - "visits": { - "type": "number" - } - }, - "required": [ - "pageviews", - "visitors", - "visits", - "bounces", - "totaltime" - ], - "type": "object" - }, - "WebsiteUser": { - "additionalProperties": false, - "properties": { - "id": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "id", - "username" - ], - "type": "object" - } - }, - "securitySchemes": { - "bearerAuth": { - "bearerFormat": "JWT", - "description": "Token returned by POST /api/auth/login, or an API key (`umami_…`) created under Settings → API keys (self-hosted only).", - "scheme": "bearer", - "type": "http" - }, - "oauth2": { - "description": "OAuth 2.1 access token (authorization code + PKCE). Only operations that declare an OAuth scope accept these tokens.", - "flows": { - "authorizationCode": { - "authorizationUrl": "/oauth/authorize", - "refreshUrl": "/api/oauth/token", - "scopes": { - "analytics:read": "Read analytics data (traffic, metrics, events, sessions, reports).", - "websites:read": "List and view websites you have access to." - }, - "tokenUrl": "/api/oauth/token" - } - }, - "type": "oauth2" - }, - "shareContext": { - "description": "Required context header when authenticating with a share token.", - "in": "header", - "name": "x-umami-share-context", - "type": "apiKey" - }, - "shareToken": { - "description": "Signed token returned by a share endpoint.", - "in": "header", - "name": "x-umami-share-token", - "type": "apiKey" - } - } - }, - "externalDocs": { - "description": "Umami API documentation", - "url": "https://docs.umami.is/docs/api" - }, - "info": { - "description": "REST API for Umami analytics. Every App Router API operation is included. Operations marked with x-umami-contract: inferred are generated from handler source; colocated explicit contracts provide curated descriptions and exact response models. Self-hosted deployments serve these paths beneath their configured BASE_PATH.", - "license": { - "identifier": "MIT", - "name": "MIT" - }, - "title": "Umami API", - "version": "3.3.1" - }, - "openapi": "3.1.0", - "paths": { - "/api/2fa/disable": { - "post": { - "description": "Disables two-factor authentication for the current user after verifying their password and authenticator code. Rejected when an administrator or team requires it.", - "operationId": "disableTwoFactor", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "password": { - "type": "string" - }, - "token": { - "maxLength": 6, - "minLength": 6, - "type": "string" - } - }, - "required": [ - "password", - "token" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "properties": { - "error": { - "properties": { - "code": { - "type": "string" - }, - "lockedUntil": { - "format": "date-time", - "type": "string" - }, - "message": { - "type": "string" - } - }, - "required": [ - "code", - "message", - "lockedUntil" - ], - "type": "object" - } - }, - "required": [ - "error" - ], - "type": "object" - }, - { - "properties": { - "ok": { - "type": "boolean" - } - }, - "required": [ - "ok" - ], - "type": "object" - } - ] - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "403": { - "content": { - "application/json": { - "example": { - "error": { - "code": "forbidden", - "message": "Forbidden.", - "status": 403 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Forbidden." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - }, - "429": { - "content": { - "application/json": { - "schema": { - "properties": { - "error": { - "properties": { - "code": { - "type": "string" - }, - "lockedUntil": { - "format": "date-time", - "type": "string" - }, - "message": { - "type": "string" - } - }, - "required": [ - "code", - "message", - "lockedUntil" - ], - "type": "object" - } - }, - "required": [ - "error" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "503": { - "content": { - "application/json": { - "example": { - "error": { - "code": "service-unavailable", - "message": "Service unavailable.", - "status": 503 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Service unavailable." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Disable two-factor authentication", - "tags": [ - "Two-factor authentication" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/2fa/disable/contract.generated.ts" - } - }, - "/api/2fa/setup/cancel": { - "post": { - "description": "Deletes the current user's pending setup without changing an already enabled authenticator.", - "operationId": "cancelTwoFactorSetup", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "ok": { - "type": "boolean" - } - }, - "required": [ - "ok" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Cancel two-factor authentication setup", - "tags": [ - "Two-factor authentication" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/2fa/setup/cancel/contract.generated.ts" - } - }, - "/api/2fa/setup/confirm": { - "post": { - "description": "Verifies an authenticator code, enables two-factor authentication, and returns a new set of backup codes.", - "operationId": "confirmTwoFactorSetup", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "token": { - "maxLength": 6, - "minLength": 6, - "type": "string" - } - }, - "required": [ - "token" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "properties": { - "error": { - "properties": { - "code": { - "type": "string" - }, - "lockedUntil": { - "format": "date-time", - "type": "string" - }, - "message": { - "type": "string" - } - }, - "required": [ - "code", - "message", - "lockedUntil" - ], - "type": "object" - } - }, - "required": [ - "error" - ], - "type": "object" - }, - { - "properties": { - "backupCodes": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "backupCodes" - ], - "type": "object" - } - ] - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - }, - "429": { - "content": { - "application/json": { - "schema": { - "properties": { - "error": { - "properties": { - "code": { - "type": "string" - }, - "lockedUntil": { - "format": "date-time", - "type": "string" - }, - "message": { - "type": "string" - } - }, - "required": [ - "code", - "message", - "lockedUntil" - ], - "type": "object" - } - }, - "required": [ - "error" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "503": { - "content": { - "application/json": { - "example": { - "error": { - "code": "service-unavailable", - "message": "Service unavailable.", - "status": 503 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Service unavailable." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Confirm two-factor authentication setup", - "tags": [ - "Two-factor authentication" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/2fa/setup/confirm/contract.generated.ts" - } - }, - "/api/2fa/setup/initiate": { - "post": { - "description": "Starts or replaces the current user's pending setup and returns a QR code and manual setup key for an authenticator app.", - "operationId": "initiateTwoFactorSetup", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "manualKey": { - "type": "string" - }, - "qrCodeDataUrl": { - "type": "string" - } - }, - "required": [ - "qrCodeDataUrl", - "manualKey" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - }, - "503": { - "content": { - "application/json": { - "example": { - "error": { - "code": "service-unavailable", - "message": "Service unavailable.", - "status": 503 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Service unavailable." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Set up two-factor authentication", - "tags": [ - "Two-factor authentication" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/2fa/setup/initiate/contract.generated.ts" - } - }, - "/api/2fa/status": { - "get": { - "description": "Returns whether two-factor authentication is enabled, configured, or required for the current user, including the reason it is required.", - "operationId": "getTwoFactorStatus", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "properties": { - "globalRequired": { - "type": "boolean" - }, - "isConfigured": { - "type": "boolean" - }, - "isEnabled": { - "type": "boolean" - }, - "isRequired": { - "type": "boolean" - }, - "requiredReason": { - "type": "null" - } - }, - "required": [ - "isEnabled", - "isRequired", - "requiredReason", - "isConfigured", - "globalRequired" - ], - "type": "object" - }, - { - "properties": { - "globalRequired": { - "type": "boolean" - }, - "isConfigured": { - "type": "boolean" - }, - "isEnabled": { - "type": "boolean" - }, - "isRequired": { - "type": "boolean" - }, - "requiredReason": { - "type": "string" - } - }, - "required": [ - "isEnabled", - "isRequired", - "requiredReason", - "isConfigured", - "globalRequired" - ], - "type": "object" - } - ] - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Get two-factor authentication status", - "tags": [ - "Two-factor authentication" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/2fa/status/contract.generated.ts" - } - }, - "/api/2fa/verify": { - "post": { - "description": "Exchanges a partial sign-in token and a valid authenticator or backup code for a full authentication token and user details.", - "operationId": "verifyTwoFactor", - "requestBody": { - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "properties": { - "token": { - "maxLength": 6, - "minLength": 6, - "type": "string" - } - }, - "required": [ - "token" - ], - "type": "object" - }, - { - "properties": { - "backupCode": { - "minLength": 1, - "type": "string" - } - }, - "required": [ - "backupCode" - ], - "type": "object" - } - ] - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "properties": { - "error": { - "properties": { - "code": { - "type": "string" - }, - "lockedUntil": { - "format": "date-time", - "type": "string" - }, - "message": { - "type": "string" - } - }, - "required": [ - "code", - "message", - "lockedUntil" - ], - "type": "object" - } - }, - "required": [ - "error" - ], - "type": "object" - }, - { - "properties": { - "token": { - "type": "string" - }, - "user": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "isAdmin": { - "type": "boolean" - }, - "role": { - "type": "string" - }, - "teams": { - "items": { - "properties": { - "id": { - "type": "string" - }, - "logoUrl": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "logoUrl", - "name" - ], - "type": "object" - }, - "type": "array" - }, - "username": { - "type": "string" - } - }, - "required": [ - "id", - "username", - "role", - "createdAt", - "isAdmin", - "teams" - ], - "type": "object" - } - }, - "required": [ - "token", - "user" - ], - "type": "object" - } - ] - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - }, - "429": { - "content": { - "application/json": { - "schema": { - "properties": { - "error": { - "properties": { - "code": { - "type": "string" - }, - "lockedUntil": { - "format": "date-time", - "type": "string" - }, - "message": { - "type": "string" - } - }, - "required": [ - "code", - "message", - "lockedUntil" - ], - "type": "object" - } - }, - "required": [ - "error" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "503": { - "content": { - "application/json": { - "example": { - "error": { - "code": "service-unavailable", - "message": "Service unavailable.", - "status": 503 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Service unavailable." - } - }, - "security": [], - "summary": "Complete two-factor sign-in", - "tags": [ - "Two-factor authentication" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/2fa/verify/contract.generated.ts" - } - }, - "/api/admin/2fa/global": { - "post": { - "description": "Enables or disables the installation-wide requirement for users to set up two-factor authentication.", - "operationId": "postAdmin2faGlobal", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "required": { - "type": "boolean" - } - }, - "required": [ - "required" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "ok": { - "type": "boolean" - }, - "required": {} - }, - "required": [ - "ok", - "required" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - }, - "503": { - "content": { - "application/json": { - "example": { - "error": { - "code": "service-unavailable", - "message": "Service unavailable.", - "status": 503 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Service unavailable." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Set the two-factor requirement for everyone", - "tags": [ - "Administration" - ], - "x-umami-audience": "internal", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/admin/2fa/global/contract.generated.ts" - } - }, - "/api/admin/teams": { - "get": { - "description": "Returns a paginated list of teams with member details and website and member counts for administration.", - "operationId": "getAdminTeams", - "parameters": [ - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "orderBy", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sortDescending", - "required": false, - "schema": { - "enum": [ - "true", - "false" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "accessCode": { - "type": "string" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "logoUrl": { - "type": "string" - }, - "name": { - "type": "string" - }, - "twoFactorRequired": { - "type": "boolean" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "logoUrl", - "twoFactorRequired", - "deletedAt", - "name", - "accessCode" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List all teams", - "tags": [ - "Administration" - ], - "x-umami-audience": "internal", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/admin/teams/contract.generated.ts" - } - }, - "/api/admin/teams/{teamId}/2fa": { - "post": { - "description": "Enables or disables the requirement for members of the specified team to use two-factor authentication.", - "operationId": "postAdminTeamsTeamId2fa", - "parameters": [ - { - "in": "path", - "name": "teamId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "required": { - "type": "boolean" - } - }, - "required": [ - "required" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "ok": { - "type": "boolean" - }, - "teamId": { - "type": "string" - }, - "twoFactorRequired": {} - }, - "required": [ - "ok", - "teamId", - "twoFactorRequired" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - }, - "503": { - "content": { - "application/json": { - "example": { - "error": { - "code": "service-unavailable", - "message": "Service unavailable.", - "status": 503 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Service unavailable." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Set a team's two-factor requirement", - "tags": [ - "Administration" - ], - "x-umami-audience": "internal", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/admin/teams/[teamId]/2fa/contract.generated.ts" - } - }, - "/api/admin/users": { - "get": { - "description": "Returns a paginated list of users and their website counts for administration, excluding passwords.", - "operationId": "getAdminUsers", - "parameters": [ - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "orderBy", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sortDescending", - "required": false, - "schema": { - "enum": [ - "true", - "false" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "_count": { - "properties": { - "websites": { - "type": "number" - } - }, - "required": [ - "websites" - ], - "type": "object" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "role": { - "type": "string" - }, - "twoFactorRequired": { - "type": "boolean" - }, - "username": { - "type": "string" - } - }, - "required": [ - "id", - "username", - "role", - "createdAt", - "twoFactorRequired" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List all users", - "tags": [ - "Administration" - ], - "x-umami-audience": "internal", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/admin/users/contract.generated.ts" - } - }, - "/api/admin/users/{userId}/2fa": { - "delete": { - "description": "Removes the specified user's authenticator setup, backup codes, used-code history, and failed-attempt limits so they can set up authentication again.", - "operationId": "deleteAdminUsersUserId2fa", - "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "ok": { - "type": "boolean" - }, - "reset": { - "properties": { - "backupCodes": {}, - "otpUsed": {}, - "rateLimit": {}, - "twoFactorAuth": {} - }, - "required": [ - "twoFactorAuth", - "backupCodes", - "otpUsed", - "rateLimit" - ], - "type": "object" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "ok", - "userId", - "reset" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Reset a user's two-factor authentication", - "tags": [ - "Administration" - ], - "x-umami-audience": "internal", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/admin/users/[userId]/2fa/contract.generated.ts" - }, - "get": { - "description": "Returns whether two-factor authentication is enabled for the specified user.", - "operationId": "getAdminUsersUserId2fa", - "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "isEnabled": { - "type": "boolean" - } - }, - "required": [ - "isEnabled" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Get a user's two-factor status", - "tags": [ - "Administration" - ], - "x-umami-audience": "internal", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/admin/users/[userId]/2fa/contract.generated.ts" - }, - "post": { - "description": "Enables or disables the requirement for the specified user to set up two-factor authentication.", - "operationId": "postAdminUsersUserId2fa", - "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "required": { - "type": "boolean" - } - }, - "required": [ - "required" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "ok": { - "type": "boolean" - }, - "twoFactorRequired": {}, - "userId": { - "type": "string" - } - }, - "required": [ - "ok", - "userId", - "twoFactorRequired" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - }, - "503": { - "content": { - "application/json": { - "example": { - "error": { - "code": "service-unavailable", - "message": "Service unavailable.", - "status": 503 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Service unavailable." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Set a user's two-factor requirement", - "tags": [ - "Administration" - ], - "x-umami-audience": "internal", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/admin/users/[userId]/2fa/contract.generated.ts" - } - }, - "/api/admin/websites": { - "get": { - "description": "Returns a paginated, searchable list of websites across users and teams for administration.", - "operationId": "getAdminWebsites", - "parameters": [ - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "orderBy", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sortDescending", - "required": false, - "schema": { - "enum": [ - "true", - "false" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "allOf": [ - { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "createdBy": { - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "domain": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "recorderEnabled": { - "type": "boolean" - }, - "replayConfig": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "resetAt": { - "format": "date-time", - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "deletedAt", - "createdBy", - "name", - "domain", - "resetAt", - "teamId", - "recorderEnabled", - "replayConfig" - ], - "type": "object" - }, - { - "properties": { - "createUser": { - "properties": { - "id": { - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "id", - "username" - ], - "type": "object" - }, - "shareId": { - "type": "string" - }, - "team": { - "properties": { - "members": { - "items": { - "properties": { - "role": { - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "userId", - "role" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "members" - ], - "type": "object" - }, - "user": { - "properties": { - "id": { - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "id", - "username" - ], - "type": "object" - } - }, - "required": [ - "shareId" - ], - "type": "object" - } - ] - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List all websites", - "tags": [ - "Administration" - ], - "x-umami-audience": "internal", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/admin/websites/contract.generated.ts" - } - }, - "/api/auth/login": { - "post": { - "description": "Authenticates a user with a username and password. Users with two-factor authentication receive a short-lived partial token to complete sign-in.", - "operationId": "login", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LoginRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LoginResponse" - } - } - }, - "description": "Authenticated successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "503": { - "content": { - "application/json": { - "example": { - "error": { - "code": "service-unavailable", - "message": "Service unavailable.", - "status": 503 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Service unavailable." - } - }, - "security": [], - "summary": "Log in", - "tags": [ - "Authentication" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/auth/login/contract.ts" - } - }, - "/api/auth/logout": { - "post": { - "description": "Ends the current authentication session by removing its stored token when Redis-backed sessions are enabled.", - "operationId": "logout", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "ok": { - "const": true - } - }, - "required": [ - "ok" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Log out", - "tags": [ - "Authentication" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/auth/logout/contract.generated.ts" - } - }, - "/api/auth/sso": { - "post": { - "description": "Returns the authenticated user and a new token valid for 24 hours. Requires Redis-backed authentication.", - "operationId": "sso", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "token": { - "type": "string" - }, - "user": {} - }, - "required": [ - "user", - "token" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "500": { - "content": { - "application/json": { - "example": { - "error": { - "code": "server-error", - "message": "Server error.", - "status": 500 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Server error." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a single sign-on token", - "tags": [ - "Authentication" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/auth/sso/contract.generated.ts" - } - }, - "/api/auth/subscription": { - "get": { - "description": "Returns subscription and feature availability for the current user or a specified team the user can access.", - "operationId": "getSubscription", - "parameters": [ - { - "in": "query", - "name": "teamId", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "properties": { - "error": { - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "status": { - "type": "number" - } - }, - "required": [ - "message", - "code", - "status" - ], - "type": "object" - } - }, - "required": [ - "error" - ], - "type": "object" - }, - { - "properties": { - "hasSubscription": { - "type": "boolean" - }, - "isBusiness": { - "type": "boolean" - }, - "isNoBilling": { - "type": "boolean" - }, - "isPro": { - "type": "boolean" - }, - "unlimitedWebsites": { - "type": "boolean" - } - }, - "required": [ - "isPro", - "isBusiness", - "isNoBilling", - "hasSubscription", - "unlimitedWebsites" - ], - "type": "object" - } - ] - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get subscription details", - "tags": [ - "Authentication" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/auth/subscription/contract.generated.ts" - } - }, - "/api/auth/verify": { - "post": { - "description": "Validates the current authentication credentials and returns the user and their team memberships.", - "operationId": "verify", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "teams": {} - }, - "required": [ - "teams" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Verify the current sign-in", - "tags": [ - "Authentication" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/auth/verify/contract.generated.ts" - } - }, - "/api/batch": { - "post": { - "description": "Processes up to 500 tracking payloads and returns processed and failed counts, individual error details, and a tracking cache token.", - "operationId": "batch", - "requestBody": { - "content": { - "application/json": { - "schema": { - "items": { - "additionalProperties": true, - "type": "object" - }, - "maxItems": 500, - "type": "array" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "cache": {}, - "details": { - "items": {}, - "type": "array" - }, - "errors": { - "type": "number" - }, - "processed": { - "type": "number" - }, - "size": {} - }, - "required": [ - "size", - "processed", - "errors", - "details", - "cache" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "500": { - "content": { - "application/json": { - "example": { - "error": { - "code": "server-error", - "message": "Server error.", - "status": 500 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Server error." - } - }, - "security": [], - "summary": "Send a batch of tracking requests", - "tags": [ - "Collection" - ], - "x-umami-audience": "collect", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/batch/contract.generated.ts" - } - }, - "/api/boards": { - "get": { - "description": "Returns a paginated list of the current user's boards, with search and sorting options.", - "operationId": "getBoards", - "parameters": [ - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "orderBy", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sortDescending", - "required": false, - "schema": { - "enum": [ - "true", - "false" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "description": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "teamId": { - "type": "string" - }, - "type": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "name", - "teamId", - "type", - "description", - "parameters" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "List my boards", - "tags": [ - "Boards" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/boards/contract.generated.ts" - }, - "post": { - "description": "Creates a board with a name, type, and configuration, optionally assigned to a team. Validates access to its referenced resources and reports.", - "operationId": "createBoard", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "description": { - "maxLength": 500, - "type": "string" - }, - "name": { - "maxLength": 100, - "type": "string" - }, - "parameters": { - "properties": { - "linkId": { - "format": "uuid", - "type": "string" - }, - "pixelId": { - "format": "uuid", - "type": "string" - }, - "websiteId": { - "format": "uuid", - "type": "string" - } - }, - "type": "object" - }, - "teamId": { - "anyOf": [ - { - "format": "uuid", - "type": "string" - }, - { - "type": "null" - } - ] - }, - "type": { - "anyOf": [ - { - "enum": [], - "type": "string" - }, - { - "const": "open" - } - ] - }, - "userId": { - "anyOf": [ - { - "format": "uuid", - "type": "string" - }, - { - "type": "null" - } - ] - } - }, - "required": [ - "type", - "name" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "description": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "teamId": { - "type": "string" - }, - "type": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "name", - "teamId", - "type", - "description", - "parameters" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Create a board", - "tags": [ - "Boards" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/boards/contract.generated.ts" - } - }, - "/api/boards/{boardId}": { - "delete": { - "description": "Deletes the specified board after checking the caller's permission to remove it.", - "operationId": "deleteBoard", - "parameters": [ - { - "in": "path", - "name": "boardId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "ok": { - "const": true - } - }, - "required": [ - "ok" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Delete a board", - "tags": [ - "Boards" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/boards/[boardId]/contract.generated.ts" - }, - "get": { - "description": "Returns the specified board and its configuration.", - "operationId": "getBoard", - "parameters": [ - { - "in": "path", - "name": "boardId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "description": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "teamId": { - "type": "string" - }, - "type": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "name", - "teamId", - "type", - "description", - "parameters" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get a board", - "tags": [ - "Boards" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/boards/[boardId]/contract.generated.ts" - }, - "post": { - "description": "Updates a board's name, description, or configuration and validates the resources and reports it references.", - "operationId": "updateBoard", - "parameters": [ - { - "in": "path", - "name": "boardId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "description": { - "maxLength": 500, - "type": "string" - }, - "name": { - "maxLength": 200, - "type": "string" - }, - "parameters": { - "properties": {}, - "type": "object" - }, - "type": { - "anyOf": [ - { - "enum": [], - "type": "string" - }, - { - "const": "open" - } - ] - } - }, - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "description": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "teamId": { - "type": "string" - }, - "type": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "name", - "teamId", - "type", - "description", - "parameters" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "500": { - "content": { - "application/json": { - "example": { - "error": { - "code": "server-error", - "message": "Server error.", - "status": 500 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Server error." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Update a board", - "tags": [ - "Boards" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/boards/[boardId]/contract.generated.ts" - } - }, - "/api/boards/{boardId}/clone": { - "post": { - "description": "Creates a copy of a board with optional changes to its name, description, and configuration. Removes invalid report references from the copy.", - "operationId": "cloneBoard", - "parameters": [ - { - "in": "path", - "name": "boardId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "description": { - "maxLength": 500, - "type": "string" - }, - "name": { - "maxLength": 200, - "type": "string" - }, - "parameters": { - "properties": {}, - "type": "object" - } - }, - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "description": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "teamId": { - "type": "string" - }, - "type": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "name", - "teamId", - "type", - "description", - "parameters" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Clone a board", - "tags": [ - "Boards" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/boards/[boardId]/clone/contract.generated.ts" - } - }, - "/api/boards/{boardId}/shares": { - "get": { - "description": "Returns a paginated list of shares for the specified board.", - "operationId": "getBoardShares", - "parameters": [ - { - "in": "path", - "name": "boardId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "entityId": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "shareType": { - "type": "number" - }, - "slug": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "name", - "slug", - "parameters", - "entityId", - "shareType" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List shares for a board", - "tags": [ - "Boards" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/boards/[boardId]/shares/contract.generated.ts" - }, - "post": { - "description": "Creates a named share for the specified board with optional parameters.", - "operationId": "createBoardShare", - "parameters": [ - { - "in": "path", - "name": "boardId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "maxLength": 200, - "type": "string" - }, - "parameters": { - "additionalProperties": true, - "type": "object" - } - }, - "required": [ - "name" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "entityId": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "shareType": { - "type": "number" - }, - "slug": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "name", - "slug", - "parameters", - "entityId", - "shareType" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a share for a board", - "tags": [ - "Boards" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/boards/[boardId]/shares/contract.generated.ts" - } - }, - "/api/config": { - "get": { - "description": "Returns public application settings, including deployment mode, feature availability, and tracker and resource URLs.", - "operationId": "getConfig", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "cloudMode": { - "type": "boolean" - }, - "faviconUrl": { - "type": "string" - }, - "linksUrl": { - "type": "string" - }, - "pixelsUrl": { - "type": "string" - }, - "privateMode": { - "type": "boolean" - }, - "sessionDeletionEnabled": { - "type": "boolean" - }, - "telemetryDisabled": { - "type": "boolean" - }, - "trackerScriptName": { - "type": "string" - }, - "updatesDisabled": { - "type": "boolean" - } - }, - "required": [ - "cloudMode", - "faviconUrl", - "linksUrl", - "pixelsUrl", - "privateMode", - "sessionDeletionEnabled", - "telemetryDisabled", - "trackerScriptName", - "updatesDisabled" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - } - }, - "security": [], - "summary": "Get application configuration", - "tags": [ - "Configuration" - ], - "x-umami-audience": "internal", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/config/contract.generated.ts" - } - }, - "/api/dashboard": { - "get": { - "description": "Returns the current user's personal dashboard board and its configuration.", - "operationId": "getDashboard", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "description": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "teamId": { - "type": "string" - }, - "type": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "name", - "teamId", - "type", - "description", - "parameters" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Get my dashboard", - "tags": [ - "Dashboard" - ], - "x-umami-audience": "internal", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/dashboard/contract.generated.ts" - }, - "post": { - "description": "Creates or updates the current user's personal dashboard with the supplied name, description, and configuration.", - "operationId": "postDashboard", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "description": { - "maxLength": 500, - "type": "string" - }, - "name": { - "maxLength": 200, - "type": "string" - }, - "parameters": { - "properties": {}, - "type": "object" - } - }, - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "description": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "teamId": { - "type": "string" - }, - "type": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "name", - "teamId", - "type", - "description", - "parameters" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Save my dashboard", - "tags": [ - "Dashboard" - ], - "x-umami-audience": "internal", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/dashboard/contract.generated.ts" - } - }, - "/api/heartbeat": { - "get": { - "description": "Returns a simple success response to confirm that the application can serve requests.", - "operationId": "getHeartbeat", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "ok": { - "type": "boolean" - } - }, - "required": [ - "ok" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - } - }, - "security": [], - "summary": "Check application availability", - "tags": [ - "System" - ], - "x-umami-audience": "internal", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/heartbeat/contract.generated.ts" - } - }, - "/api/links": { - "get": { - "description": "Returns a paginated list of the current user's tracked links, with search and sorting options.", - "operationId": "getLinks", - "parameters": [ - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "orderBy", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sortDescending", - "required": false, - "schema": { - "enum": [ - "true", - "false" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "url": { - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "deletedAt", - "name", - "teamId", - "url", - "slug" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "List my links", - "tags": [ - "Links" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/links/contract.generated.ts" - }, - "post": { - "description": "Creates a tracked link with a name, destination URL, and slug, optionally assigned to a team.", - "operationId": "createLink", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "id": { - "anyOf": [ - { - "format": "uuid", - "type": "string" - }, - { - "type": "null" - } - ] - }, - "name": { - "maxLength": 100, - "type": "string" - }, - "slug": { - "maxLength": 100, - "minLength": 8, - "type": "string" - }, - "teamId": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "url": { - "maxLength": 500, - "type": "string" - } - }, - "required": [ - "name", - "url", - "slug" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "url": { - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "deletedAt", - "name", - "teamId", - "url", - "slug" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a tracked link", - "tags": [ - "Links" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/links/contract.generated.ts" - } - }, - "/api/links/{linkId}": { - "delete": { - "description": "Deletes the specified tracked link after checking the caller's permission to remove it.", - "operationId": "deleteLink", - "parameters": [ - { - "in": "path", - "name": "linkId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "ok": { - "const": true - } - }, - "required": [ - "ok" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Delete a tracked link", - "tags": [ - "Links" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/links/[linkId]/contract.generated.ts" - }, - "get": { - "description": "Returns the specified tracked link, including its destination URL and slug.", - "operationId": "getLink", - "parameters": [ - { - "in": "path", - "name": "linkId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "url": { - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "deletedAt", - "name", - "teamId", - "url", - "slug" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get a tracked link", - "tags": [ - "Links" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/links/[linkId]/contract.generated.ts" - }, - "post": { - "description": "Updates a tracked link's name, destination URL, or slug.", - "operationId": "updateLink", - "parameters": [ - { - "in": "path", - "name": "linkId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "maxLength": 100, - "type": "string" - }, - "slug": { - "maxLength": 100, - "minLength": 8, - "type": "string" - }, - "url": { - "maxLength": 500, - "type": "string" - } - }, - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "url": { - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "deletedAt", - "name", - "teamId", - "url", - "slug" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "500": { - "content": { - "application/json": { - "example": { - "error": { - "code": "server-error", - "message": "Server error.", - "status": 500 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Server error." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Update a tracked link", - "tags": [ - "Links" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/links/[linkId]/contract.generated.ts" - } - }, - "/api/links/{linkId}/shares": { - "get": { - "description": "Returns a paginated list of shares for the specified link.", - "operationId": "getLinkShares", - "parameters": [ - { - "in": "path", - "name": "linkId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "entityId": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "shareType": { - "type": "number" - }, - "slug": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "name", - "slug", - "parameters", - "entityId", - "shareType" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List shares for a link", - "tags": [ - "Links" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/links/[linkId]/shares/contract.generated.ts" - }, - "post": { - "description": "Creates a named share for the specified link with optional parameters.", - "operationId": "createLinkShare", - "parameters": [ - { - "in": "path", - "name": "linkId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "maxLength": 200, - "type": "string" - }, - "parameters": { - "additionalProperties": true, - "type": "object" - } - }, - "required": [ - "name" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "entityId": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "shareType": { - "type": "number" - }, - "slug": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "name", - "slug", - "parameters", - "entityId", - "shareType" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a share for a link", - "tags": [ - "Links" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/links/[linkId]/shares/contract.generated.ts" - } - }, - "/api/links/charts": { - "get": { - "description": "Returns visitor totals and chart data for the requested links the caller can view, within the selected date range.", - "operationId": "getLinksCharts", - "parameters": [ - { - "in": "query", - "name": "ids", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "data": { - "additionalProperties": { - "properties": { - "total": { - "type": "number" - }, - "values": { - "items": { - "type": "number" - }, - "type": "array" - } - }, - "required": [ - "values", - "total" - ], - "type": "object" - }, - "properties": {}, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get visitor charts for links", - "tags": [ - "Links" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/links/charts/contract.generated.ts" - } - }, - "/api/me": { - "get": { - "description": "Returns the current authentication context, including the authenticated user or share credentials.", - "operationId": "getMe", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "apiKey": { - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "name" - ], - "type": "object" - }, - "authType": { - "anyOf": [ - { - "const": "session" - }, - { - "const": "share" - }, - { - "const": "api-key" - }, - { - "const": "oauth" - } - ] - }, - "oauth": { - "properties": { - "clientId": { - "type": "string" - }, - "scopes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "tokenId": { - "type": "string" - } - }, - "required": [ - "clientId", - "scopes" - ], - "type": "object" - }, - "shareToken": { - "properties": { - "boardId": { - "type": "string" - }, - "linkId": { - "type": "string" - }, - "linkIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "parameters": { - "additionalProperties": { - "anyOf": [ - { - "const": false - }, - { - "const": true - }, - { - "const": "light" - }, - { - "const": "dark" - } - ] - }, - "properties": { - "allowFilter": { - "type": "boolean" - }, - "theme": { - "anyOf": [ - { - "const": "light" - }, - { - "const": "dark" - } - ] - } - }, - "type": "object" - }, - "pixelId": { - "type": "string" - }, - "pixelIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "shareType": { - "type": "number" - }, - "websiteId": { - "type": "string" - }, - "websiteIds": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "user": { - "properties": { - "id": { - "type": "string" - }, - "isAdmin": { - "type": "boolean" - }, - "role": { - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "id", - "username", - "role", - "isAdmin" - ], - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "websites:read" - ] - } - ], - "summary": "Get my authentication details", - "tags": [ - "Account" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "websites:read", - "x-umami-source": "src/app/api/me/contract.generated.ts" - } - }, - "/api/me/api-keys": { - "get": { - "description": "Returns metadata for the current user's API keys. Available on self-hosted installations.", - "operationId": "getMyApiKeys", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "keyPrefix": { - "type": "string" - }, - "lastUsedAt": { - "format": "date-time", - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "name", - "keyPrefix", - "lastUsedAt" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "List my API keys", - "tags": [ - "Account" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/me/api-keys/contract.generated.ts" - }, - "post": { - "description": "Creates a named API key for the current user and returns its secret value. Available on self-hosted installations.", - "operationId": "createMyApiKey", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "maximum": 255, - "minimum": 1 - } - }, - "required": [ - "name" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "key": { - "type": "string" - }, - "keyPrefix": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "key", - "id", - "createdAt", - "name", - "keyPrefix" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create an API key", - "tags": [ - "Account" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/me/api-keys/contract.generated.ts" - } - }, - "/api/me/api-keys/{keyId}": { - "delete": { - "description": "Deletes an API key belonging to the current user, revoking its access. Available on self-hosted installations.", - "operationId": "deleteMyApiKey", - "parameters": [ - { - "in": "path", - "name": "keyId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "ok": { - "const": true - } - }, - "required": [ - "ok" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Delete an API key", - "tags": [ - "Account" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/me/api-keys/[keyId]/contract.generated.ts" - } - }, - "/api/me/password": { - "post": { - "description": "Verifies the current password and replaces it with the supplied new password.", - "operationId": "updateMyPassword", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "currentPassword": { - "type": "string" - }, - "newPassword": { - "minLength": 8, - "type": "string" - } - }, - "required": [ - "currentPassword", - "newPassword" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "role": { - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "username", - "role" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Change my password", - "tags": [ - "Account" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/me/password/contract.generated.ts" - } - }, - "/api/me/teams": { - "get": { - "description": "Returns a paginated list of teams the current user belongs to, with sorting options.", - "operationId": "getMyTeams", - "parameters": [ - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "orderBy", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sortDescending", - "required": false, - "schema": { - "enum": [ - "true", - "false" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "accessCode": { - "type": "string" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "logoUrl": { - "type": "string" - }, - "name": { - "type": "string" - }, - "twoFactorRequired": { - "type": "boolean" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "logoUrl", - "twoFactorRequired", - "deletedAt", - "name", - "accessCode" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "List my team memberships", - "tags": [ - "Account" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/me/teams/contract.generated.ts" - } - }, - "/api/me/websites": { - "get": { - "description": "Returns a paginated list of the current user's websites, optionally including websites accessible through team membership.", - "operationId": "getMyWebsites", - "parameters": [ - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "orderBy", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sortDescending", - "required": false, - "schema": { - "enum": [ - "true", - "false" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "includeTeams", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "allOf": [ - { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "createdBy": { - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "domain": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "recorderEnabled": { - "type": "boolean" - }, - "replayConfig": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "resetAt": { - "format": "date-time", - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "deletedAt", - "createdBy", - "name", - "domain", - "resetAt", - "teamId", - "recorderEnabled", - "replayConfig" - ], - "type": "object" - }, - { - "properties": { - "createUser": { - "properties": { - "id": { - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "id", - "username" - ], - "type": "object" - }, - "shareId": { - "type": "string" - }, - "team": { - "properties": { - "members": { - "items": { - "properties": { - "role": { - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "userId", - "role" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "members" - ], - "type": "object" - }, - "user": { - "properties": { - "id": { - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "id", - "username" - ], - "type": "object" - } - }, - "required": [ - "shareId" - ], - "type": "object" - } - ] - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "List my websites", - "tags": [ - "Account" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/me/websites/contract.generated.ts" - } - }, - "/api/oauth/authorize": { - "get": { - "description": "Validates an OAuth authorization request and returns the client and requested permissions for the consent screen. Requires an interactive user session.", - "operationId": "describeOAuthAuthorization", - "parameters": [ - { - "in": "query", - "name": "response_type", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "client_id", - "required": true, - "schema": { - "maxLength": 2048, - "type": "string" - } - }, - { - "in": "query", - "name": "redirect_uri", - "schema": { - "maxLength": 2048, - "type": "string" - } - }, - { - "in": "query", - "name": "scope", - "schema": { - "maxLength": 500, - "type": "string" - } - }, - { - "in": "query", - "name": "state", - "schema": { - "maxLength": 1024, - "type": "string" - } - }, - { - "in": "query", - "name": "code_challenge", - "schema": { - "maxLength": 128, - "type": "string" - } - }, - { - "in": "query", - "name": "code_challenge_method", - "schema": { - "maxLength": 10, - "type": "string" - } - }, - { - "in": "query", - "name": "resource", - "schema": { - "maxLength": 2048, - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OAuthAuthorizationDetails" - } - } - }, - "description": "Authorization request details." - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OAuthErrorResponse" - } - } - }, - "description": "Invalid authorization request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Get OAuth authorization request details", - "tags": [ - "OAuth" - ], - "x-umami-audience": "internal", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/oauth/authorize/contract.ts" - }, - "post": { - "description": "Records the user's consent decision and returns a redirect URL. Approval includes an authorization code, the request state, and the issuer.", - "operationId": "decideOAuthAuthorization", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OAuthAuthorizationDecision" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OAuthAuthorizationRedirect" - } - } - }, - "description": "Redirect URL for the browser." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Approve or deny OAuth access", - "tags": [ - "OAuth" - ], - "x-umami-audience": "internal", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/oauth/authorize/contract.ts" - } - }, - "/api/oauth/register": { - "post": { - "description": "Registers a public OAuth client for clients that do not support Client ID Metadata Documents. Clients that support them should use an HTTPS metadata URL as their client ID.", - "operationId": "oauthRegisterClient", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OAuthClientRegistrationRequest" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OAuthClientRegistrationResponse" - } - } - }, - "description": "Registered client." - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OAuthErrorResponse" - } - } - }, - "description": "Invalid client metadata." - } - }, - "security": [], - "summary": "Register an OAuth client", - "tags": [ - "OAuth" - ], - "x-umami-audience": "internal", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/oauth/register/contract.ts" - } - }, - "/api/oauth/revoke": { - "post": { - "description": "Revokes the supplied refresh token. Unknown tokens are accepted without revealing whether they existed.", - "operationId": "oauthRevoke", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OAuthRevocationRequest" - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/OAuthRevocationRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "additionalProperties": false, - "properties": {}, - "type": "object" - } - } - }, - "description": "Token revoked (or already invalid)." - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OAuthErrorResponse" - } - } - }, - "description": "Malformed request." - } - }, - "security": [], - "summary": "Revoke an OAuth refresh token", - "tags": [ - "OAuth" - ], - "x-umami-audience": "internal", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/oauth/revoke/contract.ts" - } - }, - "/api/oauth/token": { - "post": { - "description": "Exchanges an authorization code and PKCE verifier, or a refresh token, for an access token. Accepts form-encoded or JSON requests and rotates refresh tokens on use.", - "operationId": "oauthToken", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OAuthTokenRequest" - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/OAuthTokenRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OAuthTokenResponse" - } - } - }, - "description": "Access and refresh tokens." - }, - "400": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OAuthErrorResponse" - } - } - }, - "description": "Invalid grant or request." - }, - "401": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OAuthErrorResponse" - } - } - }, - "description": "Invalid client." - } - }, - "security": [], - "summary": "Get or refresh an OAuth access token", - "tags": [ - "OAuth" - ], - "x-umami-audience": "internal", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/oauth/token/contract.ts" - } - }, - "/api/pixels": { - "get": { - "description": "Returns a paginated list of the current user's tracking pixels, with search and sorting options.", - "operationId": "getPixels", - "parameters": [ - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "orderBy", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sortDescending", - "required": false, - "schema": { - "enum": [ - "true", - "false" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "deletedAt", - "name", - "teamId", - "slug" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "List my tracking pixels", - "tags": [ - "Pixels" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/pixels/contract.generated.ts" - }, - "post": { - "description": "Creates a tracking pixel with a name and slug, optionally assigned to a team.", - "operationId": "createPixel", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "id": { - "anyOf": [ - { - "format": "uuid", - "type": "string" - }, - { - "type": "null" - } - ] - }, - "name": { - "maxLength": 100, - "type": "string" - }, - "slug": { - "maxLength": 100, - "minLength": 8, - "type": "string" - }, - "teamId": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - } - }, - "required": [ - "name", - "slug" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "deletedAt", - "name", - "teamId", - "slug" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a tracking pixel", - "tags": [ - "Pixels" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/pixels/contract.generated.ts" - } - }, - "/api/pixels/{pixelId}": { - "delete": { - "description": "Deletes the specified tracking pixel after checking the caller's permission to remove it.", - "operationId": "deletePixel", - "parameters": [ - { - "in": "path", - "name": "pixelId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "ok": { - "const": true - } - }, - "required": [ - "ok" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Delete a tracking pixel", - "tags": [ - "Pixels" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/pixels/[pixelId]/contract.generated.ts" - }, - "get": { - "description": "Returns the specified tracking pixel and its configuration.", - "operationId": "getPixel", - "parameters": [ - { - "in": "path", - "name": "pixelId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "deletedAt", - "name", - "teamId", - "slug" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get a tracking pixel", - "tags": [ - "Pixels" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/pixels/[pixelId]/contract.generated.ts" - }, - "post": { - "description": "Updates a tracking pixel's name or slug.", - "operationId": "updatePixel", - "parameters": [ - { - "in": "path", - "name": "pixelId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "maxLength": 100, - "type": "string" - }, - "slug": { - "maxLength": 100, - "minLength": 8, - "type": "string" - } - }, - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "deletedAt", - "name", - "teamId", - "slug" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "500": { - "content": { - "application/json": { - "example": { - "error": { - "code": "server-error", - "message": "Server error.", - "status": 500 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Server error." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Update a tracking pixel", - "tags": [ - "Pixels" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/pixels/[pixelId]/contract.generated.ts" - } - }, - "/api/pixels/{pixelId}/shares": { - "get": { - "description": "Returns a paginated list of shares for the specified tracking pixel.", - "operationId": "getPixelShares", - "parameters": [ - { - "in": "path", - "name": "pixelId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "entityId": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "shareType": { - "type": "number" - }, - "slug": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "name", - "slug", - "parameters", - "entityId", - "shareType" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List shares for a tracking pixel", - "tags": [ - "Pixels" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/pixels/[pixelId]/shares/contract.generated.ts" - }, - "post": { - "description": "Creates a named share for the specified tracking pixel with optional parameters.", - "operationId": "createPixelShare", - "parameters": [ - { - "in": "path", - "name": "pixelId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "maxLength": 200, - "type": "string" - }, - "parameters": { - "additionalProperties": true, - "type": "object" - } - }, - "required": [ - "name" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "entityId": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "shareType": { - "type": "number" - }, - "slug": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "name", - "slug", - "parameters", - "entityId", - "shareType" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a share for a tracking pixel", - "tags": [ - "Pixels" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/pixels/[pixelId]/shares/contract.generated.ts" - } - }, - "/api/pixels/charts": { - "get": { - "description": "Returns visitor totals and chart data for the requested pixels the caller can view, within the selected date range.", - "operationId": "getPixelsCharts", - "parameters": [ - { - "in": "query", - "name": "ids", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "data": { - "additionalProperties": { - "properties": { - "total": { - "type": "number" - }, - "values": { - "items": { - "type": "number" - }, - "type": "array" - } - }, - "required": [ - "values", - "total" - ], - "type": "object" - }, - "properties": {}, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get visitor charts for tracking pixels", - "tags": [ - "Pixels" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/pixels/charts/contract.generated.ts" - } - }, - "/api/realtime/{websiteId}": { - "get": { - "description": "Returns recent website activity and visitor data for the real-time view, applying the supplied filters.", - "operationId": "getRealtime", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "countries": { - "additionalProperties": { - "type": "number" - }, - "properties": {}, - "type": "object" - }, - "events": { - "items": { - "properties": { - "__type": { - "anyOf": [ - { - "const": "event" - }, - { - "const": "session" - }, - { - "const": "pageview" - } - ] - }, - "browser": { - "type": "string" - }, - "country": { - "type": "string" - }, - "createdAt": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "date-time", - "type": "string" - } - ] - }, - "device": { - "type": "string" - }, - "eventName": { - "type": "string" - }, - "hostname": { - "type": "string" - }, - "os": { - "type": "string" - }, - "referrerDomain": { - "type": "string" - }, - "sessionId": { - "type": "string" - }, - "urlPath": { - "type": "string" - } - }, - "required": [ - "__type", - "sessionId", - "eventName", - "createdAt", - "browser", - "os", - "device", - "country", - "urlPath", - "referrerDomain", - "hostname" - ], - "type": "object" - }, - "type": "array" - }, - "referrers": { - "additionalProperties": { - "type": "number" - }, - "properties": {}, - "type": "object" - }, - "series": { - "properties": { - "views": { - "items": { - "properties": { - "t": { - "type": "string" - }, - "x": { - "type": "string" - }, - "y": { - "type": "number" - } - }, - "required": [ - "x", - "t", - "y" - ], - "type": "object" - }, - "type": "array" - }, - "visitors": { - "items": { - "properties": { - "t": { - "type": "string" - }, - "x": { - "type": "string" - }, - "y": { - "type": "number" - } - }, - "required": [ - "x", - "t", - "y" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "views", - "visitors" - ], - "type": "object" - }, - "timestamp": { - "type": "number" - }, - "totals": { - "properties": { - "countries": { - "type": "number" - }, - "events": { - "type": "number" - }, - "views": { - "type": "number" - }, - "visitors": { - "type": "number" - } - }, - "required": [ - "views", - "visitors", - "events", - "countries" - ], - "type": "object" - }, - "urls": { - "additionalProperties": { - "type": "number" - }, - "properties": {}, - "type": "object" - } - }, - "required": [ - "countries", - "events", - "referrers", - "timestamp", - "series", - "totals", - "urls" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get real-time website activity", - "tags": [ - "Realtime" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/realtime/[websiteId]/contract.generated.ts" - } - }, - "/api/record": { - "post": { - "description": "Stores session replay events or heatmap clicks and scrolls for a website, using a valid tracking cache token to identify the session and visit.", - "operationId": "record", - "requestBody": { - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "properties": { - "payload": { - "properties": { - "events": { - "items": {}, - "maxItems": 200, - "type": "array" - }, - "timestamp": { - "type": "integer" - }, - "website": { - "format": "uuid", - "type": "string" - } - }, - "required": [ - "website", - "events" - ], - "type": "object" - }, - "type": { - "const": "record" - } - }, - "required": [ - "type", - "payload" - ], - "type": "object" - }, - { - "properties": { - "payload": { - "properties": { - "events": { - "items": { - "anyOf": [ - { - "properties": { - "pageH": { - "type": "number" - }, - "pageW": { - "type": "number" - }, - "pageX": { - "type": "number" - }, - "pageY": { - "type": "number" - }, - "timestamp": { - "type": "integer" - }, - "type": { - "const": "click" - }, - "url": { - "type": "string" - }, - "viewportH": { - "type": "number" - }, - "viewportW": { - "type": "number" - }, - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - }, - "required": [ - "type", - "url" - ], - "type": "object" - }, - { - "properties": { - "pageH": { - "type": "number" - }, - "pageW": { - "type": "number" - }, - "scrollPct": { - "type": "number" - }, - "timestamp": { - "type": "integer" - }, - "type": { - "const": "scroll" - }, - "url": { - "type": "string" - }, - "viewportH": { - "type": "number" - }, - "viewportW": { - "type": "number" - } - }, - "required": [ - "type", - "url" - ], - "type": "object" - } - ] - }, - "maxItems": 200, - "type": "array" - }, - "timestamp": { - "type": "integer" - }, - "website": { - "format": "uuid", - "type": "string" - } - }, - "required": [ - "website", - "events" - ], - "type": "object" - }, - "type": { - "const": "heatmap" - } - }, - "required": [ - "type", - "payload" - ], - "type": "object" - } - ] - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "properties": { - "ok": { - "type": "boolean" - } - }, - "required": [ - "ok" - ], - "type": "object" - }, - { - "properties": { - "ok": { - "type": "boolean" - }, - "reason": { - "type": "string" - } - }, - "required": [ - "ok", - "reason" - ], - "type": "object" - }, - { - "properties": { - "beep": { - "type": "string" - } - }, - "required": [ - "beep" - ], - "type": "object" - } - ] - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "403": { - "content": { - "application/json": { - "example": { - "error": { - "code": "forbidden", - "message": "Forbidden.", - "status": 403 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Forbidden." - }, - "413": { - "content": { - "application/json": { - "example": { - "error": { - "code": "payload-too-large", - "message": "Payload too large.", - "status": 413 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Payload too large." - }, - "500": { - "content": { - "application/json": { - "example": { - "error": { - "code": "server-error", - "message": "Server error.", - "status": 500 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Server error." - } - }, - "security": [], - "summary": "Send session recordings or heatmap data", - "tags": [ - "Collection" - ], - "x-umami-audience": "collect", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/record/contract.generated.ts" - } - }, - "/api/reports": { - "get": { - "description": "Returns a paginated list of saved reports for the requested website, optionally filtered by report type.", - "operationId": "getReports", - "parameters": [ - { - "in": "query", - "name": "websiteId", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "type", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "allOf": [ - { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "description": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "type": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - }, - "websiteId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "name", - "type", - "description", - "parameters", - "websiteId" - ], - "type": "object" - }, - { - "properties": { - "website": { - "properties": { - "domain": { - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "domain", - "userId" - ], - "type": "object" - } - }, - "type": "object" - } - ] - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List saved reports", - "tags": [ - "Reports" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/reports/contract.generated.ts" - }, - "post": { - "description": "Saves a report's name, description, type, and parameters for a website so it can be opened again later.", - "operationId": "createReport", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "description": { - "maxLength": 500, - "type": "string" - }, - "name": { - "maxLength": 200, - "type": "string" - }, - "parameters": { - "additionalProperties": true, - "type": "object" - }, - "type": { - "type": "string" - }, - "websiteId": { - "format": "uuid", - "type": "string" - } - }, - "required": [ - "websiteId", - "type", - "name", - "parameters" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "description": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "type": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - }, - "websiteId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "name", - "type", - "description", - "parameters", - "websiteId" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Save a report", - "tags": [ - "Reports" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/reports/contract.generated.ts" - } - }, - "/api/reports/{reportId}": { - "delete": { - "description": "Deletes the specified saved report definition.", - "operationId": "deleteReport", - "parameters": [ - { - "in": "path", - "name": "reportId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "ok": { - "const": true - } - }, - "required": [ - "ok" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Delete a saved report", - "tags": [ - "Reports" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/reports/[reportId]/contract.generated.ts" - }, - "get": { - "description": "Returns the specified report's saved name, description, type, and parameters.", - "operationId": "getReport", - "parameters": [ - { - "in": "path", - "name": "reportId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "description": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "type": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - }, - "websiteId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "name", - "type", - "description", - "parameters", - "websiteId" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get a saved report", - "tags": [ - "Reports" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/reports/[reportId]/contract.generated.ts" - }, - "post": { - "description": "Updates the specified report's website, name, description, type, and parameters.", - "operationId": "updateReport", - "parameters": [ - { - "in": "path", - "name": "reportId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "description": { - "maxLength": 500, - "type": "string" - }, - "name": { - "maxLength": 200, - "type": "string" - }, - "parameters": { - "additionalProperties": true, - "type": "object" - }, - "type": { - "type": "string" - }, - "websiteId": { - "format": "uuid", - "type": "string" - } - }, - "required": [ - "websiteId", - "type", - "name", - "parameters" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "description": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "type": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - }, - "websiteId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "name", - "type", - "description", - "parameters", - "websiteId" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Update a saved report", - "tags": [ - "Reports" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/reports/[reportId]/contract.generated.ts" - } - }, - "/api/reports/attribution": { - "post": { - "description": "Calculates how traffic sources contribute to conversions using the supplied attribution settings, date range, and filters.", - "operationId": "runAttributionReport", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "filters": { - "additionalProperties": true, - "type": "object" - }, - "parameters": { - "additionalProperties": true, - "type": "object" - }, - "type": { - "type": "string" - }, - "websiteId": { - "format": "uuid", - "type": "string" - } - }, - "required": [ - "websiteId", - "filters", - "type", - "parameters" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "paidAds": { - "items": { - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "number" - } - }, - "required": [ - "name", - "value" - ], - "type": "object" - }, - "type": "array" - }, - "referrer": { - "items": { - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "number" - } - }, - "required": [ - "name", - "value" - ], - "type": "object" - }, - "type": "array" - }, - "total": { - "properties": { - "pageviews": { - "type": "number" - }, - "visitors": { - "type": "number" - }, - "visits": { - "type": "number" - } - }, - "required": [ - "pageviews", - "visitors", - "visits" - ], - "type": "object" - }, - "utm_campaign": { - "items": { - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "number" - } - }, - "required": [ - "name", - "value" - ], - "type": "object" - }, - "type": "array" - }, - "utm_content": { - "items": { - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "number" - } - }, - "required": [ - "name", - "value" - ], - "type": "object" - }, - "type": "array" - }, - "utm_medium": { - "items": { - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "number" - } - }, - "required": [ - "name", - "value" - ], - "type": "object" - }, - "type": "array" - }, - "utm_source": { - "items": { - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "number" - } - }, - "required": [ - "name", - "value" - ], - "type": "object" - }, - "type": "array" - }, - "utm_term": { - "items": { - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "number" - } - }, - "required": [ - "name", - "value" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "referrer", - "paidAds", - "utm_source", - "utm_medium", - "utm_campaign", - "utm_content", - "utm_term", - "total" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Run an attribution report", - "tags": [ - "Reports" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/reports/attribution/contract.generated.ts" - } - }, - "/api/reports/breakdown": { - "post": { - "description": "Groups website activity by the selected dimensions for the requested date range and filters.", - "operationId": "runBreakdownReport", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "filters": { - "additionalProperties": true, - "type": "object" - }, - "parameters": { - "additionalProperties": true, - "type": "object" - }, - "type": { - "type": "string" - }, - "websiteId": { - "format": "uuid", - "type": "string" - } - }, - "required": [ - "websiteId", - "filters", - "type", - "parameters" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - } - ] - }, - "properties": { - "bounces": { - "type": "number" - }, - "totaltime": { - "type": "number" - }, - "views": { - "type": "number" - }, - "visitors": { - "type": "number" - }, - "visits": { - "type": "number" - } - }, - "required": [ - "views", - "visitors", - "visits", - "bounces", - "totaltime" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Run a breakdown report", - "tags": [ - "Reports" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/reports/breakdown/contract.generated.ts" - } - }, - "/api/reports/funnel": { - "post": { - "description": "Calculates visitor progression through a sequence of pages or events using the supplied funnel steps and filters.", - "operationId": "runFunnelReport", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "filters": { - "additionalProperties": true, - "type": "object" - }, - "parameters": { - "additionalProperties": true, - "type": "object" - }, - "type": { - "type": "string" - }, - "websiteId": { - "format": "uuid", - "type": "string" - } - }, - "required": [ - "websiteId", - "filters", - "type", - "parameters" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "dropoff": { - "type": "number" - }, - "dropped": { - "type": "number" - }, - "filters": { - "items": { - "properties": { - "operator": { - "type": "string" - }, - "property": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "required": [ - "property", - "operator", - "value" - ], - "type": "object" - }, - "type": "array" - }, - "previous": { - "type": "number" - }, - "remaining": { - "type": "number" - }, - "type": { - "type": "string" - }, - "value": { - "type": "string" - }, - "visitors": { - "type": "number" - } - }, - "required": [ - "visitors", - "previous", - "dropped", - "dropoff", - "remaining", - "type", - "value" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Run a funnel report", - "tags": [ - "Reports" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/reports/funnel/contract.generated.ts" - } - }, - "/api/reports/goal": { - "post": { - "description": "Counts visitors who reached a matching page or triggered a matching event and returns the total visitor count for comparison.", - "operationId": "runGoalReport", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "filters": { - "additionalProperties": true, - "type": "object" - }, - "parameters": { - "additionalProperties": true, - "type": "object" - }, - "type": { - "type": "string" - }, - "websiteId": { - "format": "uuid", - "type": "string" - } - }, - "required": [ - "websiteId", - "filters", - "type", - "parameters" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "num": { - "type": "number" - }, - "total": { - "type": "number" - } - }, - "required": [ - "num", - "total" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Run a goal report", - "tags": [ - "Reports" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/reports/goal/contract.generated.ts" - } - }, - "/api/reports/heatmap": { - "post": { - "description": "Returns recorded click or scroll data for the selected page and date range to display as a heatmap.", - "operationId": "runHeatmapReport", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "filters": { - "additionalProperties": true, - "type": "object" - }, - "parameters": { - "additionalProperties": true, - "type": "object" - }, - "type": { - "type": "string" - }, - "websiteId": { - "format": "uuid", - "type": "string" - } - }, - "required": [ - "websiteId", - "filters", - "type", - "parameters" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "mode": { - "anyOf": [ - { - "const": "click" - }, - { - "const": "scroll" - } - ] - }, - "pages": { - "items": { - "properties": { - "count": { - "type": "number" - }, - "sessions": { - "type": "number" - }, - "urlPath": { - "type": "string" - } - }, - "required": [ - "urlPath", - "count", - "sessions" - ], - "type": "object" - }, - "type": "array" - }, - "points": { - "items": { - "properties": { - "count": { - "type": "number" - }, - "pageH": { - "type": "number" - }, - "pageW": { - "type": "number" - }, - "pageX": { - "type": "number" - }, - "pageY": { - "type": "number" - }, - "viewportH": { - "type": "number" - }, - "viewportW": { - "type": "number" - }, - "x": { - "type": "number" - }, - "y": { - "type": "number" - } - }, - "required": [ - "x", - "y", - "pageX", - "pageY", - "pageW", - "pageH", - "viewportW", - "viewportH", - "count" - ], - "type": "object" - }, - "type": "array" - }, - "scroll": { - "properties": { - "buckets": { - "items": { - "properties": { - "depth": { - "type": "number" - }, - "pageH": { - "type": "number" - }, - "pageW": { - "type": "number" - }, - "sessions": { - "type": "number" - }, - "viewportH": { - "type": "number" - }, - "viewportW": { - "type": "number" - } - }, - "required": [ - "depth", - "sessions", - "pageW", - "pageH", - "viewportW", - "viewportH" - ], - "type": "object" - }, - "type": "array" - }, - "pageH": { - "type": "number" - }, - "pageW": { - "type": "number" - }, - "totalSessions": { - "type": "number" - }, - "viewportH": { - "type": "number" - }, - "viewportW": { - "type": "number" - } - }, - "required": [ - "buckets", - "totalSessions", - "pageW", - "pageH", - "viewportW", - "viewportH" - ], - "type": "object" - }, - "snapshot": { - "properties": { - "id": { - "type": "string" - }, - "kind": { - "const": "iframe" - }, - "pageH": { - "type": "number" - }, - "pageW": { - "type": "number" - }, - "url": { - "type": "string" - }, - "viewportH": { - "type": "number" - }, - "viewportW": { - "type": "number" - } - }, - "required": [ - "kind", - "id", - "url", - "pageW", - "pageH", - "viewportW", - "viewportH" - ], - "type": "object" - } - }, - "required": [ - "mode", - "pages", - "points", - "snapshot", - "scroll" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get page heatmap data", - "tags": [ - "Reports" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/reports/heatmap/contract.generated.ts" - } - }, - "/api/reports/journey": { - "post": { - "description": "Returns paths through pages or events using the supplied journey settings and website filters.", - "operationId": "runJourneyReport", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "filters": { - "additionalProperties": true, - "type": "object" - }, - "parameters": { - "additionalProperties": true, - "type": "object" - }, - "type": { - "type": "string" - }, - "websiteId": { - "format": "uuid", - "type": "string" - } - }, - "required": [ - "websiteId", - "filters", - "type", - "parameters" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "count": { - "type": "number" - }, - "e1": { - "type": "string" - }, - "e2": { - "type": "string" - }, - "e3": { - "type": "string" - }, - "e4": { - "type": "string" - }, - "e5": { - "type": "string" - }, - "e6": { - "type": "string" - }, - "e7": { - "type": "string" - } - }, - "required": [ - "e1", - "e2", - "e3", - "e4", - "e5", - "e6", - "e7", - "count" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Run a visitor journey report", - "tags": [ - "Reports" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/reports/journey/contract.generated.ts" - } - }, - "/api/reports/performance": { - "post": { - "description": "Returns performance trends, summary metrics, and breakdowns by page, page title, device, and browser for the selected website and date range.", - "operationId": "runPerformanceReport", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "filters": { - "additionalProperties": true, - "type": "object" - }, - "parameters": { - "additionalProperties": true, - "type": "object" - }, - "type": { - "type": "string" - }, - "websiteId": { - "format": "uuid", - "type": "string" - } - }, - "required": [ - "websiteId", - "filters", - "type", - "parameters" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "browsers": {}, - "chart": {}, - "devices": {}, - "pages": {}, - "pageTitles": {}, - "summary": {} - }, - "required": [ - "chart", - "summary", - "pages", - "pageTitles", - "devices", - "browsers" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Run a performance report", - "tags": [ - "Reports" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/reports/performance/contract.generated.ts" - } - }, - "/api/reports/retention": { - "post": { - "description": "Calculates how groups of visitors return over time using the supplied retention settings, date range, and filters.", - "operationId": "runRetentionReport", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "filters": { - "additionalProperties": true, - "type": "object" - }, - "parameters": { - "additionalProperties": true, - "type": "object" - }, - "type": { - "type": "string" - }, - "websiteId": { - "format": "uuid", - "type": "string" - } - }, - "required": [ - "websiteId", - "filters", - "type", - "parameters" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "date": { - "type": "string" - }, - "day": { - "type": "number" - }, - "percentage": { - "type": "number" - }, - "returnVisitors": { - "type": "number" - }, - "visitors": { - "type": "number" - } - }, - "required": [ - "date", - "day", - "visitors", - "returnVisitors", - "percentage" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Run a retention report", - "tags": [ - "Reports" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/reports/retention/contract.generated.ts" - } - }, - "/api/reports/revenue": { - "post": { - "description": "Returns revenue trends, totals with a comparison period, and breakdowns by country, region, referrer, and channel.", - "operationId": "runRevenueReport", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "filters": { - "additionalProperties": true, - "type": "object" - }, - "parameters": { - "additionalProperties": true, - "type": "object" - }, - "type": { - "type": "string" - }, - "websiteId": { - "format": "uuid", - "type": "string" - } - }, - "required": [ - "websiteId", - "filters", - "type", - "parameters" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "channel": { - "items": { - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "number" - } - }, - "required": [ - "name", - "value" - ], - "type": "object" - }, - "type": "array" - }, - "chart": { - "items": { - "properties": { - "count": { - "type": "number" - }, - "t": { - "type": "string" - }, - "x": { - "type": "string" - }, - "y": { - "type": "number" - } - }, - "required": [ - "x", - "t", - "y", - "count" - ], - "type": "object" - }, - "type": "array" - }, - "country": { - "items": { - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "number" - } - }, - "required": [ - "name", - "value" - ], - "type": "object" - }, - "type": "array" - }, - "referrer": { - "items": { - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "number" - } - }, - "required": [ - "name", - "value" - ], - "type": "object" - }, - "type": "array" - }, - "region": { - "items": { - "properties": { - "country": { - "type": "string" - }, - "name": { - "type": "string" - }, - "value": { - "type": "number" - } - }, - "required": [ - "name", - "value", - "country" - ], - "type": "object" - }, - "type": "array" - }, - "total": {} - }, - "required": [ - "chart", - "total", - "country", - "region", - "referrer", - "channel" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Run a revenue report", - "tags": [ - "Reports" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/reports/revenue/contract.generated.ts" - } - }, - "/api/reports/utm": { - "post": { - "description": "Returns traffic breakdowns for UTM source, medium, campaign, term, and content using the supplied date range and filters.", - "operationId": "runUtmReport", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "filters": { - "additionalProperties": true, - "type": "object" - }, - "parameters": { - "additionalProperties": true, - "type": "object" - }, - "type": { - "type": "string" - }, - "websiteId": { - "format": "uuid", - "type": "string" - } - }, - "required": [ - "websiteId", - "filters", - "type", - "parameters" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "utm_campaign": { - "items": {}, - "type": "array" - }, - "utm_content": { - "items": {}, - "type": "array" - }, - "utm_medium": { - "items": {}, - "type": "array" - }, - "utm_source": { - "items": {}, - "type": "array" - }, - "utm_term": { - "items": {}, - "type": "array" - } - }, - "required": [ - "utm_source", - "utm_medium", - "utm_campaign", - "utm_term", - "utm_content" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Run a campaign report", - "tags": [ - "Reports" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/reports/utm/contract.generated.ts" - } - }, - "/api/scripts/telemetry": { - "get": { - "description": "Returns JavaScript that sends the application version through a telemetry pixel, or an inactive script when telemetry is disabled.", - "operationId": "getScriptsTelemetry", - "responses": { - "200": { - "content": { - "text/javascript": { - "schema": { - "type": "string" - } - } - }, - "description": "Successful response. The response shape is inferred as free-form because the handler does not expose a reusable response schema." - } - }, - "security": [], - "summary": "Get the installation telemetry script", - "tags": [ - "Scripts" - ], - "x-umami-audience": "internal", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/scripts/telemetry/contract.generated.ts" - } - }, - "/api/send": { - "post": { - "description": "Collects a pageview, custom event, visitor identification, or performance payload and returns session information and a tracking cache token when accepted.", - "operationId": "send", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "payload": { - "properties": { - "browser": { - "type": "string" - }, - "cls": { - "maximum": 100, - "minimum": 0, - "type": "number" - }, - "data": { - "additionalProperties": true, - "type": "object" - }, - "device": { - "type": "string" - }, - "fcp": { - "maximum": 60000, - "minimum": 0, - "type": "number" - }, - "hostname": { - "type": "string" - }, - "id": { - "type": "string" - }, - "inp": { - "maximum": 60000, - "minimum": 0, - "type": "number" - }, - "ip": { - "type": "string" - }, - "language": { - "type": "string" - }, - "lcp": { - "maximum": 60000, - "minimum": 0, - "type": "number" - }, - "link": { - "format": "uuid", - "type": "string" - }, - "name": {}, - "os": { - "type": "string" - }, - "pixel": { - "format": "uuid", - "type": "string" - }, - "referrer": { - "type": "string" - }, - "screen": { - "type": "string" - }, - "tag": {}, - "timestamp": { - "type": "integer" - }, - "title": { - "type": "string" - }, - "ttfb": { - "maximum": 60000, - "minimum": 0, - "type": "number" - }, - "url": { - "type": "string" - }, - "userAgent": { - "type": "string" - }, - "website": { - "format": "uuid", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "enum": [ - "event", - "identify", - "performance" - ], - "type": "string" - } - }, - "required": [ - "type", - "payload" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "properties": { - "beep": { - "type": "string" - } - }, - "required": [ - "beep" - ], - "type": "object" - }, - { - "properties": { - "cache": {}, - "sessionId": {}, - "visitId": {} - }, - "required": [ - "cache", - "sessionId", - "visitId" - ], - "type": "object" - } - ] - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "403": { - "content": { - "application/json": { - "example": { - "error": { - "code": "forbidden", - "message": "Forbidden.", - "status": 403 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Forbidden." - }, - "500": { - "content": { - "application/json": { - "example": { - "error": { - "code": "server-error", - "message": "Server error.", - "status": 500 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Server error." - } - }, - "security": [], - "summary": "Send tracking data", - "tags": [ - "Collection" - ], - "x-umami-audience": "collect", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/send/contract.generated.ts" - } - }, - "/api/share": { - "post": { - "description": "Creates a named share for a website, board, link, or pixel with parameters and an optional custom slug.", - "operationId": "createShare", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "entityId": { - "format": "uuid", - "type": "string" - }, - "name": { - "maxLength": 200, - "type": "string" - }, - "parameters": { - "additionalProperties": true, - "type": "object" - }, - "shareType": { - "type": "integer" - }, - "slug": { - "maxLength": 100, - "type": "string" - } - }, - "required": [ - "entityId", - "shareType", - "name", - "parameters" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "entityId": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "shareType": { - "type": "number" - }, - "slug": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "name", - "slug", - "parameters", - "entityId", - "shareType" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a share", - "tags": [ - "Shares" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/share/contract.generated.ts" - } - }, - "/api/share/{slug}": { - "get": { - "description": "Resolves a public share slug and returns its resource references, parameters, and an access token scoped to the shared resources.", - "operationId": "getShareBySlug", - "parameters": [ - { - "in": "path", - "name": "slug", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "additionalProperties": {}, - "properties": {}, - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [], - "summary": "Open a share by its slug", - "tags": [ - "Shares" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/share/[slug]/contract.generated.ts" - } - }, - "/api/share/id/{shareId}": { - "delete": { - "description": "Deletes the specified share after checking permission to delete shares for its resource.", - "operationId": "deleteShare", - "parameters": [ - { - "in": "path", - "name": "shareId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "ok": { - "const": true - } - }, - "required": [ - "ok" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Delete a share", - "tags": [ - "Shares" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/share/id/[shareId]/contract.generated.ts" - }, - "get": { - "description": "Returns a share's configuration by its ID after checking access to the shared resource.", - "operationId": "getShare", - "parameters": [ - { - "in": "path", - "name": "shareId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "entityId": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "shareType": { - "type": "number" - }, - "slug": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "name", - "slug", - "parameters", - "entityId", - "shareType" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get a share", - "tags": [ - "Shares" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/share/id/[shareId]/contract.generated.ts" - }, - "post": { - "description": "Updates the specified share's name, slug, and parameters.", - "operationId": "updateShare", - "parameters": [ - { - "in": "path", - "name": "shareId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "maxLength": 200, - "type": "string" - }, - "parameters": { - "additionalProperties": true, - "type": "object" - }, - "slug": { - "maxLength": 100, - "type": "string" - } - }, - "required": [ - "name", - "slug", - "parameters" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "entityId": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "shareType": { - "type": "number" - }, - "slug": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "name", - "slug", - "parameters", - "entityId", - "shareType" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Update a share", - "tags": [ - "Shares" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/share/id/[shareId]/contract.generated.ts" - } - }, - "/api/teams": { - "get": { - "description": "Returns a paginated list of teams the current user belongs to, with sorting options.", - "operationId": "getTeams", - "parameters": [ - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "orderBy", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sortDescending", - "required": false, - "schema": { - "enum": [ - "true", - "false" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "accessCode": { - "type": "string" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "logoUrl": { - "type": "string" - }, - "name": { - "type": "string" - }, - "twoFactorRequired": { - "type": "boolean" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "logoUrl", - "twoFactorRequired", - "deletedAt", - "name", - "accessCode" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "List my teams", - "tags": [ - "Teams" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/teams/contract.generated.ts" - }, - "post": { - "description": "Creates a team with an access code and an owner. Administrators can specify a different user as the owner.", - "operationId": "createTeam", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "maxLength": 50, - "type": "string" - }, - "ownerId": { - "format": "uuid", - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "maxItems": 2, - "minItems": 2, - "prefixItems": [ - { - "properties": { - "accessCode": { - "type": "string" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "logoUrl": { - "type": "string" - }, - "name": { - "type": "string" - }, - "twoFactorRequired": { - "type": "boolean" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "logoUrl", - "twoFactorRequired", - "deletedAt", - "name", - "accessCode" - ], - "type": "object" - }, - { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "role": { - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "role", - "teamId" - ], - "type": "object" - } - ], - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a team", - "tags": [ - "Teams" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/teams/contract.generated.ts" - } - }, - "/api/teams/{teamId}": { - "delete": { - "description": "Deletes the specified team after checking the caller's permission to remove it.", - "operationId": "deleteTeam", - "parameters": [ - { - "in": "path", - "name": "teamId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "ok": { - "const": true - } - }, - "required": [ - "ok" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Delete a team", - "tags": [ - "Teams" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/teams/[teamId]/contract.generated.ts" - }, - "get": { - "description": "Returns the specified team's details, including its members.", - "operationId": "getTeam", - "parameters": [ - { - "in": "path", - "name": "teamId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "accessCode": { - "type": "string" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "logoUrl": { - "type": "string" - }, - "name": { - "type": "string" - }, - "twoFactorRequired": { - "type": "boolean" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "logoUrl", - "twoFactorRequired", - "deletedAt", - "name", - "accessCode" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get a team", - "tags": [ - "Teams" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/teams/[teamId]/contract.generated.ts" - }, - "post": { - "description": "Updates the specified team's name or access code.", - "operationId": "updateTeam", - "parameters": [ - { - "in": "path", - "name": "teamId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "accessCode": { - "maxLength": 50, - "type": "string" - }, - "name": { - "maxLength": 50, - "type": "string" - } - }, - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "accessCode": { - "type": "string" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "logoUrl": { - "type": "string" - }, - "name": { - "type": "string" - }, - "twoFactorRequired": { - "type": "boolean" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "logoUrl", - "twoFactorRequired", - "deletedAt", - "name", - "accessCode" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Update a team", - "tags": [ - "Teams" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/teams/[teamId]/contract.generated.ts" - } - }, - "/api/teams/{teamId}/boards": { - "get": { - "description": "Returns a paginated list of boards belonging to the specified team, with search and sorting options.", - "operationId": "getTeamBoards", - "parameters": [ - { - "in": "path", - "name": "teamId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "orderBy", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sortDescending", - "required": false, - "schema": { - "enum": [ - "true", - "false" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "description": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "teamId": { - "type": "string" - }, - "type": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "name", - "teamId", - "type", - "description", - "parameters" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List a team's boards", - "tags": [ - "Teams" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/teams/[teamId]/boards/contract.generated.ts" - } - }, - "/api/teams/{teamId}/links": { - "get": { - "description": "Returns a paginated list of tracked links belonging to the specified team, with search and sorting options.", - "operationId": "getTeamLinks", - "parameters": [ - { - "in": "path", - "name": "teamId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "orderBy", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sortDescending", - "required": false, - "schema": { - "enum": [ - "true", - "false" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "url": { - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "deletedAt", - "name", - "teamId", - "url", - "slug" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List a team's links", - "tags": [ - "Teams" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/teams/[teamId]/links/contract.generated.ts" - } - }, - "/api/teams/{teamId}/pixels": { - "get": { - "description": "Returns a paginated list of tracking pixels belonging to the specified team, with search and sorting options.", - "operationId": "getTeamPixels", - "parameters": [ - { - "in": "path", - "name": "teamId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "orderBy", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sortDescending", - "required": false, - "schema": { - "enum": [ - "true", - "false" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "deletedAt", - "name", - "teamId", - "slug" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List a team's tracking pixels", - "tags": [ - "Teams" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/teams/[teamId]/pixels/contract.generated.ts" - } - }, - "/api/teams/{teamId}/users": { - "get": { - "description": "Returns a paginated list of members of the specified team, including usernames and membership details.", - "operationId": "getTeamUsers", - "parameters": [ - { - "in": "path", - "name": "teamId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "allOf": [ - { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "role": { - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "role", - "teamId" - ], - "type": "object" - }, - { - "properties": { - "user": { - "properties": { - "id": { - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "id", - "username" - ], - "type": "object" - } - }, - "type": "object" - } - ] - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List team members", - "tags": [ - "Teams" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/teams/[teamId]/users/contract.generated.ts" - }, - "post": { - "description": "Adds an existing user to the specified team with the supplied team role.", - "operationId": "createTeamUser", - "parameters": [ - { - "in": "path", - "name": "teamId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "role": { - "enum": [ - "team-member", - "team-view-only", - "team-manager" - ], - "type": "string" - }, - "userId": { - "format": "uuid", - "type": "string" - } - }, - "required": [ - "userId", - "role" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "role": { - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "role", - "teamId" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Add a team member", - "tags": [ - "Teams" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/teams/[teamId]/users/contract.generated.ts" - } - }, - "/api/teams/{teamId}/users/{userId}": { - "delete": { - "description": "Removes a user's membership from the specified team, subject to team role and ownership restrictions.", - "operationId": "deleteTeamUser", - "parameters": [ - { - "in": "path", - "name": "teamId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "ok": { - "const": true - } - }, - "required": [ - "ok" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Remove a team member", - "tags": [ - "Teams" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/teams/[teamId]/users/[userId]/contract.generated.ts" - }, - "get": { - "description": "Returns the specified user's membership details for a team.", - "operationId": "getTeamUser", - "parameters": [ - { - "in": "path", - "name": "teamId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "role": { - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "role", - "teamId" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Get a team member", - "tags": [ - "Teams" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/teams/[teamId]/users/[userId]/contract.generated.ts" - }, - "post": { - "description": "Updates a user's role in the specified team, subject to the caller's role and permissions.", - "operationId": "updateTeamUser", - "parameters": [ - { - "in": "path", - "name": "teamId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "role": { - "enum": [ - "team-member", - "team-view-only", - "team-manager" - ], - "type": "string" - } - }, - "required": [ - "role" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "role": { - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "role", - "teamId" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Change a team member's role", - "tags": [ - "Teams" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/teams/[teamId]/users/[userId]/contract.generated.ts" - } - }, - "/api/teams/{teamId}/websites": { - "get": { - "description": "Returns a paginated list of websites belonging to the specified team, with search and sorting options.", - "operationId": "getTeamWebsites", - "parameters": [ - { - "in": "path", - "name": "teamId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "orderBy", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sortDescending", - "required": false, - "schema": { - "enum": [ - "true", - "false" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "allOf": [ - { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "createdBy": { - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "domain": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "recorderEnabled": { - "type": "boolean" - }, - "replayConfig": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "resetAt": { - "format": "date-time", - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "deletedAt", - "createdBy", - "name", - "domain", - "resetAt", - "teamId", - "recorderEnabled", - "replayConfig" - ], - "type": "object" - }, - { - "properties": { - "createUser": { - "properties": { - "id": { - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "id", - "username" - ], - "type": "object" - }, - "shareId": { - "type": "string" - }, - "team": { - "properties": { - "members": { - "items": { - "properties": { - "role": { - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "userId", - "role" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "members" - ], - "type": "object" - }, - "user": { - "properties": { - "id": { - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "id", - "username" - ], - "type": "object" - } - }, - "required": [ - "shareId" - ], - "type": "object" - } - ] - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List a team's websites", - "tags": [ - "Teams" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/teams/[teamId]/websites/contract.generated.ts" - } - }, - "/api/teams/join": { - "post": { - "description": "Adds the current user to a team as a member using the team's access code.", - "operationId": "joinTeam", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "accessCode": { - "maxLength": 50, - "type": "string" - } - }, - "required": [ - "accessCode" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "role": { - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "role", - "teamId" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Join a team", - "tags": [ - "Teams" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/teams/join/contract.generated.ts" - } - }, - "/api/users": { - "post": { - "description": "Creates a user account with the supplied username, password, and role.", - "operationId": "createUser", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "id": { - "format": "uuid", - "type": "string" - }, - "password": { - "maxLength": 255, - "minLength": 8, - "type": "string" - }, - "role": { - "enum": [ - "admin", - "user", - "view-only" - ], - "type": "string" - }, - "username": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "username", - "password", - "role" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "id": { - "type": "string" - }, - "role": { - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "id", - "username", - "role" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a user", - "tags": [ - "Users" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/users/contract.generated.ts" - } - }, - "/api/users/{userId}": { - "delete": { - "description": "Deletes the specified user account. The current user cannot delete their own account through this operation.", - "operationId": "deleteUser", - "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "ok": { - "const": true - } - }, - "required": [ - "ok" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Delete a user", - "tags": [ - "Users" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/users/[userId]/contract.generated.ts" - }, - "get": { - "description": "Returns details for the specified user account when the caller has permission to view it.", - "operationId": "getUser", - "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "_count": { - "properties": { - "apiKeys": { - "type": "number" - }, - "boards": { - "type": "number" - }, - "createdBy": { - "type": "number" - }, - "links": { - "type": "number" - }, - "oauthAuthorizationCodes": { - "type": "number" - }, - "oauthRefreshTokens": { - "type": "number" - }, - "pixels": { - "type": "number" - }, - "reports": { - "type": "number" - }, - "teams": { - "type": "number" - }, - "twoFactorAuth": { - "type": "number" - }, - "twoFactorBackupCodes": { - "type": "number" - }, - "twoFactorOtpUseds": { - "type": "number" - }, - "twoFactorRateLimit": { - "type": "number" - }, - "websites": { - "type": "number" - } - }, - "required": [ - "websites", - "createdBy", - "links", - "pixels", - "teams", - "reports", - "boards", - "twoFactorAuth", - "twoFactorBackupCodes", - "twoFactorOtpUseds", - "twoFactorRateLimit", - "apiKeys", - "oauthAuthorizationCodes", - "oauthRefreshTokens" - ], - "type": "object" - }, - "apiKeys": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "keyHash": { - "type": "string" - }, - "keyPrefix": { - "type": "string" - }, - "lastUsedAt": { - "format": "date-time", - "type": "string" - }, - "name": { - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "name", - "keyHash", - "keyPrefix", - "lastUsedAt" - ], - "type": "object" - }, - "type": "array" - }, - "boards": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "description": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "teamId": { - "type": "string" - }, - "type": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "name", - "teamId", - "type", - "description", - "parameters" - ], - "type": "object" - }, - "type": "array" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "createdBy": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "createdBy": { - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "domain": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "recorderEnabled": { - "type": "boolean" - }, - "replayConfig": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "resetAt": { - "format": "date-time", - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "deletedAt", - "createdBy", - "name", - "domain", - "resetAt", - "teamId", - "recorderEnabled", - "replayConfig" - ], - "type": "object" - }, - "type": "array" - }, - "id": { - "type": "string" - }, - "links": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "url": { - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "deletedAt", - "name", - "teamId", - "url", - "slug" - ], - "type": "object" - }, - "type": "array" - }, - "oauthAuthorizationCodes": { - "items": { - "properties": { - "clientId": { - "type": "string" - }, - "codeChallenge": { - "type": "string" - }, - "codeChallengeMethod": { - "type": "string" - }, - "codeHash": { - "type": "string" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "expiresAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "redirectUri": { - "type": "string" - }, - "resource": { - "type": "string" - }, - "scope": { - "type": "string" - }, - "usedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "codeHash", - "expiresAt", - "clientId", - "redirectUri", - "scope", - "resource", - "codeChallenge", - "codeChallengeMethod", - "usedAt" - ], - "type": "object" - }, - "type": "array" - }, - "oauthRefreshTokens": { - "items": { - "properties": { - "clientId": { - "type": "string" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "expiresAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "lastUsedAt": { - "format": "date-time", - "type": "string" - }, - "resource": { - "type": "string" - }, - "revokedAt": { - "format": "date-time", - "type": "string" - }, - "scope": { - "type": "string" - }, - "tokenHash": { - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "expiresAt", - "lastUsedAt", - "clientId", - "scope", - "resource", - "tokenHash", - "revokedAt" - ], - "type": "object" - }, - "type": "array" - }, - "password": { - "type": "string" - }, - "pixels": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "deletedAt", - "name", - "teamId", - "slug" - ], - "type": "object" - }, - "type": "array" - }, - "reports": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "description": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "type": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - }, - "websiteId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "name", - "type", - "description", - "parameters", - "websiteId" - ], - "type": "object" - }, - "type": "array" - }, - "role": { - "type": "string" - }, - "teams": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "role": { - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "role", - "teamId" - ], - "type": "object" - }, - "type": "array" - }, - "twoFactorAuth": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "isEnabled": { - "type": "boolean" - }, - "secret": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "isEnabled", - "id", - "userId", - "secret", - "createdAt", - "updatedAt" - ], - "type": "object" - }, - "twoFactorBackupCodes": { - "items": { - "properties": { - "codeHash": { - "type": "string" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "used": { - "type": "boolean" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "codeHash", - "used" - ], - "type": "object" - }, - "type": "array" - }, - "twoFactorOtpUseds": { - "items": { - "properties": { - "expiresAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "otp": { - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "otp", - "expiresAt" - ], - "type": "object" - }, - "type": "array" - }, - "twoFactorRateLimit": { - "properties": { - "attempts": { - "type": "number" - }, - "id": { - "type": "string" - }, - "lockedUntil": { - "format": "date-time", - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "updatedAt", - "attempts", - "lockedUntil" - ], - "type": "object" - }, - "twoFactorRequired": { - "type": "boolean" - }, - "username": { - "type": "string" - }, - "websites": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "createdBy": { - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "domain": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "recorderEnabled": { - "type": "boolean" - }, - "replayConfig": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "resetAt": { - "format": "date-time", - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "deletedAt", - "createdBy", - "name", - "domain", - "resetAt", - "teamId", - "recorderEnabled", - "replayConfig" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "twoFactorAuth", - "twoFactorRateLimit", - "id", - "createdAt", - "username", - "password", - "role", - "twoFactorRequired", - "websites", - "createdBy", - "links", - "pixels", - "teams", - "reports", - "boards", - "twoFactorBackupCodes", - "twoFactorOtpUseds", - "apiKeys", - "oauthAuthorizationCodes", - "oauthRefreshTokens", - "_count" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get a user", - "tags": [ - "Users" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/users/[userId]/contract.generated.ts" - }, - "post": { - "description": "Updates a user's password. Administrators can also change the username and role.", - "operationId": "updateUser", - "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "password": { - "maxLength": 255, - "minLength": 8, - "type": "string" - }, - "role": { - "enum": [ - "admin", - "user", - "view-only" - ], - "type": "string" - }, - "username": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "role": { - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "username", - "role" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Update a user", - "tags": [ - "Users" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/users/[userId]/contract.generated.ts" - } - }, - "/api/users/{userId}/teams": { - "get": { - "description": "Returns a paginated list of teams for the specified user. Available to that user and administrators.", - "operationId": "getUserTeams", - "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "orderBy", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sortDescending", - "required": false, - "schema": { - "enum": [ - "true", - "false" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "accessCode": { - "type": "string" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "logoUrl": { - "type": "string" - }, - "name": { - "type": "string" - }, - "twoFactorRequired": { - "type": "boolean" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "logoUrl", - "twoFactorRequired", - "deletedAt", - "name", - "accessCode" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "List a user's teams", - "tags": [ - "Users" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/users/[userId]/teams/contract.generated.ts" - } - }, - "/api/users/{userId}/websites": { - "get": { - "description": "Returns a paginated list of the specified user's websites, optionally including team access. Available to that user and administrators.", - "operationId": "getUserWebsites", - "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "orderBy", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sortDescending", - "required": false, - "schema": { - "enum": [ - "true", - "false" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "includeTeams", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "allOf": [ - { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "createdBy": { - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "domain": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "recorderEnabled": { - "type": "boolean" - }, - "replayConfig": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "resetAt": { - "format": "date-time", - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "deletedAt", - "createdBy", - "name", - "domain", - "resetAt", - "teamId", - "recorderEnabled", - "replayConfig" - ], - "type": "object" - }, - { - "properties": { - "createUser": { - "properties": { - "id": { - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "id", - "username" - ], - "type": "object" - }, - "shareId": { - "type": "string" - }, - "team": { - "properties": { - "members": { - "items": { - "properties": { - "role": { - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "userId", - "role" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "members" - ], - "type": "object" - }, - "user": { - "properties": { - "id": { - "type": "string" - }, - "username": { - "type": "string" - } - }, - "required": [ - "id", - "username" - ], - "type": "object" - } - }, - "required": [ - "shareId" - ], - "type": "object" - } - ] - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "List a user's websites", - "tags": [ - "Users" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/users/[userId]/websites/contract.generated.ts" - } - }, - "/api/websites": { - "get": { - "description": "Returns a paginated list of the current user's websites, optionally including websites accessible through team membership.", - "operationId": "listWebsites", - "parameters": [ - { - "in": "query", - "name": "page", - "schema": { - "exclusiveMinimum": 0, - "maximum": 9007199254740991, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "schema": { - "exclusiveMinimum": 0, - "maximum": 9007199254740991, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "schema": { - "exclusiveMinimum": 0, - "maximum": 9007199254740991, - "type": "integer" - } - }, - { - "in": "query", - "name": "search", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "orderBy", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "sortDescending", - "schema": { - "enum": [ - "true", - "false" - ], - "type": "string" - } - }, - { - "description": "When present, include websites accessible through owned or managed teams.", - "in": "query", - "name": "includeTeams", - "schema": { - "description": "When present, include websites accessible through owned or managed teams.", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebsitePage" - } - } - }, - "description": "A page of websites." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "websites:read" - ] - } - ], - "summary": "List websites", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "websites:read", - "x-umami-source": "src/app/api/websites/contract.ts" - }, - "post": { - "description": "Creates a website with a name and domain, optionally assigning it to a team and creating a share.", - "operationId": "createWebsite", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateWebsiteRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Website" - } - } - }, - "description": "Website created." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a website", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/contract.ts" - } - }, - "/api/websites/{websiteId}": { - "delete": { - "description": "Deletes the specified website after checking the caller's permission to remove it.", - "operationId": "deleteWebsite", - "parameters": [ - { - "description": "Website ID.", - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "description": "Website ID.", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Ok" - } - } - }, - "description": "Website deleted." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Delete a website", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/contract.ts" - }, - "get": { - "description": "Returns the specified website's details and configuration.", - "operationId": "getWebsite", - "parameters": [ - { - "description": "Website ID.", - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "description": "Website ID.", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/Website" - }, - { - "type": "null" - } - ] - } - } - }, - "description": "Website details, or null if it does not exist." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "websites:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get a website", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "websites:read", - "x-umami-source": "src/app/api/websites/[websiteId]/contract.ts" - }, - "post": { - "description": "Updates a website's name, domain, sharing settings, or recording configuration.", - "operationId": "updateWebsite", - "parameters": [ - { - "description": "Website ID.", - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "description": "Website ID.", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateWebsiteRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Website" - } - } - }, - "description": "Website updated." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "500": { - "content": { - "application/json": { - "example": { - "error": { - "code": "server-error", - "message": "Server error.", - "status": 500 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Server error." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Update a website", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/contract.ts" - } - }, - "/api/websites/{websiteId}/active": { - "get": { - "description": "Returns the number of visitors active on the website in the last few minutes.", - "operationId": "getWebsiteActive", - "parameters": [ - { - "description": "Website ID.", - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "description": "Website ID.", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActiveVisitors" - } - } - }, - "description": "Active visitor count." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get active website visitors", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/websites/[websiteId]/active/contract.ts" - } - }, - "/api/websites/{websiteId}/annotations": { - "get": { - "description": "Returns a paginated list of dated notes for the website, optionally filtered by date range or search text.", - "operationId": "getWebsiteAnnotations", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "endAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "allDay": { - "type": "boolean" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "date": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "note": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - }, - "websiteId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "websiteId", - "date", - "allDay", - "note" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List website annotations", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/annotations/contract.generated.ts" - }, - "post": { - "description": "Adds a dated note to the website, optionally marking it as an all-day annotation.", - "operationId": "createWebsiteAnnotation", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "allDay": { - "type": "boolean" - }, - "date": { - "format": "date-time", - "type": "string" - }, - "note": { - "maxLength": 500, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "date", - "note" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "allDay": { - "type": "boolean" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "date": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "note": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - }, - "websiteId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "websiteId", - "date", - "allDay", - "note" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a website annotation", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/annotations/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/annotations/{annotationId}": { - "delete": { - "description": "Deletes the specified dated note from the website.", - "operationId": "deleteWebsiteAnnotation", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "annotationId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "ok": { - "const": true - } - }, - "required": [ - "ok" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Delete a website annotation", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/annotations/[annotationId]/contract.generated.ts" - }, - "get": { - "description": "Returns the date, all-day setting, and note for a specific website annotation.", - "operationId": "getWebsiteAnnotation", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "annotationId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "allDay": { - "type": "boolean" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "date": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "note": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - }, - "websiteId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "websiteId", - "date", - "allDay", - "note" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get a website annotation", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/annotations/[annotationId]/contract.generated.ts" - }, - "post": { - "description": "Changes the date, all-day setting, and note for a website annotation.", - "operationId": "updateWebsiteAnnotation", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "annotationId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "allDay": { - "type": "boolean" - }, - "date": { - "format": "date-time", - "type": "string" - }, - "note": { - "maxLength": 500, - "minLength": 1, - "type": "string" - } - }, - "required": [ - "date", - "note" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "allDay": { - "type": "boolean" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "date": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "note": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - }, - "websiteId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "websiteId", - "date", - "allDay", - "note" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Update a website annotation", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/annotations/[annotationId]/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/daterange": { - "get": { - "description": "Returns the earliest and latest recorded event dates for the website.", - "operationId": "getWebsiteDateRange", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "endDate": { - "format": "date-time", - "type": "string" - }, - "startDate": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "startDate", - "endDate" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get the website's available date range", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/websites/[websiteId]/daterange/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/event-data": { - "get": { - "description": "Returns a page of events in the selected date range, grouping each event's custom property records together.", - "operationId": "getEventData", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "eventId": { - "type": "string" - }, - "eventName": { - "type": "string" - }, - "eventProperties": { - "items": { - "properties": { - "createdAt": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "date-time", - "type": "string" - } - ] - }, - "dataKey": { - "type": "string" - }, - "dataType": { - "type": "number" - }, - "dateValue": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "date-time", - "type": "string" - } - ] - }, - "numberValue": { - "type": "number" - }, - "stringValue": { - "type": "string" - } - }, - "required": [ - "createdAt", - "dataKey", - "stringValue", - "numberValue", - "dateValue", - "dataType" - ], - "type": "object" - }, - "type": "array" - }, - "websiteId": { - "type": "string" - } - }, - "required": [ - "websiteId", - "eventId", - "eventName", - "eventProperties" - ], - "type": "object" - }, - "type": "array" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List events with custom properties", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/websites/[websiteId]/event-data/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/event-data-pivot": { - "get": { - "description": "Returns a page of occurrences of the specified event, with event details and property keys and values grouped into one row per occurrence.", - "operationId": "getEventDataPivot", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "eventName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "createdAt": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "date-time", - "type": "string" - } - ] - }, - "eventId": { - "type": "string" - }, - "eventName": { - "type": "string" - }, - "propertyKeys": { - "items": { - "type": "string" - }, - "type": "array" - }, - "propertyValues": { - "items": { - "type": "string" - }, - "type": "array" - }, - "sessionId": { - "type": "string" - }, - "urlPath": { - "type": "string" - } - }, - "required": [ - "eventId", - "sessionId", - "eventName", - "urlPath", - "createdAt", - "propertyKeys", - "propertyValues" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List event properties in table form", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/event-data-pivot/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/event-data-pivot/array-series": { - "get": { - "description": "Counts individual values in an array property for the specified event, grouped by value and time interval.", - "operationId": "getEventDataArraySeries", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "eventName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "propertyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "t": { - "type": "string" - }, - "x": { - "type": "string" - }, - "y": { - "type": "number" - } - }, - "required": [ - "x", - "t", - "y" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get event array values over time", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/event-data-pivot/array-series/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/event-data-pivot/date-series": { - "get": { - "description": "Counts occurrences of dates stored in the specified event property, grouping by the property's date value within the selected event date range.", - "operationId": "getEventDataDateSeries", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "eventName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "propertyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "t": { - "type": "string" - }, - "y": { - "type": "number" - } - }, - "required": [ - "t", - "y" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get the distribution of event date values", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/event-data-pivot/date-series/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/event-data-pivot/numeric-series": { - "get": { - "description": "Returns the sum, average, or count of a numeric property for the specified event, grouped by time interval.", - "operationId": "getEventDataNumericSeries", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "eventName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "propertyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "metric", - "required": false, - "schema": { - "enum": [ - "sum", - "avg", - "count" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "t": { - "type": "string" - }, - "y": { - "type": "number" - } - }, - "required": [ - "t", - "y" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get numeric event properties over time", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/event-data-pivot/numeric-series/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/event-data-pivot/numeric-stats": { - "get": { - "description": "Returns the total, average, median, minimum, and maximum of the specified numeric event property for the selected date range and filters.", - "operationId": "getEventDataNumericStats", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "eventName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "propertyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "average": { - "type": "number" - }, - "max": { - "type": "number" - }, - "median": { - "type": "number" - }, - "min": { - "type": "number" - }, - "total": { - "type": "number" - } - }, - "required": [ - "total", - "average", - "median", - "max", - "min" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get numeric event property statistics", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/event-data-pivot/numeric-stats/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/event-data-pivot/property-series": { - "get": { - "description": "Counts occurrences of string values in the specified event property, grouped by value and time interval.", - "operationId": "getEventDataPropertySeries", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "eventName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "propertyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "t": { - "type": "string" - }, - "x": { - "type": "string" - }, - "y": { - "type": "number" - } - }, - "required": [ - "x", - "t", - "y" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get event property values over time", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/event-data-pivot/property-series/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/event-data/{eventId}": { - "get": { - "description": "Returns the custom property records, data types, and values attached to a specific event.", - "operationId": "getEventDataById", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "eventId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "dataKey": { - "type": "string" - }, - "dataType": { - "type": "number" - }, - "dateValue": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "numberValue": { - "properties": { - "d": { - "items": { - "type": "number" - }, - "type": "array" - }, - "e": { - "type": "number" - }, - "s": { - "type": "number" - } - }, - "required": [ - "d", - "e", - "s" - ], - "type": "object" - }, - "stringValue": { - "type": "string" - }, - "websiteEventId": { - "type": "string" - }, - "websiteId": { - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "websiteId", - "websiteEventId", - "dataKey", - "stringValue", - "numberValue", - "dateValue", - "dataType" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get an event's custom properties", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/event-data/[eventId]/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/event-data/events": { - "get": { - "description": "Returns property names, types, and counts grouped by event name. When an event is specified, also groups by property value.", - "operationId": "getEventDataEvents", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "dataType": { - "type": "number" - }, - "eventName": { - "type": "string" - }, - "propertyName": { - "type": "string" - }, - "propertyValue": { - "type": "string" - }, - "total": { - "type": "number" - } - }, - "required": [ - "propertyName", - "dataType", - "total" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Summarize properties by event", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/event-data/events/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/event-data/fields": { - "get": { - "description": "Returns property names, data types, and counts for the selected date range, optionally restricted to an event name.", - "operationId": "getEventDataFields", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "eventName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "dataType": { - "type": "number" - }, - "propertyName": { - "type": "string" - }, - "total": { - "type": "number" - } - }, - "required": [ - "propertyName", - "dataType", - "total" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List event property fields", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/event-data/fields/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/event-data/properties": { - "get": { - "description": "Returns event names and their custom property names, data types, and record counts for the selected date range and filters.", - "operationId": "getEventDataProperties", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "dataType": { - "type": "number" - }, - "eventName": { - "type": "string" - }, - "propertyName": { - "type": "string" - }, - "total": { - "type": "number" - } - }, - "required": [ - "eventName", - "propertyName", - "dataType", - "total" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List event property usage", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/websites/[websiteId]/event-data/properties/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/event-data/stats": { - "get": { - "description": "Returns counts of events with custom data, distinct property names, and property records for the selected date range and filters.", - "operationId": "getEventDataStats", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "events": { - "type": "number" - }, - "properties": { - "type": "number" - }, - "records": { - "type": "number" - } - }, - "required": [ - "events", - "properties", - "records" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get event property totals", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/websites/[websiteId]/event-data/stats/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/event-data/values": { - "get": { - "description": "Returns values and their occurrence counts for a custom event property, optionally restricted by event name and data type.", - "operationId": "getEventDataValues", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "eventName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "propertyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "dataType", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "total": { - "type": "number" - }, - "value": { - "type": "string" - } - }, - "required": [ - "value", - "total" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List event property values", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/websites/[websiteId]/event-data/values/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/events": { - "get": { - "description": "Returns a page of pageviews and custom events in the date range, newest first. Supports filtering by event name and searching event details.", - "operationId": "getWebsiteEvents", - "parameters": [ - { - "description": "Website ID.", - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "description": "Website ID.", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "endAt", - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "startDate", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "compare", - "schema": { - "enum": [ - "prev", - "yoy" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "schema": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "schema": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "schema": { - "exclusiveMinimum": 0, - "maximum": 9007199254740991, - "type": "integer" - } - }, - { - "in": "query", - "name": "excludeBounce", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "match", - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "schema": { - "exclusiveMinimum": 0, - "maximum": 9007199254740991, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "schema": { - "exclusiveMinimum": 0, - "maximum": 9007199254740991, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "schema": { - "exclusiveMinimum": 0, - "maximum": 9007199254740991, - "type": "integer" - } - }, - { - "in": "query", - "name": "search", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebsiteEventPage" - } - } - }, - "description": "A page of events." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List tracked events", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/websites/[websiteId]/events/contract.ts" - } - }, - "/api/websites/{websiteId}/events/series": { - "get": { - "description": "Returns counts grouped by event name and time interval, optionally limited to the most frequent event names.", - "operationId": "getWebsiteEventSeries", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "unit", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "limit", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "t": { - "type": "string" - }, - "x": { - "type": "string" - }, - "y": { - "type": "number" - } - }, - "required": [ - "x", - "t", - "y" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get custom event counts over time", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/websites/[websiteId]/events/series/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/events/stats": { - "get": { - "description": "Returns website event totals for the selected date range and filters, including totals for the comparison period.", - "operationId": "getWebsiteEventStats", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "endAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "compare", - "required": false, - "schema": { - "enum": [ - "prev", - "yoy" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "data": { - "properties": { - "comparison": { - "items": { - "properties": { - "events": { - "type": "number" - }, - "uniqueEvents": { - "type": "number" - }, - "visitors": { - "type": "number" - }, - "visits": { - "type": "number" - } - }, - "required": [ - "events", - "visitors", - "visits", - "uniqueEvents" - ], - "type": "object" - }, - "type": "array" - }, - "length": { - "type": "number" - } - }, - "required": [ - "comparison", - "length" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get website event statistics", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/websites/[websiteId]/events/stats/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/export": { - "get": { - "description": "Returns a base64-encoded ZIP archive containing CSV exports of events, pages, referrers, browsers, operating systems, devices, and countries.", - "operationId": "exportWebsite", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "endAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "compare", - "required": false, - "schema": { - "enum": [ - "prev", - "yoy" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "zip": { - "type": "string" - } - }, - "required": [ - "zip" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "function toString() { [native code] }": { - "content": { - "application/json": { - "schema": {} - } - }, - "description": "Successful response. The response shape is inferred as free-form because the handler does not expose a reusable response schema." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Export website analytics", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/export/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/metrics": { - "get": { - "description": "Returns the most frequent values for a dimension such as pages, referrers, countries, browsers, campaigns, or events. Counts pageviews or events for activity dimensions and unique visitors for visitor dimensions.", - "operationId": "getWebsiteMetrics", - "parameters": [ - { - "description": "Website ID.", - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "description": "Website ID.", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "endAt", - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "startDate", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "compare", - "schema": { - "enum": [ - "prev", - "yoy" - ], - "type": "string" - } - }, - { - "description": "Dimension to rank: path, entry, exit, title, query, hostname, referrer, domain, channel, event, tag, browser, os, device, screen, language, country, region, city, distinctId, utmSource, utmMedium, utmCampaign, utmContent, utmTerm.", - "in": "query", - "name": "type", - "required": true, - "schema": { - "description": "Dimension to rank: path, entry, exit, title, query, hostname, referrer, domain, channel, event, tag, browser, os, device, screen, language, country, region, city, distinctId, utmSource, utmMedium, utmCampaign, utmContent, utmTerm.", - "type": "string" - } - }, - { - "in": "query", - "name": "limit", - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "offset", - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "search", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "schema": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "schema": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "schema": { - "exclusiveMinimum": 0, - "maximum": 9007199254740991, - "type": "integer" - } - }, - { - "in": "query", - "name": "excludeBounce", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "match", - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MetricRows" - } - } - }, - "description": "Ranked rows." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get ranked website metrics", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/websites/[websiteId]/metrics/contract.ts" - } - }, - "/api/websites/{websiteId}/metrics/expanded": { - "get": { - "description": "Returns additional analytics for the selected page, event, visitor, or channel dimension, using the supplied date range and filters.", - "operationId": "getWebsiteExpandedMetrics", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "endAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "compare", - "required": false, - "schema": { - "enum": [ - "prev", - "yoy" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "type", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "limit", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "offset", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "bounces": { - "type": "number" - }, - "name": { - "type": "string" - }, - "pageviews": { - "type": "number" - }, - "totaltime": { - "type": "number" - }, - "visitors": { - "type": "number" - }, - "visits": { - "type": "number" - } - }, - "required": [ - "name", - "pageviews", - "visitors", - "visits", - "bounces", - "totaltime" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get detailed website metrics", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/websites/[websiteId]/metrics/expanded/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/pageviews": { - "get": { - "description": "Returns pageviews and sessions grouped by the requested time interval and timezone, including a comparison period when requested.", - "operationId": "getWebsitePageviews", - "parameters": [ - { - "description": "Website ID.", - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "description": "Website ID.", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "endAt", - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "startDate", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "compare", - "schema": { - "enum": [ - "prev", - "yoy" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "schema": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "schema": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "schema": { - "exclusiveMinimum": 0, - "maximum": 9007199254740991, - "type": "integer" - } - }, - { - "in": "query", - "name": "excludeBounce", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "match", - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebsitePageviews" - } - } - }, - "description": "Time series." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get pageviews and sessions over time", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/websites/[websiteId]/pageviews/contract.ts" - } - }, - "/api/websites/{websiteId}/recorder": { - "get": { - "description": "Returns public replay and heatmap settings, including sampling, masking, and duration limits. Returns disabled status when recording is unavailable.", - "operationId": "getWebsiteRecorderConfig", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "properties": { - "enabled": { - "type": "boolean" - } - }, - "required": [ - "enabled" - ], - "type": "object" - }, - { - "properties": { - "blockSelector": { - "type": "string" - }, - "enabled": { - "type": "boolean" - }, - "heatmapEnabled": { - "type": "boolean" - }, - "heatmapSampleRate": { - "type": "number" - }, - "maskLevel": { - "anyOf": [ - { - "const": "strict" - }, - { - "const": "moderate" - } - ] - }, - "maxDuration": { - "type": "number" - }, - "replayEnabled": { - "type": "boolean" - }, - "sampleRate": { - "type": "number" - } - }, - "required": [ - "enabled", - "replayEnabled", - "heatmapEnabled", - "sampleRate", - "heatmapSampleRate", - "maskLevel", - "maxDuration", - "blockSelector" - ], - "type": "object" - } - ] - } - } - }, - "description": "The operation completed successfully." - } - }, - "security": [], - "summary": "Get website recording settings", - "tags": [ - "Websites" - ], - "x-umami-audience": "collect", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/recorder/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/replays": { - "get": { - "description": "Returns a paginated list of recorded sessions for the website, applying date, replay, and search filters.", - "operationId": "getWebsiteReplays", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "endAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "compare", - "required": false, - "schema": { - "enum": [ - "prev", - "yoy" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "minDuration", - "required": false, - "schema": { - "minimum": 0, - "type": "integer" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "browser": { - "type": "string" - }, - "chunkCount": { - "type": "number" - }, - "city": { - "type": "string" - }, - "country": { - "type": "string" - }, - "createdAt": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "date-time", - "type": "string" - } - ] - }, - "device": { - "type": "string" - }, - "duration": { - "type": "number" - }, - "endedAt": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "date-time", - "type": "string" - } - ] - }, - "eventCount": { - "type": "number" - }, - "id": { - "type": "string" - }, - "os": { - "type": "string" - }, - "sessionId": { - "type": "string" - }, - "startedAt": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "date-time", - "type": "string" - } - ] - }, - "websiteId": { - "type": "string" - } - }, - "required": [ - "id", - "sessionId", - "websiteId", - "browser", - "os", - "device", - "country", - "city", - "eventCount", - "chunkCount", - "startedAt", - "endedAt", - "duration", - "createdAt" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List website session replays", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/replays/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/replays/{replayId}": { - "get": { - "description": "Returns the merged recording events, session details, and event and chunk counts for a replay, with optional stopping points by timestamp, chunk, or event index.", - "operationId": "getWebsiteReplay", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "replayId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "chunkCount": { - "type": "number" - }, - "endedAt": { - "format": "date-time", - "type": "string" - }, - "eventCount": { - "type": "number" - }, - "events": { - "items": {}, - "type": "array" - }, - "sessionId": { - "type": "string" - }, - "startedAt": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "sessionId", - "events", - "startedAt", - "endedAt", - "eventCount", - "chunkCount" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get a session replay recording", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/replays/[replayId]/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/replays/saved": { - "get": { - "description": "Returns a paginated, searchable list of replays saved for the website.", - "operationId": "getWebsiteSavedReplays", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "visitId": { - "type": "string" - }, - "websiteId": { - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "name", - "websiteId", - "visitId" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List saved session replays", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/replays/saved/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/replays/saved/{replayId}": { - "get": { - "description": "Returns whether the specified replay is in the website's saved replays.", - "operationId": "getWebsiteReplaySaved", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "replayId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "isSaved": { - "type": "boolean" - } - }, - "required": [ - "isSaved" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Check whether a replay is saved", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/replays/saved/[replayId]/contract.generated.ts" - }, - "post": { - "description": "Adds a replay to the website's saved replays with an optional name, or removes it when isSaved is false.", - "operationId": "saveWebsiteReplay", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "replayId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "isSaved": { - "type": "boolean" - }, - "name": { - "maxLength": 100, - "type": "string" - } - }, - "required": [ - "isSaved" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "ok": { - "type": "boolean" - } - }, - "required": [ - "ok" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Save or unsave a session replay", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/replays/saved/[replayId]/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/reports": { - "get": { - "description": "Returns a paginated list of saved report definitions for the website, optionally filtered by report type.", - "operationId": "getWebsiteReports", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "type", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "allOf": [ - { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "description": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "type": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - }, - "websiteId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "name", - "type", - "description", - "parameters", - "websiteId" - ], - "type": "object" - }, - { - "properties": { - "website": { - "properties": { - "domain": { - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "domain", - "userId" - ], - "type": "object" - } - }, - "type": "object" - } - ] - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List a website's saved reports", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/reports/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/reset": { - "post": { - "description": "Clears the website's collected analytics data while keeping the website configuration.", - "operationId": "resetWebsite", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "ok": { - "const": true - } - }, - "required": [ - "ok" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Reset website analytics", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/reset/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/revenue/chart": { - "get": { - "description": "Returns revenue chart data for the selected currency, date range, and website filters.", - "operationId": "getWebsiteRevenueChart", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "endAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "compare", - "required": false, - "schema": { - "enum": [ - "prev", - "yoy" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "currency", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "chart": { - "items": { - "properties": { - "count": { - "type": "number" - }, - "t": { - "type": "string" - }, - "x": { - "type": "string" - }, - "y": { - "type": "number" - } - }, - "required": [ - "x", - "t", - "y", - "count" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "chart" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get website revenue over time", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/revenue/chart/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/revenue/metrics": { - "get": { - "description": "Returns revenue grouped by the requested dimension, such as country or referrer, for the selected currency and date range.", - "operationId": "getWebsiteRevenueMetrics", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "endAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "compare", - "required": false, - "schema": { - "enum": [ - "prev", - "yoy" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "type", - "required": true, - "schema": { - "enum": [ - "country", - "region", - "referrer", - "channel" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "currency", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "anyOf": [ - { - "items": { - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "number" - } - }, - "required": [ - "name", - "value" - ], - "type": "object" - }, - "type": "array" - }, - { - "items": { - "properties": { - "country": { - "type": "string" - }, - "name": { - "type": "string" - }, - "value": { - "type": "number" - } - }, - "required": [ - "name", - "value", - "country" - ], - "type": "object" - }, - "type": "array" - } - ] - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get website revenue by dimension", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/revenue/metrics/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/revenue/sessions": { - "get": { - "description": "Returns a paginated list of sessions with revenue in the selected currency and date range, applying website and search filters.", - "operationId": "getWebsiteRevenueSessions", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "endAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "compare", - "required": false, - "schema": { - "enum": [ - "prev", - "yoy" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "currency", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "browser": { - "type": "string" - }, - "city": { - "type": "string" - }, - "country": { - "type": "string" - }, - "createdAt": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "date-time", - "type": "string" - } - ] - }, - "device": { - "type": "string" - }, - "events": { - "type": "number" - }, - "firstAt": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "date-time", - "type": "string" - } - ] - }, - "hostname": { - "type": "string" - }, - "id": { - "type": "string" - }, - "language": { - "type": "string" - }, - "lastAt": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "date-time", - "type": "string" - } - ] - }, - "os": { - "type": "string" - }, - "region": { - "type": "string" - }, - "screen": { - "type": "string" - }, - "views": { - "type": "number" - }, - "visits": { - "type": "number" - }, - "websiteId": { - "type": "string" - } - }, - "required": [ - "id", - "websiteId", - "hostname", - "browser", - "os", - "device", - "screen", - "language", - "country", - "region", - "city", - "firstAt", - "lastAt", - "visits", - "views", - "events", - "createdAt" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List sessions with revenue", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/revenue/sessions/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/revenue/stats": { - "get": { - "description": "Returns revenue summary statistics for the selected currency and date range, including totals for the comparison period.", - "operationId": "getWebsiteRevenueStats", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "endAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "compare", - "required": false, - "schema": { - "enum": [ - "prev", - "yoy" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "currency", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "comparison": {} - }, - "required": [ - "comparison" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get website revenue totals", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/revenue/stats/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/segments": { - "get": { - "description": "Returns saved segments or cohorts for the website, filtered by the requested type and search text.", - "operationId": "getWebsiteSegments", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "type", - "required": true, - "schema": { - "enum": [ - "segment", - "cohort" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "type": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "websiteId": { - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "name", - "type", - "parameters", - "websiteId" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List website segments and cohorts", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/segments/contract.generated.ts" - }, - "post": { - "description": "Saves a named segment or cohort with its type and filter parameters for the website.", - "operationId": "createWebsiteSegment", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "maxLength": 200, - "type": "string" - }, - "parameters": { - "properties": { - "action": { - "properties": { - "type": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "required": [ - "type", - "value" - ], - "type": "object" - }, - "dateRange": { - "type": "string" - }, - "filters": { - "items": { - "additionalProperties": true, - "type": "object" - }, - "type": "array" - }, - "match": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - }, - "type": "object" - }, - "type": { - "enum": [ - "segment", - "cohort" - ], - "type": "string" - } - }, - "required": [ - "type", - "name", - "parameters" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "type": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "websiteId": { - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "name", - "type", - "parameters", - "websiteId" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a website segment or cohort", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/segments/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/segments/{segmentId}": { - "delete": { - "description": "Deletes the specified saved segment or cohort from the website.", - "operationId": "deleteWebsiteSegment", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "segmentId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "ok": { - "const": true - } - }, - "required": [ - "ok" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Delete a website segment or cohort", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/segments/[segmentId]/contract.generated.ts" - }, - "get": { - "description": "Returns a saved segment or cohort and its filter parameters for the website.", - "operationId": "getWebsiteSegment", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "segmentId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "type": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "websiteId": { - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "name", - "type", - "parameters", - "websiteId" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get a website segment or cohort", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/segments/[segmentId]/contract.generated.ts" - }, - "post": { - "description": "Updates a saved segment or cohort's type, name, and filter parameters.", - "operationId": "updateWebsiteSegment", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "segmentId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "maxLength": 200, - "type": "string" - }, - "parameters": { - "additionalProperties": true, - "type": "object" - }, - "type": { - "enum": [ - "segment", - "cohort" - ], - "type": "string" - } - }, - "required": [ - "type", - "name", - "parameters" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "type": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "websiteId": { - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "name", - "type", - "parameters", - "websiteId" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Update a website segment or cohort", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/segments/[segmentId]/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/session-data-pivot": { - "get": { - "description": "Returns a page of sessions matching the selected property and filters, with the latest property keys and values grouped into one row per session.", - "operationId": "getSessionDataPivot", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "propertyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "createdAt": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "date-time", - "type": "string" - } - ] - }, - "distinctId": { - "type": "string" - }, - "propertyKeys": { - "items": { - "type": "string" - }, - "type": "array" - }, - "propertyValues": { - "items": { - "type": "string" - }, - "type": "array" - }, - "sessionId": { - "type": "string" - } - }, - "required": [ - "sessionId", - "distinctId", - "createdAt", - "propertyKeys", - "propertyValues" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List session properties in table form", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/session-data-pivot/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/session-data/array-series": { - "get": { - "description": "Counts distinct sessions for individual values in an array property, grouped by value and time interval.", - "operationId": "getSessionDataArraySeries", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "propertyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "t": { - "type": "string" - }, - "x": { - "type": "string" - }, - "y": { - "type": "number" - } - }, - "required": [ - "x", - "t", - "y" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get session array values over time", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/session-data/array-series/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/session-data/date-series": { - "get": { - "description": "Counts distinct sessions by dates stored in the specified custom property, using the selected date range and filters.", - "operationId": "getSessionDataDateSeries", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "propertyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "t": { - "type": "string" - }, - "y": { - "type": "number" - } - }, - "required": [ - "t", - "y" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get the distribution of session date values", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/session-data/date-series/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/session-data/numeric-series": { - "get": { - "description": "Returns the sum, average, or count of a numeric session property, grouped by time interval for the selected date range and filters.", - "operationId": "getSessionDataNumericSeries", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "propertyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "metric", - "required": false, - "schema": { - "enum": [ - "sum", - "avg", - "count" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "t": { - "type": "string" - }, - "y": { - "type": "number" - } - }, - "required": [ - "t", - "y" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get numeric session properties over time", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/session-data/numeric-series/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/session-data/numeric-stats": { - "get": { - "description": "Returns the total, average, median, minimum, and maximum of the specified numeric session property for the selected date range and filters.", - "operationId": "getSessionDataNumericStats", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "propertyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "average": { - "type": "number" - }, - "max": { - "type": "number" - }, - "median": { - "type": "number" - }, - "min": { - "type": "number" - }, - "total": { - "type": "number" - } - }, - "required": [ - "total", - "average", - "median", - "max", - "min" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get numeric session property statistics", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/session-data/numeric-stats/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/session-data/properties": { - "get": { - "description": "Returns custom session property names, data types, and distinct session counts, optionally restricted to sessions with a selected property.", - "operationId": "getSessionDataProperties", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "propertyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "dataType": { - "type": "number" - }, - "propertyName": { - "type": "string" - }, - "total": { - "type": "number" - } - }, - "required": [ - "propertyName", - "dataType", - "total" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List session property usage", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/session-data/properties/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/session-data/property-series": { - "get": { - "description": "Counts distinct sessions for string values in a custom property, grouped by value and time interval.", - "operationId": "getSessionDataPropertySeries", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "propertyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "t": { - "type": "string" - }, - "x": { - "type": "string" - }, - "y": { - "type": "number" - } - }, - "required": [ - "x", - "t", - "y" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get session property values over time", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/session-data/property-series/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/session-data/stats": { - "get": { - "description": "Returns session, visit, pageview, event, and total activity counts grouped by values of the specified session property.", - "operationId": "getSessionDataStats", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "propertyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "activity": { - "type": "number" - }, - "events": { - "type": "number" - }, - "label": { - "type": "string" - }, - "sessions": { - "type": "number" - }, - "views": { - "type": "number" - }, - "visits": { - "type": "number" - } - }, - "required": [ - "label", - "activity", - "sessions", - "visits", - "views", - "events" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get activity by session property", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/session-data/stats/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/session-data/values": { - "get": { - "description": "Returns custom session property values and their occurrence counts, optionally filtered by property name and data type.", - "operationId": "getSessionDataValues", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "propertyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "dataType", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "total": { - "type": "number" - }, - "value": { - "type": "string" - } - }, - "required": [ - "value", - "total" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List session property values", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/session-data/values/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/sessions": { - "get": { - "description": "Returns a page of visitor sessions in the date range, newest first. Search matches distinct ID, city, browser, operating system, or device.", - "operationId": "getWebsiteSessions", - "parameters": [ - { - "description": "Website ID.", - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "description": "Website ID.", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "endAt", - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "startDate", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "compare", - "schema": { - "enum": [ - "prev", - "yoy" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "schema": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "schema": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "schema": { - "exclusiveMinimum": 0, - "maximum": 9007199254740991, - "type": "integer" - } - }, - { - "in": "query", - "name": "excludeBounce", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "match", - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "schema": { - "exclusiveMinimum": 0, - "maximum": 9007199254740991, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "schema": { - "exclusiveMinimum": 0, - "maximum": 9007199254740991, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "schema": { - "exclusiveMinimum": 0, - "maximum": 9007199254740991, - "type": "integer" - } - }, - { - "in": "query", - "name": "search", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebsiteSessionPage" - } - } - }, - "description": "A page of sessions." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List visitor sessions", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/websites/[websiteId]/sessions/contract.ts" - } - }, - "/api/websites/{websiteId}/sessions/{sessionId}": { - "delete": { - "description": "Deletes the specified session and its associated analytics data. Available on installations using only a relational database.", - "operationId": "deleteWebsiteSession", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "sessionId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "ok": { - "const": true - } - }, - "required": [ - "ok" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Delete a visitor session", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/sessions/[sessionId]/contract.generated.ts" - }, - "get": { - "description": "Returns details for a website session, including linked visitor identities and whether session deletion is available to the caller.", - "operationId": "getWebsiteSession", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "sessionId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "canDelete": {}, - "stitchedSessionCount": {} - }, - "required": [ - "canDelete", - "stitchedSessionCount" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - }, - "404": { - "content": { - "application/json": { - "example": { - "error": { - "code": "not-found", - "message": "Not found.", - "status": 404 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Not found." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get a visitor session", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/websites/[websiteId]/sessions/[sessionId]/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/sessions/{sessionId}/activity": { - "get": { - "description": "Returns activity for the specified session and sessions linked by visitor identity, using the requested date range and optional distinct ID.", - "operationId": "getWebsiteSessionActivity", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "sessionId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "createdAt": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "date-time", - "type": "string" - } - ] - }, - "eventId": { - "type": "string" - }, - "eventName": { - "type": "string" - }, - "eventType": { - "type": "number" - }, - "hasData": { - "type": "boolean" - }, - "hostname": { - "type": "string" - }, - "referrerDomain": { - "type": "string" - }, - "urlPath": { - "type": "string" - }, - "urlQuery": { - "type": "string" - }, - "visitId": { - "type": "string" - } - }, - "required": [ - "createdAt", - "urlPath", - "urlQuery", - "referrerDomain", - "eventId", - "eventType", - "eventName", - "visitId", - "hostname", - "hasData" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get a visitor's session activity", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/websites/[websiteId]/sessions/[sessionId]/activity/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/sessions/{sessionId}/properties": { - "get": { - "description": "Returns custom property records, data types, and values for the specified website session.", - "operationId": "getWebsiteSessionProperties", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "sessionId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "properties": { - "createdAt": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "date-time", - "type": "string" - } - ] - }, - "dataKey": { - "type": "string" - }, - "dataType": { - "type": "number" - }, - "dateValue": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "date-time", - "type": "string" - } - ] - }, - "numberValue": { - "type": "number" - }, - "sessionId": { - "type": "string" - }, - "stringValue": { - "type": "string" - }, - "websiteId": { - "type": "string" - } - }, - "required": [ - "websiteId", - "sessionId", - "dataKey", - "dataType", - "stringValue", - "numberValue", - "dateValue", - "createdAt" - ], - "type": "object" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get a session's custom properties", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/websites/[websiteId]/sessions/[sessionId]/properties/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/sessions/{sessionId}/replays": { - "get": { - "description": "Returns a paginated, searchable list of recordings for the specified website session.", - "operationId": "getWebsiteSessionReplays", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "sessionId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "endAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "compare", - "required": false, - "schema": { - "enum": [ - "prev", - "yoy" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "browser": { - "type": "string" - }, - "chunkCount": { - "type": "number" - }, - "city": { - "type": "string" - }, - "country": { - "type": "string" - }, - "createdAt": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "date-time", - "type": "string" - } - ] - }, - "device": { - "type": "string" - }, - "duration": { - "type": "number" - }, - "endedAt": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "date-time", - "type": "string" - } - ] - }, - "eventCount": { - "type": "number" - }, - "id": { - "type": "string" - }, - "os": { - "type": "string" - }, - "sessionId": { - "type": "string" - }, - "startedAt": { - "anyOf": [ - { - "type": "string" - }, - { - "format": "date-time", - "type": "string" - } - ] - }, - "websiteId": { - "type": "string" - } - }, - "required": [ - "id", - "sessionId", - "websiteId", - "browser", - "os", - "device", - "country", - "city", - "eventCount", - "chunkCount", - "startedAt", - "endedAt", - "duration", - "createdAt" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List a visitor's session replays", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/sessions/[sessionId]/replays/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/sessions/stats": { - "get": { - "description": "Returns aggregate session metrics for the website over the selected date range and filters.", - "operationId": "getWebsiteSessionStats", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": {}, - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get visitor session statistics", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/websites/[websiteId]/sessions/stats/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/sessions/weekly": { - "get": { - "description": "Returns distinct visitor counts grouped by day of the week and hour in the selected timezone and date range.", - "operationId": "getWebsiteSessionsWeekly", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "timezone", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "items": { - "type": "number" - }, - "type": "array" - }, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get traffic by weekday and hour", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/sessions/weekly/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/shares": { - "get": { - "description": "Returns a paginated list of shares for the specified website.", - "operationId": "getWebsiteShares", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "excludeBounce", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "required": false, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "match", - "required": false, - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "pageSize", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "maxResults", - "required": false, - "schema": { - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "count": { - "type": "number" - }, - "data": { - "items": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "entityId": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "shareType": { - "type": "number" - }, - "slug": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "name", - "slug", - "parameters", - "entityId", - "shareType" - ], - "type": "object" - }, - "type": "array" - }, - "isCapped": { - "type": "boolean" - }, - "orderBy": { - "type": "string" - }, - "page": { - "type": "number" - }, - "pageSize": { - "type": "number" - }, - "search": { - "type": "string" - }, - "sortDescending": { - "type": "boolean" - } - }, - "required": [ - "data", - "count", - "page", - "pageSize" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List shares for a website", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/shares/contract.generated.ts" - }, - "post": { - "description": "Creates a named share for the specified website with optional parameters.", - "operationId": "createWebsiteShare", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "maxLength": 200, - "type": "string" - }, - "parameters": { - "additionalProperties": true, - "type": "object" - } - }, - "required": [ - "name" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "entityId": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "parameters": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "shareType": { - "type": "number" - }, - "slug": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "name", - "slug", - "parameters", - "entityId", - "shareType" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Create a share for a website", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/shares/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/stats": { - "get": { - "description": "Returns pageviews, unique visitors, visits, bounces, and total time on site for the selected date range and comparison period.", - "operationId": "getWebsiteStats", - "parameters": [ - { - "description": "Website ID.", - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "description": "Website ID.", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "endAt", - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "startDate", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "compare", - "schema": { - "enum": [ - "prev", - "yoy" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "path", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "referrer", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "title", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "query", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "os", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "browser", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "device", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "country", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "region", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "city", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "tag", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "hostname", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "distinctId", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "language", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "event", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmSource", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmMedium", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmCampaign", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmContent", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "utmTerm", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "segment", - "schema": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - } - }, - { - "in": "query", - "name": "cohort", - "schema": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", - "type": "string" - } - }, - { - "in": "query", - "name": "eventType", - "schema": { - "exclusiveMinimum": 0, - "maximum": 9007199254740991, - "type": "integer" - } - }, - { - "in": "query", - "name": "excludeBounce", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "match", - "schema": { - "enum": [ - "all", - "any" - ], - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebsiteStats" - } - } - }, - "description": "Summary stats with comparison." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "oauth2": [ - "analytics:read" - ] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get website summary statistics", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-oauth-scope": "analytics:read", - "x-umami-source": "src/app/api/websites/[websiteId]/stats/contract.ts" - } - }, - "/api/websites/{websiteId}/transfer": { - "post": { - "description": "Transfers the specified website to another user or team after checking permission for the destination.", - "operationId": "transferWebsite", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "teamId": { - "format": "uuid", - "type": "string" - }, - "userId": { - "format": "uuid", - "type": "string" - } - }, - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "createdAt": { - "format": "date-time", - "type": "string" - }, - "createdBy": { - "type": "string" - }, - "deletedAt": { - "format": "date-time", - "type": "string" - }, - "domain": { - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "recorderEnabled": { - "type": "boolean" - }, - "replayConfig": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "const": false - }, - { - "const": true - }, - {}, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "properties": {}, - "type": "object" - }, - { - "properties": { - "length": { - "type": "number" - } - }, - "required": [ - "length" - ], - "type": "object" - } - ] - }, - "resetAt": { - "format": "date-time", - "type": "string" - }, - "teamId": { - "type": "string" - }, - "updatedAt": { - "format": "date-time", - "type": "string" - }, - "userId": { - "type": "string" - } - }, - "required": [ - "id", - "userId", - "createdAt", - "updatedAt", - "deletedAt", - "createdBy", - "name", - "domain", - "resetAt", - "teamId", - "recorderEnabled", - "replayConfig" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - } - ], - "summary": "Transfer website ownership", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/transfer/contract.generated.ts" - } - }, - "/api/websites/{websiteId}/values": { - "get": { - "description": "Returns available values for a website filter, including saved segments or cohorts when requested, to populate filter choices.", - "operationId": "getWebsiteValues", - "parameters": [ - { - "in": "path", - "name": "websiteId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "endAt", - "required": false, - "schema": { - "type": "number" - } - }, - { - "in": "query", - "name": "startDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "in": "query", - "name": "endDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "unit", - "required": false, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "compare", - "required": false, - "schema": { - "enum": [ - "prev", - "yoy" - ], - "type": "string" - } - }, - { - "in": "query", - "name": "type", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "search", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": {}, - "type": "array" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "List website filter values", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/[websiteId]/values/contract.generated.ts" - } - }, - "/api/websites/charts": { - "get": { - "description": "Returns visitor totals and chart data for the requested websites the caller can view, within the selected date range.", - "operationId": "getWebsitesCharts", - "parameters": [ - { - "in": "query", - "name": "ids", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "startAt", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "endAt", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "in": "query", - "name": "timezone", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "data": { - "additionalProperties": { - "properties": { - "total": { - "type": "number" - }, - "values": { - "items": { - "type": "number" - }, - "type": "array" - } - }, - "required": [ - "values", - "total" - ], - "type": "object" - }, - "properties": {}, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "description": "The operation completed successfully." - }, - "400": { - "content": { - "application/json": { - "example": { - "error": { - "code": "bad-request", - "message": "Bad request.", - "status": 400 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Bad request." - }, - "401": { - "content": { - "application/json": { - "example": { - "error": { - "code": "unauthorized", - "message": "Unauthorized.", - "status": 401 - } - }, - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - }, - "description": "Unauthorized." - } - }, - "security": [ - { - "bearerAuth": [] - }, - { - "shareContext": [], - "shareToken": [] - } - ], - "summary": "Get visitor charts for websites", - "tags": [ - "Websites" - ], - "x-umami-audience": "public", - "x-umami-contract": "explicit", - "x-umami-source": "src/app/api/websites/charts/contract.generated.ts" - } - } - }, - "tags": [ - { - "name": "Account" - }, - { - "name": "Administration" - }, - { - "name": "Authentication" - }, - { - "name": "Boards" - }, - { - "name": "Collection" - }, - { - "name": "Configuration" - }, - { - "name": "Dashboard" - }, - { - "name": "Links" - }, - { - "name": "OAuth" - }, - { - "name": "Pixels" - }, - { - "name": "Realtime" - }, - { - "name": "Reports" - }, - { - "name": "Scripts" - }, - { - "name": "Shares" - }, - { - "name": "System" - }, - { - "name": "Teams" - }, - { - "name": "Two-factor authentication" - }, - { - "name": "Users" - }, - { - "name": "Websites" - } - ] -} diff --git a/src/openapi/README.md b/src/openapi/README.md index 86888760a..e96aa5620 100644 --- a/src/openapi/README.md +++ b/src/openapi/README.md @@ -4,6 +4,9 @@ Umami generates `public/openapi.json` for every App Router API handler. It stati baseline contract from route source and replaces that baseline with a colocated, Zod-backed contract wherever one exists. +`public/openapi.json` is an ignored build artifact and must not be committed. Generate it locally +with `pnpm openapi:generate` before running checks or generating the API client. + ## Commands - `pnpm openapi:generate` regenerates the public OpenAPI document. @@ -14,8 +17,8 @@ contract wherever one exists. contract. - `pnpm openapi:check --verbose` lists operations that still use inferred contracts. -The normal and Docker builds run the generator before the Next.js build. CI runs the check before -tests and build steps. +The normal and Docker builds run the generator before the Next.js build. CI generates the artifact +and runs the check before tests and build steps. ## Adding an operation @@ -68,6 +71,14 @@ Run `pnpm generate:api` after editing to refresh the OpenAPI document and API cl `pnpm openapi:check` reject entries that do not match a discovered route and method. Entries are optional, so documentation can be improved incrementally. +Field documentation lives in `src/openapi/field-descriptions.ts`. The document builder fills missing +query/path parameter and request/response property descriptions after converting contracts to +OpenAPI, including nested schemas and shared components. Existing contract descriptions take +precedence. Keep shared wording limited to fields with consistent meanings; use endpoint-specific +wording for fields such as the dashboard's `parameters`. Unknown fields are left undocumented +rather than given an automatically generated label. Examples and schema validation rules are not +modified. Run `pnpm generate:api` after editing this file as well. + ## Operation IDs Operation IDs are public: they become method names in `@umami/api-client`. Routes with a curated diff --git a/src/openapi/document.ts b/src/openapi/document.ts index 8058d11ad..94da40cb8 100644 --- a/src/openapi/document.ts +++ b/src/openapi/document.ts @@ -9,6 +9,7 @@ import { getCoverageErrors, } from '@/openapi/coverage'; import { discoverApiOperations } from '@/openapi/discover'; +import { applyFieldDescriptions } from '@/openapi/field-descriptions'; import { inferApiContracts } from '@/openapi/infer'; import { type ApiAudience, type ApiOperationContract, getOperationKey } from '@/openapi/operation'; import { operationDescriptions } from '@/openapi/operation-descriptions'; @@ -147,5 +148,7 @@ export async function buildOpenApiDocument( }, ); + applyFieldDescriptions(document); + return { document, coverage }; } diff --git a/src/openapi/field-descriptions.test.ts b/src/openapi/field-descriptions.test.ts new file mode 100644 index 000000000..1d38a58de --- /dev/null +++ b/src/openapi/field-descriptions.test.ts @@ -0,0 +1,111 @@ +import { describe, expect, it } from 'vitest'; +import type { createDocument } from 'zod-openapi'; +import { applyFieldDescriptions } from './field-descriptions'; + +function documentWithSchema(schema: Record) { + return { + openapi: '3.1.0', + info: { title: 'Test', version: '1' }, + paths: { + '/api/dashboard': { + get: { + responses: { + '200': { + description: 'Success', + content: { 'application/json': { schema } }, + }, + }, + }, + }, + }, + } satisfies ReturnType; +} + +describe('OpenAPI field descriptions', () => { + it('documents dashboard fields without changing their schemas or example payloads', () => { + const schema = { + type: 'object', + properties: { + id: { type: 'string' }, + name: { type: 'string', description: 'Custom dashboard name.' }, + parameters: { anyOf: [{ type: 'object' }, { type: 'null' }] }, + createdAt: { type: 'string', format: 'date-time' }, + }, + required: ['id', 'name', 'parameters', 'createdAt'], + example: { properties: { id: { type: 'string' } } }, + }; + const original = structuredClone(schema); + const document = documentWithSchema(schema); + applyFieldDescriptions(document); + + expect(schema).toEqual({ + ...original, + properties: { + id: { type: 'string', description: 'Dashboard board ID, equal to the owning user ID.' }, + name: original.properties.name, + parameters: { + ...original.properties.parameters, + description: 'Dashboard configuration, including components, layout, and saved reports.', + }, + createdAt: { + ...original.properties.createdAt, + description: 'Date and time the record was created.', + }, + }, + }); + const once = structuredClone(document); + applyFieldDescriptions(document); + expect(document).toEqual(once); + }); + + it('traverses nested schemas and components while preserving references and unknown fields', () => { + const nested = { + properties: { + userId: { type: 'string' }, + unknownField: { type: 'string' }, + }, + }; + const reference = { $ref: '#/components/schemas/User' }; + const schema = { + allOf: [ + { type: 'array', items: { oneOf: [nested, reference] } }, + { additionalProperties: { anyOf: [structuredClone(nested)] } }, + ], + }; + const document = { + ...documentWithSchema(schema), + components: { schemas: { User: { properties: { username: { type: 'string' as const } } } } }, + }; + applyFieldDescriptions(document); + expect(nested.properties.userId).toHaveProperty('description'); + expect(nested.properties.unknownField).not.toHaveProperty('description'); + expect(reference).toEqual({ $ref: '#/components/schemas/User' }); + expect(document.components.schemas.User.properties.username).toHaveProperty('description'); + expect(schema.allOf[1].additionalProperties.anyOf[0].properties.userId).toHaveProperty( + 'description', + ); + }); + + it('fills query and path descriptions while respecting curated parameter and schema wording', () => { + const parameters = [ + { name: 'startAt', in: 'query' as const, schema: { type: 'number' as const } }, + { name: 'boardId', in: 'path' as const, required: true, schema: { type: 'string' as const } }, + { + name: 'type', + in: 'query' as const, + schema: { type: 'string' as const, description: 'Dimension to rank.' }, + }, + { name: 'page', in: 'query' as const, description: 'Curated page description.' }, + ]; + const document = documentWithSchema({}); + Object.assign(document.paths['/api/dashboard'].get, { parameters }); + applyFieldDescriptions(document); + expect(parameters[0]).toHaveProperty( + 'description', + 'Start of the date range as a Unix timestamp in milliseconds.', + ); + expect(parameters[1]).toHaveProperty('description', 'ID of the board.'); + expect(parameters[2]).toHaveProperty('description', 'Dimension to rank.'); + expect(parameters[3]).toHaveProperty('description', 'Curated page description.'); + }); +}); diff --git a/src/openapi/field-descriptions.ts b/src/openapi/field-descriptions.ts new file mode 100644 index 000000000..782a4d7d7 --- /dev/null +++ b/src/openapi/field-descriptions.ts @@ -0,0 +1,304 @@ +import type { createDocument } from 'zod-openapi'; + +// Shared wording only belongs here when a field has the same meaning across endpoints. +// More specific descriptions in contracts always take precedence. +const fieldDescriptions: Record = { + id: 'Unique identifier of the resource.', + name: 'Display name of the resource.', + description: 'Description of the resource.', + parameters: 'Configuration parameters for the resource.', + createdAt: 'Date and time the record was created.', + updatedAt: 'Date and time the record was last updated.', + deletedAt: 'Date and time the record was deleted, if applicable.', + resetAt: 'Date and time the website analytics were last reset.', + createdBy: 'ID of the user who created the resource.', + userId: 'ID of the associated user.', + teamId: 'ID of the associated team.', + websiteId: 'ID of the website.', + boardId: 'ID of the board.', + linkId: 'ID of the tracked link.', + pixelId: 'ID of the tracking pixel.', + reportId: 'ID of the saved report.', + sessionId: 'ID of the visitor session.', + eventId: 'ID of the event.', + websiteEventId: 'ID of the website event.', + annotationId: 'ID of the annotation.', + segmentId: 'ID of the saved segment or cohort.', + replayId: 'ID of the session replay.', + shareId: 'Identifier used to access a shared resource.', + keyId: 'ID of the API key.', + visitId: 'ID of the visit.', + entityId: 'ID of the resource being shared.', + slug: 'URL slug used to access the resource.', + username: 'Username of the account.', + user: 'User associated with the resource.', + team: 'Team associated with the resource.', + teams: 'Teams associated with the user.', + members: 'Members of the team.', + createUser: 'User who created the resource.', + boards: 'Boards associated with the user.', + links: 'Tracked links associated with the user.', + pixels: 'Tracking pixels associated with the user.', + reports: 'Saved reports associated with the user.', + apiKeys: 'API keys associated with the user.', + password: 'Password used to authenticate the account.', + currentPassword: 'Current account password.', + newPassword: 'New password to set for the account.', + isAdmin: 'Whether the user has administrator privileges.', + role: 'Permission role assigned to the user.', + accessCode: 'Code used to join the team.', + logoUrl: 'URL of the logo image.', + domain: 'Domain name associated with the resource.', + url: 'URL associated with the resource.', + page: 'Page number, starting at 1.', + pageSize: 'Number of results per page.', + maxResults: 'Maximum number of results to include.', + limit: 'Maximum number of rows to return.', + offset: 'Number of rows to skip before returning results.', + orderBy: 'Field to sort the results by.', + sortDescending: 'Whether to sort results in descending order.', + search: 'Search text used to filter results.', + isCapped: 'Whether the results were truncated by the maximum result limit.', + data: 'Data returned by the operation.', + count: 'Number of matching records.', + startAt: 'Start of the date range as a Unix timestamp in milliseconds.', + endAt: 'End of the date range as a Unix timestamp in milliseconds.', + startDate: 'Start of the date range as an ISO 8601 date or date-time.', + endDate: 'End of the date range as an ISO 8601 date or date-time.', + timezone: + 'IANA time zone used to interpret dates and group results, for example America/New_York.', + unit: 'Time interval used to group results: minute, hour, day, month, or year.', + filters: 'Filters applied to the analytics data.', + match: 'Whether records must match all filters or any filter.', + segment: 'ID of a saved segment used to filter results.', + cohort: 'ID of a saved cohort used to filter visitors.', + excludeBounce: 'Set a non-empty value to exclude visits with only one pageview.', + hostname: 'Hostname on which the activity occurred.', + browser: 'Browser used by the visitor.', + os: 'Operating system used by the visitor.', + device: 'Device category used by the visitor.', + screen: 'Screen resolution of the visitor device.', + language: 'Preferred language reported by the visitor browser.', + country: 'Country code of the visitor.', + region: 'Region or subdivision of the visitor.', + city: 'City of the visitor.', + distinctId: 'Custom identifier assigned to the visitor.', + urlPath: 'Path portion of the page URL.', + urlQuery: 'Query string portion of the page URL.', + referrerDomain: 'Domain of the referring page.', + referrer: 'URL of the referring page.', + title: 'Title of the page.', + pageTitle: 'Title of the page.', + eventName: 'Name of the custom event.', + eventType: 'Event type: 1 for a pageview or 2 for a custom event.', + tag: 'Tag attached to the tracked activity.', + utmSource: 'UTM campaign source.', + utmMedium: 'UTM campaign medium.', + utmCampaign: 'UTM campaign name.', + utmContent: 'UTM campaign content.', + utmTerm: 'UTM campaign search term.', + pageviews: 'Pageview counts for the selected period.', + visitors: 'Unique visitor counts for the selected period.', + visits: 'Visit counts for the selected period.', + views: 'Pageview counts for the selected period.', + bounces: 'Number of visits with only one pageview.', + totaltime: 'Total visit duration in seconds.', + firstAt: 'Date and time of the first recorded activity.', + lastAt: 'Date and time of the most recent recorded activity.', + comparison: 'Analytics for the comparison period.', + uniqueEvents: 'Number of unique events.', + average: 'Arithmetic mean of the numeric property values.', + median: 'Median of the numeric property values.', + min: 'Minimum numeric property value.', + max: 'Maximum numeric property value.', + currency: 'Currency code used for revenue values.', + propertyName: 'Name of the custom event or session property.', + propertyValue: 'Value of the custom property.', + propertyKeys: 'Names of the custom properties.', + propertyValues: 'Values of the custom properties.', + dataKey: 'Name of the custom property.', + dataType: 'Data type of the custom property.', + stringValue: 'Custom property value stored as a string.', + numberValue: 'Custom property value stored as a number.', + dateValue: 'Custom property value stored as a date-time.', + eventProperties: 'Custom properties recorded with the event.', + minDuration: 'Minimum replay duration in seconds.', + startedAt: 'Date and time the recording started.', + endedAt: 'Date and time the recording ended.', + chunkCount: 'Number of stored recording chunks.', + eventCount: 'Number of recorded replay events.', + isSaved: 'Whether the replay has been saved.', + duration: 'Replay duration in milliseconds.', + viewportW: 'Viewport width in pixels.', + viewportH: 'Viewport height in pixels.', + pageW: 'Page width in pixels.', + pageH: 'Page height in pixels.', + pageX: 'Horizontal position on the page in pixels.', + pageY: 'Vertical position on the page in pixels.', + recorderEnabled: 'Whether recording is enabled for the website.', + replayConfig: 'Session replay and heatmap recording configuration.', + replayEnabled: 'Whether session replay recording is enabled.', + heatmapEnabled: 'Whether heatmap recording is enabled.', + sampleRate: 'Fraction of sessions to record for replay, from 0 to 1.', + heatmapSampleRate: 'Fraction of sessions to record for heatmaps, from 0 to 1.', + maskLevel: 'Privacy masking level used by the recorder: strict or moderate.', + blockSelector: 'CSS selector for elements excluded from recordings.', + allDay: 'Whether the annotation applies to the entire day.', + note: 'Text of the annotation.', + apiKey: 'API key authentication details.', + keyPrefix: 'Visible prefix used to identify an API key.', + lastUsedAt: 'Date and time the credential was last used.', + expiresAt: 'Date and time the credential expires.', + revokedAt: 'Date and time the credential was revoked.', + usedAt: 'Date and time the code was used.', + backupCode: 'Single-use backup code for two-factor authentication.', + backupCodes: 'Single-use backup codes for two-factor authentication.', + twoFactorRequired: 'Whether two-factor authentication is required.', + requiresTwoFactor: 'Whether login requires a second authentication factor.', + isEnabled: 'Whether two-factor authentication is enabled.', + isConfigured: 'Whether two-factor authentication has been configured.', + isRequired: 'Whether two-factor authentication is required for this user.', + globalRequired: 'Whether two-factor authentication is required for all users.', + requiredReason: 'Reason two-factor authentication is required.', + partialToken: 'Temporary login token used to complete two-factor authentication.', + manualKey: 'Secret key for manually configuring an authenticator app.', + qrCodeDataUrl: 'Data URL of the QR code for authenticator setup.', + lockedUntil: 'Time until which further authentication attempts are blocked.', + error: 'Error details returned when the operation fails.', + message: 'Human-readable explanation of the result.', + ok: 'Whether the operation succeeded.', + client_id: 'OAuth client identifier.', + client_name: 'Human-readable name of the OAuth client.', + client_uri: 'URL of the OAuth client homepage.', + logo_uri: 'URL of the OAuth client logo.', + redirect_uri: 'Registered redirect URI to receive the authorization response.', + redirect_uris: 'Redirect URIs registered for the OAuth client.', + response_type: 'OAuth authorization response type; use code.', + response_types: 'Authorization response types supported by the client.', + code_challenge: 'PKCE challenge derived from the code verifier.', + code_challenge_method: 'Method used to derive the PKCE challenge; use S256.', + code_verifier: 'Original PKCE verifier used to obtain the authorization code.', + scope: 'Space-separated OAuth permissions.', + resource: 'Resource URI identifying the API targeted by the OAuth request.', + state: 'Client-provided value returned unchanged to correlate the authorization response.', + access_token: 'OAuth access token used to authorize API requests.', + refresh_token: 'OAuth refresh token used to obtain a new access token.', + token_type: 'Authorization scheme for the access token.', + expires_in: 'Access token lifetime in seconds.', + grant_type: 'OAuth grant used to obtain or refresh an access token.', + grant_types: 'OAuth grant types supported by the client.', + token_endpoint_auth_method: 'Client authentication method used at the token endpoint.', + token_type_hint: 'Hint indicating whether the revoked token is an access or refresh token.', + error_description: 'Human-readable explanation of the OAuth error.', + shareType: 'Type of resource made available by the share.', +}; + +const queryDescriptions: Record = { + compare: 'Comparison period: prev for the previous period or yoy for the same period last year.', + ids: 'Comma-separated resource IDs. Provide between 1 and 20 IDs.', + includeTeams: 'Set a non-empty value to include websites accessible through team membership.', + type: 'Type of resource or analytics dimension to return.', + metric: 'Numeric aggregation to calculate for the selected property.', + path: 'Filter by page URL path.', + referrer: 'Filter by referring URL.', + title: 'Filter by page title.', + query: 'Filter by page URL query string.', + event: 'Filter by custom event name.', +}; + +const dashboardDescriptions: Record = { + id: 'Dashboard board ID, equal to the owning user ID.', + name: 'Display name of the dashboard.', + description: 'Description of the dashboard.', + parameters: 'Dashboard configuration, including components, layout, and saved reports.', + userId: 'ID of the user who owns the dashboard.', + teamId: 'ID of the associated team, if any.', + type: 'Board type used for the dashboard.', +}; + +type JsonObject = Record; + +function isObject(value: unknown): value is JsonObject { + return !!value && typeof value === 'object' && !Array.isArray(value); +} + +function describeSchema(value: unknown, overrides: Record = {}) { + if (!isObject(value)) return; + + if (isObject(value.properties)) { + for (const [name, property] of Object.entries(value.properties)) { + if (!isObject(property)) continue; + const description = overrides[name] ?? fieldDescriptions[name]; + if (!property.description && description) property.description = description; + describeSchema(property); + } + } + + for (const keyword of ['items', 'additionalProperties', 'not', 'if', 'then', 'else']) { + describeSchema(value[keyword]); + } + for (const keyword of ['allOf', 'anyOf', 'oneOf', 'prefixItems']) { + const schemas = value[keyword]; + if (Array.isArray(schemas)) { + schemas.forEach(schema => { + describeSchema(schema, overrides); + }); + } + } +} + +// Visit only OpenAPI containers and schema keywords, never example/default payloads. +function describeContent(value: unknown, overrides: Record = {}) { + if (!isObject(value)) return; + if (isObject(value.content)) { + for (const media of Object.values(value.content)) { + if (isObject(media)) describeSchema(media.schema, overrides); + } + } +} + +function describeParameters(value: unknown) { + if (!Array.isArray(value)) return; + for (const parameter of value) { + if (!isObject(parameter) || typeof parameter.name !== 'string') continue; + const schema = isObject(parameter.schema) ? parameter.schema : undefined; + const description = + schema?.description ?? + (parameter.in === 'query' ? queryDescriptions[parameter.name] : undefined) ?? + fieldDescriptions[parameter.name]; + if (!parameter.description && description) parameter.description = description; + describeSchema(schema); + describeContent(parameter); + } +} + +export function applyFieldDescriptions(document: ReturnType) { + for (const [path, pathItem] of Object.entries(document.paths ?? {})) { + if (!isObject(pathItem)) continue; + describeParameters(pathItem.parameters); + for (const method of ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']) { + const operation = pathItem[method]; + if (!isObject(operation)) continue; + const overrides = path === '/api/dashboard' ? dashboardDescriptions : {}; + describeParameters(operation.parameters); + describeContent(operation.requestBody, overrides); + if (isObject(operation.responses)) { + Object.values(operation.responses).forEach(response => { + describeContent(response, overrides); + }); + } + } + } + + const components = document.components; + Object.values(components?.schemas ?? {}).forEach(schema => { + describeSchema(schema); + }); + Object.values(components?.responses ?? {}).forEach(response => { + describeContent(response); + }); + Object.values(components?.requestBodies ?? {}).forEach(body => { + describeContent(body); + }); + describeParameters(Object.values(components?.parameters ?? {})); +}