// This file is auto-generated by @hey-api/openapi-ts /** * The error information */ export type error_BAD_REQUEST = { /** * The error message */ message: string; /** * The error code */ code: string; /** * An array of issues that were responsible for the error */ issues?: Array<{ message: string; }>; }; /** * The error information */ export type error_UNAUTHORIZED = { /** * The error message */ message: string; /** * The error code */ code: string; /** * An array of issues that were responsible for the error */ issues?: Array<{ message: string; }>; }; /** * The error information */ export type error_FORBIDDEN = { /** * The error message */ message: string; /** * The error code */ code: string; /** * An array of issues that were responsible for the error */ issues?: Array<{ message: string; }>; }; /** * The error information */ export type error_INTERNAL_SERVER_ERROR = { /** * The error message */ message: string; /** * The error code */ code: string; /** * An array of issues that were responsible for the error */ issues?: Array<{ message: string; }>; }; /** * The error information */ export type error_NOT_FOUND = { /** * The error message */ message: string; /** * The error code */ code: string; /** * An array of issues that were responsible for the error */ issues?: Array<{ message: string; }>; }; export type $OpenApiTs = { '/ai/classifySurvey': { post: { req: { requestBody: { workspaceId: string; surveyId: string; startAt: number; endAt: number; runStrategy: 'skipExist' | 'skipInSuggest' | 'rebuildAll'; languageStrategy?: 'default' | 'user'; payloadContentField: string; suggestionCategory: Array<(string)>; }; }; res: { /** * Successful response */ 200: 'ok'; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/ai/translateSurvey': { post: { req: { requestBody: { workspaceId: string; surveyId: string; startAt: number; endAt: number; runStrategy: 'skipExist' | 'rebuildAll'; languageStrategy?: 'default' | 'user'; payloadContentField: string; }; }; res: { /** * Successful response */ 200: 'ok'; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/aiGateway/info': { get: { req: { gatewayId: string; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; modelApiKey?: string | null; customModelBaseUrl?: string | null; customModelName?: string | null; customModelInputPrice?: number | null; customModelOutputPrice?: number | null; createdAt: string; updatedAt: string; } | null; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/aiGateway/update': { patch: { req: { requestBody: { workspaceId: string; gatewayId: string; name: string; modelApiKey: string | null; customModelBaseUrl: string | null; customModelName: string | null; customModelInputPrice: number | null; customModelOutputPrice: number | null; }; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; modelApiKey?: string | null; customModelBaseUrl?: string | null; customModelName?: string | null; customModelInputPrice?: number | null; customModelOutputPrice?: number | null; createdAt: string; updatedAt: string; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/aiGateway/delete': { delete: { req: { gatewayId: string; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; modelApiKey?: string | null; customModelBaseUrl?: string | null; customModelName?: string | null; customModelInputPrice?: number | null; customModelOutputPrice?: number | null; createdAt: string; updatedAt: string; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/aiGateway/logs': { get: { req: { cursor?: string; gatewayId: string; limit?: number; workspaceId: string; }; res: { /** * Successful response */ 200: { items: Array<{ id: string; workspaceId: string; gatewayId: string; inputToken: number; outputToken: number; stream: boolean; modelName: string; status: 'Pending' | 'Success' | 'Failed'; duration: number; ttft: number; price: number; userId?: string | null; createdAt: string; updatedAt: string; requestPayload?: unknown; responsePayload?: unknown; }>; nextCursor?: string; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/aiGateway/all': { get: { req: { workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ id: string; workspaceId: string; name: string; modelApiKey?: string | null; customModelBaseUrl?: string | null; customModelName?: string | null; customModelInputPrice?: number | null; customModelOutputPrice?: number | null; createdAt: string; updatedAt: string; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/aiGateway/create': { post: { req: { requestBody: { name: string; modelApiKey: string | null; customModelBaseUrl: string | null; customModelName: string | null; customModelInputPrice: number | null; customModelOutputPrice: number | null; }; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; modelApiKey?: string | null; customModelBaseUrl?: string | null; customModelName?: string | null; customModelInputPrice?: number | null; customModelOutputPrice?: number | null; createdAt: string; updatedAt: string; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/application/all': { get: { req: { workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ id: string; workspaceId: string; name: string; createdAt: string; updatedAt: string; deletedAt?: string | null; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/application/{applicationId}/info': { get: { req: { applicationId: string; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; createdAt: string; updatedAt: string; deletedAt?: string | null; applicationStoreInfos: Array<{ applicationId: string; storeType: string; storeId: string; appId: string; title: string; description: string; releaseNotes: string; url: string; downloads?: number | null; score?: number | null; ratingCount?: number | null; reviews?: number | null; version?: string | null; size?: number | null; createdAt: string; updatedAt: string; }>; } | null; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/application/create': { post: { req: { requestBody: { name: string; appstoreId?: string; playstoreId?: string; }; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; createdAt: string; updatedAt: string; deletedAt: string | null; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/application/{applicationId}/update': { patch: { req: { applicationId: string; requestBody: { name: string; appstoreId?: string; playstoreId?: string; }; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; createdAt: string; updatedAt: string; deletedAt: string | null; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/application/{applicationId}/delete': { delete: { req: { applicationId: string; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; createdAt: string; updatedAt: string; deletedAt: string | null; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/application/storeAppSearch': { get: { req: { keyword: string; storeType: 'appstore' | 'googleplay'; workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ id?: string; appId: string; title: string; icon: string; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/application/{applicationId}/storeInfoHistory': { get: { req: { applicationId: string; endAt: number; startAt: number; storeId?: string; storeType: 'appstore' | 'googleplay'; workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ downloads?: number | null; score?: number | null; ratingCount?: number | null; reviews?: number | null; size?: number | null; createdAt: string; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/application/{applicationId}/eventStats': { get: { req: { applicationId: string; endAt: number; startAt: number; timezone?: string; unit?: 'minute' | 'hour' | 'day' | 'month' | 'year'; workspaceId: string; }; res: { /** * Successful response */ 200: { current: Array<{ date: string; eventCount: number; sessionCount: number; totalTime: number; avgEventsPerSession: number; avgScreensPerSession: number; }>; previous: Array<{ date: string; eventCount: number; sessionCount: number; totalTime: number; avgEventsPerSession: number; avgScreensPerSession: number; }>; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/global/config': { get: { res: { /** * Successful response */ 200: { allowRegister: boolean; websiteId?: string; amapToken?: string; mapboxToken?: string; alphaMode: boolean; disableAnonymousTelemetry: boolean; customTrackerScriptName?: string; authProvider: Array<(string)>; enableBilling: boolean; enableAI: boolean; }; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/login': { post: { req: { requestBody: { username: string; password: string; }; }; res: { /** * Successful response */ 200: { info: { id: string; role: string; username: string; nickname: string | null; avatar: string | null; email: string | null; createdAt: string; updatedAt: string; deletedAt: string | null; currentWorkspaceId: string | null; workspaces: Array<{ role: string; workspace: { id: string; name: string; settings: { [key: string]: unknown; }; paused: boolean; }; }>; }; token: string; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/loginWithToken': { post: { req: { requestBody: { token: string; }; }; res: { /** * Successful response */ 200: { info: { id: string; role: string; username: string; nickname: string | null; avatar: string | null; email: string | null; createdAt: string; updatedAt: string; deletedAt: string | null; currentWorkspaceId: string | null; workspaces: Array<{ role: string; workspace: { id: string; name: string; settings: { [key: string]: unknown; }; paused: boolean; }; }>; }; token: string; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/create': { post: { req: { requestBody: { name: string; }; }; res: { /** * Successful response */ 200: { id: string; role: string; username: string; nickname: string | null; avatar: string | null; email: string | null; createdAt: string; updatedAt: string; deletedAt: string | null; currentWorkspaceId: string | null; workspaces: Array<{ role: string; workspace: { id: string; name: string; settings: { [key: string]: unknown; }; paused: boolean; }; }>; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/switch': { post: { req: { requestBody: { workspaceId: string; }; }; res: { /** * Successful response */ 200: { id: string; role: string; username: string; nickname: string | null; avatar: string | null; email: string | null; createdAt: string; updatedAt: string; deletedAt: string | null; currentWorkspaceId: string | null; workspaces: Array<{ role: string; workspace: { id: string; name: string; settings: { [key: string]: unknown; }; paused: boolean; }; }>; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/rename': { patch: { req: { requestBody: { workspaceId: string; name: string; }; }; res: { /** * Successful response */ 200: { id: string; name: string; settings: { [key: string]: unknown; }; paused: boolean; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/del': { delete: { req: { workspaceId: string; }; res: { /** * Successful response */ 200: unknown; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/members': { get: { req: { workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ userId: string; workspaceId: string; role: string; createdAt: string; updatedAt: string; user: { username: string; nickname: string | null; email: string | null; emailVerified: string | null; }; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/updateSettings': { post: { req: { requestBody: { settings: { [key: string]: unknown; }; }; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; name: string; settings: { [key: string]: unknown; }; paused: boolean; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/invite': { post: { req: { requestBody: { emailOrId: string; role?: 'admin' | 'readOnly'; }; workspaceId: string; }; res: { /** * Successful response */ 200: unknown; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/tick': { delete: { req: { targetUserId: string; workspaceId: string; }; res: { /** * Successful response */ 200: unknown; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/updateMemberRole': { patch: { req: { requestBody: { userId: string; role: 'owner' | 'admin' | 'readOnly'; }; workspaceId: string; }; res: { /** * Successful response */ 200: unknown; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/getServiceCount': { get: { req: { workspaceId: string; }; res: { /** * Successful response */ 200: { website: number; application: number; monitor: number; server: number; telemetry: number; page: number; survey: number; feed: number; aiGateway: number; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/website/{websiteId}/onlineCount': { get: { req: { websiteId: string; workspaceId: string; }; res: { /** * Successful response */ 200: number; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/website/all': { get: { req: { workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ id: string; workspaceId: string; name: string; domain: string | null; shareId: string | null; resetAt: string | null; monitorId: string | null; createdAt: string; updatedAt: string; deletedAt: string | null; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/website/allOverview': { get: { req: { workspaceId: string; }; res: { /** * Successful response */ 200: { [key: string]: (number); }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/website/{websiteId}/info': { get: { req: { websiteId: string; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; domain: string | null; shareId: string | null; resetAt: string | null; monitorId: string | null; createdAt: string; updatedAt: string; deletedAt: string | null; } | null; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/website/{websiteId}/stats': { get: { req: { browser?: string; city?: string; country?: string; device?: string; endAt: number; os?: string; referrer?: string; region?: string; startAt: number; timezone?: string; title?: string; unit?: string; url?: string; websiteId: string; workspaceId: string; }; res: { /** * Successful response */ 200: { pageviews: { value: number; prev: number; }; uniques: { value: number; prev: number; }; totaltime: { value: number; prev: number; }; bounces: { value: number; prev: number; }; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/website/{websiteId}/geoStats': { get: { req: { endAt: number; startAt: number; websiteId: string; workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ longitude: number; latitude: number; count: number; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/website/{websiteId}/pageviews': { get: { req: { browser?: string; city?: string; country?: string; device?: string; endAt: number; os?: string; referrer?: string; region?: string; startAt: number; timezone?: string; title?: string; unit?: string; url?: string; websiteId: string; workspaceId: string; }; res: { /** * Successful response */ 200: { pageviews?: unknown; sessions?: unknown; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/website/{websiteId}/metrics': { get: { req: { browser?: string; city?: string; country?: string; device?: string; endAt: number; event?: string; language?: string; os?: string; referrer?: string; region?: string; startAt: number; title?: string; type: 'url' | 'language' | 'referrer' | 'title' | 'browser' | 'os' | 'device' | 'country' | 'event'; url?: string; websiteId: string; workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ x: string | null; y: number; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/website/add': { post: { req: { requestBody: { name: string; domain: string; }; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; domain: string | null; shareId: string | null; resetAt: string | null; monitorId: string | null; createdAt: string; updatedAt: string; deletedAt: string | null; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/website/{websiteId}': { delete: { req: { websiteId: string; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; domain: string | null; shareId: string | null; resetAt: string | null; monitorId: string | null; createdAt: string; updatedAt: string; deletedAt: string | null; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/website/{websiteId}/update': { put: { req: { requestBody: { name: string; domain: string; monitorId?: string | null; }; websiteId: string; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; domain: string | null; shareId: string | null; resetAt: string | null; monitorId: string | null; createdAt: string; updatedAt: string; deletedAt: string | null; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/website/{websiteId}/generateLighthouseReport': { post: { req: { requestBody: { url: string; }; websiteId: string; workspaceId: string; }; res: { /** * Successful response */ 200: string; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/website/{websiteId}/getLighthouseReport': { get: { req: { cursor?: string; limit?: number; websiteId: string; workspaceId: string; }; res: { /** * Successful response */ 200: { items: Array<{ id: string; status: 'Pending' | 'Success' | 'Failed'; url: string; createdAt: string; }>; nextCursor?: string; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/lighthouse/{lighthouseId}': { get: { req: { lighthouseId: string; }; res: { /** * Successful response */ 200: { [key: string]: unknown; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/monitor/all': { get: { req: { workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ id: string; workspaceId: string; name: string; type: string; active: boolean; interval: number; maxRetries: number; payload: { [key: string]: unknown; }; trendingMode: boolean; recentError?: string | null; createdAt: string; updatedAt: string; notifications: Array<{ id: string; }>; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/monitor/{monitorId}/get': { get: { req: { monitorId: string; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; type: string; active: boolean; interval: number; maxRetries: number; payload: { [key: string]: unknown; }; trendingMode: boolean; recentError?: string | null; createdAt: string; updatedAt: string; notifications: Array<{ id: string; }>; } | null; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/monitor/getPublicInfo': { post: { req: { requestBody: { monitorIds: Array<(string)>; }; }; res: { /** * Successful response */ 200: Array<{ id: string; name: string; type: string; trendingMode: boolean; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/monitor/upsert': { post: { req: { requestBody: { id?: string; name: string; type: string; active?: boolean; interval?: number; maxRetries?: number; trendingMode?: boolean; notificationIds?: Array<(string)>; payload: { [key: string]: unknown; }; }; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; type: string; active: boolean; interval: number; maxRetries: number; payload: { [key: string]: unknown; }; trendingMode: boolean; recentError?: string | null; createdAt: string; updatedAt: string; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/monitor/{monitorId}/del': { delete: { req: { monitorId: string; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; type: string; active: boolean; interval: number; maxRetries: number; payload: { [key: string]: unknown; }; trendingMode: boolean; recentError?: string | null; createdAt: string; updatedAt: string; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/monitor/{monitorId}/regeneratePushToken': { post: { req: { monitorId: string; workspaceId: string; }; res: { /** * Successful response */ 200: string; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/monitor/{monitorId}/data': { get: { req: { endAt: number; monitorId: string; startAt: number; workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ value: number; createdAt: string; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/monitor/{monitorId}/changeActive': { patch: { req: { monitorId: string; requestBody: { active: boolean; }; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; type: string; active: boolean; interval: number; maxRetries: number; payload: { [key: string]: unknown; }; trendingMode: boolean; recentError?: string | null; createdAt: string; updatedAt: string; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/monitor/{monitorId}/recentData': { get: { req: { monitorId: string; take: number; workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ value: number; createdAt: string; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/monitor/{monitorId}/publicSummary': { get: { req: { monitorId: string; workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ day: string; totalCount: number; upCount: number; upRate: number; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/monitor/{monitorId}/publicData': { get: { req: { monitorId: string; workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ value: number; createdAt: string; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/monitor/{monitorId}/dataMetrics': { get: { req: { monitorId: string; workspaceId: string; }; res: { /** * Successful response */ 200: { recent1DayAvg: number; recent1DayOnlineCount: number; recent1DayOfflineCount: number; recent30DayOnlineCount: number; recent30DayOfflineCount: number; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/monitor/events': { get: { req: { limit?: number; monitorId?: string; workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ id: string; message: string; monitorId: string; type: string; createdAt: string; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/monitor/clearEvents': { delete: { req: { monitorId: string; workspaceId: string; }; res: { /** * Successful response */ 200: number; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/monitor/clearData': { delete: { req: { monitorId: string; workspaceId: string; }; res: { /** * Successful response */ 200: number; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/monitor/{monitorId}/status': { get: { req: { monitorId: string; statusName: string; workspaceId: string; }; res: { /** * Successful response */ 200: { monitorId: string; statusName: string; payload: null | { [key: string]: unknown; } | Array | string | boolean | number; createdAt: string; updatedAt: string; } | null; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/monitor/getAllPages': { get: { req: { workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ id: string; workspaceId: string; slug: string; title: string; description: string; body: { [key: string]: unknown; }; monitorList: Array<{ id: string; showCurrent?: boolean; }>; domain?: string | null; createdAt: string; updatedAt: string; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/monitor/getPageInfo': { get: { req: { slug: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; slug: string; title: string; description: string; body: { [key: string]: unknown; }; monitorList: Array<{ id: string; showCurrent?: boolean; }>; domain?: string | null; createdAt: string; updatedAt: string; } | null; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/monitor/createStatusPage': { post: { req: { requestBody: { slug: string; title: string; description?: string; body?: { [key: string]: unknown; }; monitorList?: Array<{ id: string; showCurrent?: boolean; }>; domain?: string | null; }; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; slug: string; title: string; description: string; body: { [key: string]: unknown; }; monitorList: Array<{ id: string; showCurrent?: boolean; }>; domain?: string | null; createdAt: string; updatedAt: string; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/monitor/updateStatusPage': { patch: { req: { requestBody: { id: string; slug?: string; title?: string; description?: string; body?: { [key: string]: unknown; }; monitorList?: Array<{ id: string; showCurrent?: boolean; }>; domain?: string | null; }; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; slug: string; title: string; description: string; body: { [key: string]: unknown; }; monitorList: Array<{ id: string; showCurrent?: boolean; }>; domain?: string | null; createdAt: string; updatedAt: string; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/monitor/deleteStatusPage': { delete: { req: { id: string; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; slug: string; title: string; description: string; body: { [key: string]: unknown; }; monitorList: Array<{ id: string; showCurrent?: boolean; }>; domain?: string | null; createdAt: string; updatedAt: string; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/telemetry/all': { get: { req: { workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ id: string; workspaceId: string; name: string; createdAt: string; updatedAt: string; deletedAt?: string | null; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/telemetry/info': { get: { req: { telemetryId: string; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; createdAt: string; updatedAt: string; deletedAt?: string | null; } | null; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/telemetry/allEventCount': { get: { req: { workspaceId: string; }; res: { /** * Successful response */ 200: { [key: string]: (number); }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/telemetry/eventCount': { get: { req: { telemetryId: string; workspaceId: string; }; res: { /** * Successful response */ 200: number; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/telemetry/upsert': { post: { req: { requestBody: { telemetryId?: string; name: string; }; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; createdAt: string; updatedAt: string; deletedAt?: string | null; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/telemetry/delete': { post: { req: { requestBody: { telemetryId: string; }; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; createdAt: string; updatedAt: string; deletedAt?: string | null; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/telemetry/pageviews': { get: { req: { city?: string; country?: string; endAt: number; region?: string; startAt: number; telemetryId: string; timezone?: string; unit?: string; url?: string; workspaceId: string; }; res: { /** * Successful response */ 200: { pageviews?: unknown; sessions?: unknown; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/telemetry/metrics': { get: { req: { city?: string; country?: string; endAt: number; region?: string; startAt: number; telemetryId: string; timezone?: string; type: 'source' | 'url' | 'event' | 'referrer' | 'country'; url?: string; workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ x: string | null; y: number; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/telemetry/stats': { get: { req: { city?: string; country?: string; endAt: number; region?: string; startAt: number; telemetryId: string; timezone?: string; unit?: string; url?: string; workspaceId: string; }; res: { /** * Successful response */ 200: { pageviews: { value: number; prev: number; }; uniques: { value: number; prev: number; }; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/survey/all': { get: { req: { workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ id: string; workspaceId: string; name: string; payload: { items: Array<{ label: string; name: string; type: 'text' | 'select' | 'email' | 'imageUrl'; options?: Array<(string)>; }>; }; feedChannelIds: Array<(string)>; feedTemplate: string; webhookUrl: string; recentSuggestionCategory: Array<(string)>; createdAt: string; updatedAt: string; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/survey/{surveyId}/get': { get: { req: { surveyId: string; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; payload: { items: Array<{ label: string; name: string; type: 'text' | 'select' | 'email' | 'imageUrl'; options?: Array<(string)>; }>; }; feedChannelIds: Array<(string)>; feedTemplate: string; webhookUrl: string; recentSuggestionCategory: Array<(string)>; createdAt: string; updatedAt: string; } | null; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/survey/{surveyId}/count': { get: { req: { surveyId: string; workspaceId: string; }; res: { /** * Successful response */ 200: number; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/survey/allResultCount': { get: { req: { workspaceId: string; }; res: { /** * Successful response */ 200: { [key: string]: (number); }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/survey/{surveyId}/submit': { post: { req: { requestBody: { payload: { [key: string]: unknown; }; }; surveyId: string; workspaceId: string; }; res: { /** * Successful response */ 200: string; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/survey/create': { post: { req: { requestBody: { name: string; payload: { items: Array<{ label: string; name: string; type: 'text' | 'select' | 'email' | 'imageUrl'; options?: Array<(string)>; }>; }; feedChannelIds: Array<(string)>; feedTemplate: string; webhookUrl: string; }; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; payload: { items: Array<{ label: string; name: string; type: 'text' | 'select' | 'email' | 'imageUrl'; options?: Array<(string)>; }>; }; feedChannelIds: Array<(string)>; feedTemplate: string; webhookUrl: string; recentSuggestionCategory: Array<(string)>; createdAt: string; updatedAt: string; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/survey/{surveyId}/update': { patch: { req: { requestBody: { name?: string; payload?: { items: Array<{ label: string; name: string; type: 'text' | 'select' | 'email' | 'imageUrl'; options?: Array<(string)>; }>; }; feedChannelIds?: Array<(string)>; feedTemplate?: string; webhookUrl?: string; }; surveyId: string; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; payload: { items: Array<{ label: string; name: string; type: 'text' | 'select' | 'email' | 'imageUrl'; options?: Array<(string)>; }>; }; feedChannelIds: Array<(string)>; feedTemplate: string; webhookUrl: string; recentSuggestionCategory: Array<(string)>; createdAt: string; updatedAt: string; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/survey/{surveyId}/delete': { delete: { req: { surveyId: string; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; payload: { items: Array<{ label: string; name: string; type: 'text' | 'select' | 'email' | 'imageUrl'; options?: Array<(string)>; }>; }; feedChannelIds: Array<(string)>; feedTemplate: string; webhookUrl: string; recentSuggestionCategory: Array<(string)>; createdAt: string; updatedAt: string; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/survey/{surveyId}/result/list': { get: { req: { cursor?: string; endAt?: number; filter?: string; limit?: number; startAt?: number; surveyId: string; workspaceId: string; }; res: { /** * Successful response */ 200: { items: Array<{ id: string; surveyId: string; createdAt: string; sessionId: string; payload: { [key: string]: unknown; }; browser?: string | null; os?: string | null; language?: string | null; ip?: string | null; country?: string | null; subdivision1?: string | null; subdivision2?: string | null; city?: string | null; longitude?: number | null; latitude?: number | null; accuracyRadius?: number | null; aiCategory?: string | null; aiTranslation?: string | null; }>; nextCursor?: string; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/survey/{surveyId}/stats': { get: { req: { endAt?: number; startAt?: number; surveyId: string; workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ date: string; count: number; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/survey/{surveyId}/aiCategoryList': { get: { req: { surveyId: string; workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ name: string | null; count: number; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/audit/fetchByCursor': { get: { req: { cursor?: string; limit?: number; workspaceId: string; }; res: { /** * Successful response */ 200: { items: Array<{ id: string; workspaceId: string; content: string; relatedId?: string | null; relatedType?: 'Monitor' | 'Notification' | 'Task' | null; createdAt: string; }>; nextCursor?: string; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/audit/clear': { delete: { req: { workspaceId: string; }; res: { /** * Successful response */ 200: unknown; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/billing/usage': { get: { req: { endAt: number; startAt: number; workspaceId: string; }; res: { /** * Successful response */ 200: { websiteAcceptedCount: number; websiteEventCount: number; monitorExecutionCount: number; surveyCount: number; feedEventCount: number; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/billing/limit': { get: { req: { workspaceId: string; }; res: { /** * Successful response */ 200: { maxWebsiteCount: number; maxWebsiteEventCount: number; maxMonitorExecutionCount: number; maxSurveyCount: number; maxFeedChannelCount: number; maxFeedEventCount: number; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/billing/currentTier': { get: { req: { workspaceId: string; }; res: { /** * Successful response */ 200: 'FREE' | 'PRO' | 'TEAM' | 'UNLIMITED'; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/billing/currentSubscription': { get: { req: { workspaceId: string; }; res: { /** * Successful response */ 200: { subscriptionId: string; workspaceId: string; storeId: string; productId: string; variantId: string; status: string; cardBrand: string; cardLastFour: string; renewsAt: string; createdAt: string; updatedAt: string; tier: string; } | null; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/feed/channels': { get: { req: { workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ id: string; workspaceId: string; name: string; webhookSignature: string; notifyFrequency: 'none' | 'event' | 'day' | 'week' | 'month'; createdAt: string; updatedAt: string; _count: { events: number; }; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/feed/{channelId}/info': { get: { req: { channelId: string; workspaceId: string; }; res: { /** * Successful response */ 200: { notificationIds: Array<(string)>; id: string; workspaceId: string; name: string; webhookSignature: string; notifyFrequency: 'none' | 'event' | 'day' | 'week' | 'month'; createdAt: string; updatedAt: string; } | null; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/feed/{channelId}/update': { post: { req: { channelId: string; requestBody: { notificationIds?: Array<(string)>; name: string; webhookSignature: string; notifyFrequency: 'none' | 'event' | 'day' | 'week' | 'month'; }; workspaceId: string; }; res: { /** * Successful response */ 200: { notificationIds: Array<(string)>; id: string; workspaceId: string; name: string; webhookSignature: string; notifyFrequency: 'none' | 'event' | 'day' | 'week' | 'month'; createdAt: string; updatedAt: string; } | null; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/feed/{channelId}/fetchEventsByCursor': { get: { req: { archived?: boolean; channelId: string; cursor?: string; limit?: number; workspaceId: string; }; res: { /** * Successful response */ 200: { items: Array<{ id: string; channelId: string; createdAt: string; updatedAt: string; eventName: string; eventContent: string; tags: Array<(string)>; source: string; senderId?: string | null; senderName?: string | null; url?: string | null; important: boolean; archived: boolean; payload?: { [key: string]: unknown; } | null; }>; nextCursor?: string; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/feed/createChannel': { post: { req: { requestBody: { name: string; notifyFrequency: 'none' | 'event' | 'day' | 'week' | 'month'; notificationIds?: Array<(string)>; }; workspaceId: string; }; res: { /** * Successful response */ 200: { notificationIds: Array<(string)>; id: string; workspaceId: string; name: string; webhookSignature: string; notifyFrequency: 'none' | 'event' | 'day' | 'week' | 'month'; createdAt: string; updatedAt: string; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/feed/{channelId}/del': { delete: { req: { channelId: string; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; workspaceId: string; name: string; webhookSignature: string; notifyFrequency: 'none' | 'event' | 'day' | 'week' | 'month'; createdAt: string; updatedAt: string; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/feed/{channelId}/send': { post: { req: { channelId: string; requestBody: { eventName: string; eventContent: string; tags: Array<(string)>; source: string; senderId?: string | null; senderName?: string | null; important: boolean; payload?: { [key: string]: unknown; } | null; }; }; res: { /** * Successful response */ 200: { id: string; channelId: string; createdAt: string; updatedAt: string; eventName: string; eventContent: string; tags: Array<(string)>; source: string; senderId?: string | null; senderName?: string | null; url?: string | null; important: boolean; archived: boolean; payload?: { [key: string]: unknown; } | null; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/feed/{channelId}/{eventId}/archive': { patch: { req: { channelId: string; eventId: string; requestBody: { workspaceId: string; }; }; res: { /** * Successful response */ 200: unknown; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/feed/{channelId}/{eventId}/unarchive': { patch: { req: { channelId: string; eventId: string; requestBody: { workspaceId: string; }; }; res: { /** * Successful response */ 200: unknown; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/feed/{channelId}/clearAllArchivedEvents': { patch: { req: { channelId: string; requestBody: { workspaceId: string; }; }; res: { /** * Successful response */ 200: number; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/feed/playground/{workspaceId}': { post: { req: { workspaceId: string; }; res: { /** * Successful response */ 200: string; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/feed/{channelId}/github': { post: { req: { channelId: string; }; res: { /** * Successful response */ 200: string; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/feed/{channelId}/stripe': { post: { req: { channelId: string; }; res: { /** * Successful response */ 200: string; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/feed/{channelId}/tencent-cloud/alarm': { post: { req: { channelId: string; }; res: { /** * Successful response */ 200: string; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/feed/{channelId}/sentry': { post: { req: { channelId: string; }; res: { /** * Successful response */ 200: string; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/feed/state/all': { get: { req: { channelId: string; limit?: number; workspaceId: string; }; res: { /** * Successful response */ 200: Array<{ id: string; channelId: string; createdAt: string; updatedAt: string; eventId: string; eventName: string; eventContent: string; tags: Array<(string)>; source: string; senderId?: string | null; senderName?: string | null; url?: string | null; important: boolean; status: 'Ongoing' | 'Resolved'; resolvedAt?: string | null; payload?: { [key: string]: unknown; } | null; }>; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Not found */ 404: error_NOT_FOUND; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/feed/{channelId}/state/upsert': { post: { req: { channelId: string; requestBody: { eventId: string; eventName: string; eventContent: string; tags: Array<(string)>; source: string; senderId?: string | null; senderName?: string | null; important: boolean; payload?: { [key: string]: unknown; } | null; }; }; res: { /** * Successful response */ 200: { id: string; channelId: string; createdAt: string; updatedAt: string; eventId: string; eventName: string; eventContent: string; tags: Array<(string)>; source: string; senderId?: string | null; senderName?: string | null; url?: string | null; important: boolean; status: 'Ongoing' | 'Resolved'; resolvedAt?: string | null; payload?: { [key: string]: unknown; } | null; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; '/workspace/{workspaceId}/feed/{channelId}/state/resolve': { post: { req: { channelId: string; requestBody: { stateId: string; }; workspaceId: string; }; res: { /** * Successful response */ 200: { id: string; channelId: string; createdAt: string; updatedAt: string; eventId: string; eventName: string; eventContent: string; tags: Array<(string)>; source: string; senderId?: string | null; senderName?: string | null; url?: string | null; important: boolean; status: 'Ongoing' | 'Resolved'; resolvedAt?: string | null; payload?: { [key: string]: unknown; } | null; }; /** * Invalid input data */ 400: error_BAD_REQUEST; /** * Authorization not provided */ 401: error_UNAUTHORIZED; /** * Insufficient access */ 403: error_FORBIDDEN; /** * Internal server error */ 500: error_INTERNAL_SERVER_ERROR; }; }; }; };