/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ export interface paths { "/api/v1/websites/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Get all websites configurations */ get: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { siteIds: number[]; /** @description The tracker url of the website */ trackerUrl: string; /** @description Set cookieless if you want to track without cookies (GDPR compliance) */ cookieless: boolean; /** @description Bypass adblockers using custom tracker url */ bypassAdblockers: boolean; /** @description Whether to track page views automatically when the JavaScript tracking code loads */ trackPageView: boolean; /** @description Whether to enable automatic tracking of outlinks and downloads */ linkTracking: boolean; /** @description Set the heart beat timer (in seconds) to track how much time users spend on pages */ heartBeatTimer: number; /** @description Whether to detect browser features like cookies, Java, Flash for visitor segmentation */ browserFeatureDetection: boolean; /** @description Whether to track bots and spiders. Default is false. */ trackBots: boolean; /** * Format: uuid * @description Optional UUID for the website config. If not provided, a new UUID7 will be generated. */ id: string; /** @description The name of the website config */ name: string; /** @description The domain of the website config */ domain: string; /** @description The organization ID of the website config, used for multi-tenant support adopting the org-id of logto */ organizationId: string; /** @description The creation date of the website config */ createdAt: string; /** @description The update date of the website config */ updatedAt: string; /** * @description Custom dimensions schema for website config * @example { * "dimension1": "value1", * "dimension2": "value2" * } */ customDimensions: { [key: string]: string; }; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; /** @description Default Response */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; }; }; put?: never; /** @description Create a new website configuration */ post: { parameters: { query?: never; header?: { /** @description The Matomo token_auth to use for the request */ "x-matomo-token"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { siteIds: number[]; /** @description The tracker url of the website */ trackerUrl: string; /** @description Set cookieless if you want to track without cookies (GDPR compliance) */ cookieless: boolean; /** @description Bypass adblockers using custom tracker url */ bypassAdblockers: boolean; /** @description Whether to track page views automatically when the JavaScript tracking code loads */ trackPageView: boolean; /** @description Whether to enable automatic tracking of outlinks and downloads */ linkTracking: boolean; /** @description Set the heart beat timer (in seconds) to track how much time users spend on pages */ heartBeatTimer: number; /** @description Whether to detect browser features like cookies, Java, Flash for visitor segmentation */ browserFeatureDetection: boolean; /** @description Whether to track bots and spiders. Default is false. */ trackBots: boolean; /** @description The name of the website config */ name: string; /** @description The domain of the website config */ domain: string; /** * @description Custom dimensions schema for website config * @example { * "dimension1": "value1", * "dimension2": "value2" * } */ customDimensions: { [key: string]: string; }; /** Format: uuid */ id?: string; /** @description The organization ID of the website config, used for multi-tenant support adopting the org-id of logto */ organizationId?: string; }; }; }; responses: { /** @description Default Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { siteIds: number[]; /** @description The tracker url of the website */ trackerUrl: string; /** @description Set cookieless if you want to track without cookies (GDPR compliance) */ cookieless: boolean; /** @description Bypass adblockers using custom tracker url */ bypassAdblockers: boolean; /** @description Whether to track page views automatically when the JavaScript tracking code loads */ trackPageView: boolean; /** @description Whether to enable automatic tracking of outlinks and downloads */ linkTracking: boolean; /** @description Set the heart beat timer (in seconds) to track how much time users spend on pages */ heartBeatTimer: number; /** @description Whether to detect browser features like cookies, Java, Flash for visitor segmentation */ browserFeatureDetection: boolean; /** @description Whether to track bots and spiders. Default is false. */ trackBots: boolean; /** * Format: uuid * @description Optional UUID for the website config. If not provided, a new UUID7 will be generated. */ id: string; /** @description The name of the website config */ name: string; /** @description The domain of the website config */ domain: string; /** @description The organization ID of the website config, used for multi-tenant support adopting the org-id of logto */ organizationId: string; /** @description The creation date of the website config */ createdAt: string; /** @description The update date of the website config */ updatedAt: string; /** * @description Custom dimensions schema for website config * @example { * "dimension1": "value1", * "dimension2": "value2" * } */ customDimensions: { [key: string]: string; }; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; /** @description Default Response */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v1/websites/seeder-config": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Get the website seeder configuration checksum */ get: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { id: string; /** @description The name of the config the checksum belongs to */ name: string; /** @description The checksum of the config object */ checksum: string; /** @description The creation date of the config checksum */ created_at: string; /** @description The update date of the config checksum */ updated_at: string; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; /** @description Default Response */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; }; }; put?: never; /** @description Save a new website seeder configuration checksum */ post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The checksum of the config object */ checksum: string; }; }; }; responses: { /** @description Default Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; /** @description Default Response */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v1/websites/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Get a website configuration by ID */ get: { parameters: { query?: { /** @description Organization ID is only required when the user is not logged in, otherwise the organization ID is retrieved from the user data. */ orgId?: string; }; header?: never; path: { /** @description Website UUID */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { siteIds: number[]; /** @description The tracker url of the website */ trackerUrl: string; /** @description Set cookieless if you want to track without cookies (GDPR compliance) */ cookieless: boolean; /** @description Bypass adblockers using custom tracker url */ bypassAdblockers: boolean; /** @description Whether to track page views automatically when the JavaScript tracking code loads */ trackPageView: boolean; /** @description Whether to enable automatic tracking of outlinks and downloads */ linkTracking: boolean; /** @description Set the heart beat timer (in seconds) to track how much time users spend on pages */ heartBeatTimer: number; /** @description Whether to detect browser features like cookies, Java, Flash for visitor segmentation */ browserFeatureDetection: boolean; /** @description Whether to track bots and spiders. Default is false. */ trackBots: boolean; /** * Format: uuid * @description Optional UUID for the website config. If not provided, a new UUID7 will be generated. */ id: string; /** @description The name of the website config */ name: string; /** @description The domain of the website config */ domain: string; /** @description The organization ID of the website config, used for multi-tenant support adopting the org-id of logto */ organizationId: string; /** @description The creation date of the website config */ createdAt: string; /** @description The update date of the website config */ updatedAt: string; /** * @description Custom dimensions schema for website config * @example { * "dimension1": "value1", * "dimension2": "value2" * } */ customDimensions: { [key: string]: string; }; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; /** @description Default Response */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; /** @description Update a website configuration by ID */ patch: { parameters: { query?: never; header?: { /** @description The Matomo token_auth to use for the request */ "x-matomo-token"?: string; }; path: { /** @description Website UUID */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { siteIds?: number[]; /** @description The tracker url of the website */ trackerUrl?: string; /** @description Set cookieless if you want to track without cookies (GDPR compliance) */ cookieless?: boolean; /** @description Bypass adblockers using custom tracker url */ bypassAdblockers?: boolean; /** @description Whether to track page views automatically when the JavaScript tracking code loads */ trackPageView?: boolean; /** @description Whether to enable automatic tracking of outlinks and downloads */ linkTracking?: boolean; /** @description Set the heart beat timer (in seconds) to track how much time users spend on pages */ heartBeatTimer?: number; /** @description Whether to detect browser features like cookies, Java, Flash for visitor segmentation */ browserFeatureDetection?: boolean; /** @description Whether to track bots and spiders. Default is false. */ trackBots?: boolean; /** @description The name of the website config */ name?: string; /** @description The domain of the website config */ domain?: string; /** * @description Custom dimensions schema for website config * @example { * "dimension1": "value1", * "dimension2": "value2" * } */ customDimensions?: { [key: string]: string; }; /** @description The organization ID of the website config, used for multi-tenant support adopting the org-id of logto */ organizationId?: string; }; }; }; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { siteIds: number[]; /** @description The tracker url of the website */ trackerUrl: string; /** @description Set cookieless if you want to track without cookies (GDPR compliance) */ cookieless: boolean; /** @description Bypass adblockers using custom tracker url */ bypassAdblockers: boolean; /** @description Whether to track page views automatically when the JavaScript tracking code loads */ trackPageView: boolean; /** @description Whether to enable automatic tracking of outlinks and downloads */ linkTracking: boolean; /** @description Set the heart beat timer (in seconds) to track how much time users spend on pages */ heartBeatTimer: number; /** @description Whether to detect browser features like cookies, Java, Flash for visitor segmentation */ browserFeatureDetection: boolean; /** @description Whether to track bots and spiders. Default is false. */ trackBots: boolean; /** * Format: uuid * @description Optional UUID for the website config. If not provided, a new UUID7 will be generated. */ id: string; /** @description The name of the website config */ name: string; /** @description The domain of the website config */ domain: string; /** @description The organization ID of the website config, used for multi-tenant support adopting the org-id of logto */ organizationId: string; /** @description The creation date of the website config */ createdAt: string; /** @description The update date of the website config */ updatedAt: string; /** * @description Custom dimensions schema for website config * @example { * "dimension1": "value1", * "dimension2": "value2" * } */ customDimensions: { [key: string]: string; }; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; /** @description Default Response */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; }; }; trace?: never; }; "/api/v1/websites/{id}/export": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Export Matomo analytics data for a website */ get: { parameters: { query: { /** * @description The start date of the export in YYYY-MM-DD format * @example 2025-01-01 */ startDate: string; /** * @description The end date of the export in YYYY-MM-DD format * @example 2025-01-01 */ endDate: string; /** * @description The limit of the exported items, default is 100 * @example 100 */ filterLimit?: number; /** * @description The offset of the exported items, used in combination with filterLimit, default is 0 * @example 0 */ filterOffset?: number; filterSortOrder?: "asc" | "desc"; /** * @description The Custom Segment you wish to filter your reports to. * @example referrerName==Google,referrerName==Bing;country==IN */ segment?: string; }; header?: { /** @description The Matomo token_auth to use for the request */ "x-matomo-token"?: string; }; path: { /** @description Website UUID */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { idSite?: number; idVisit?: number; visitIp?: string; visitorId?: string; fingerprint?: string; actionDetails?: { type: string; url: string; pageTitle?: string; pageIdAction: number; idpageview: string; serverTimePretty: string; pageId: number; timeSpent?: number; timeSpentPretty?: string; pageviewPosition: number; title: string; subtitle: string; icon: string; iconSVG: string; timestamp: number; customVariables?: { [key: string]: unknown; }; }[]; goalConversions?: number; siteCurrency?: string; siteCurrencySymbol?: string; serverDate?: string; visitServerHour?: string; lastActionTimestamp?: number; lastActionDateTime?: string; siteName?: string; serverTimestamp?: number; firstActionTimestamp?: number; serverTimePretty?: string; serverDatePretty?: string; serverDatePrettyFirstAction?: string; serverTimePrettyFirstAction?: string; /** @enum {object|null} */ userId?: never | null; visitorType?: string; /** @enum {object|null} */ visitorTypeIcon?: never | null; visitConverted?: number; /** @enum {object|null} */ visitConvertedIcon?: never | null; visitCount?: number; visitEcommerceStatus?: string; /** @enum {object|null} */ visitEcommerceStatusIcon?: never | null; daysSinceFirstVisit?: number; secondsSinceFirstVisit?: number; daysSinceLastEcommerceOrder?: number; /** @enum {object|null} */ secondsSinceLastEcommerceOrder?: never | null; visitDuration?: number; visitDurationPretty?: string; searches?: number; actions?: number; interactions?: number; referrerType?: string; referrerTypeName?: string; referrerName?: string; referrerKeyword?: string; /** @enum {object|null} */ referrerKeywordPosition?: never | null; /** @enum {object|null} */ referrerUrl?: never | null; /** @enum {object|null} */ referrerSearchEngineUrl?: never | null; /** @enum {object|null} */ referrerSearchEngineIcon?: never | null; /** @enum {object|null} */ referrerSocialNetworkUrl?: never | null; /** @enum {object|null} */ referrerSocialNetworkIcon?: never | null; languageCode?: string; language?: string; deviceType?: string; deviceTypeIcon?: string; deviceBrand?: string; deviceModel?: string; operatingSystem?: string; operatingSystemName?: string; operatingSystemIcon?: string; operatingSystemCode?: string; operatingSystemVersion?: string; browserFamily?: string; browserFamilyDescription?: string; browser?: string; browserName?: string; browserIcon?: string; browserCode?: string; browserVersion?: string; events?: number; continent?: string; continentCode?: string; country?: string; countryCode?: string; countryFlag?: string; /** @enum {object|null} */ region?: never | null; /** @enum {object|null} */ regionCode?: never | null; /** @enum {object|null} */ city?: never | null; location?: string; /** @enum {object|null} */ latitude?: never | null; /** @enum {object|null} */ longitude?: never | null; visitLocalTime?: string; visitLocalHour?: string; daysSinceLastVisit?: number; secondsSinceLastVisit?: number; resolution?: string; plugins?: string; pluginsIcons?: { pluginIcon: string; pluginName: string; }[]; }[]; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; /** @description Default Response */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v1/websites/{id}/tracking-code": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** @description Get tracking code for a website */ post: { parameters: { query?: never; header?: { /** @description The Matomo token_auth to use for the request */ "x-matomo-token"?: string; }; path: { /** @description Website UUID */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { siteIds?: number[]; /** @description The tracker url of the website */ trackerUrl?: string; /** @description Set cookieless if you want to track without cookies (GDPR compliance) */ cookieless?: boolean; /** @description Bypass adblockers using custom tracker url */ bypassAdblockers?: boolean; /** @description Whether to track page views automatically when the JavaScript tracking code loads */ trackPageView?: boolean; /** @description Whether to enable automatic tracking of outlinks and downloads */ linkTracking?: boolean; /** @description Set the heart beat timer (in seconds) to track how much time users spend on pages */ heartBeatTimer?: number; /** @description Whether to detect browser features like cookies, Java, Flash for visitor segmentation */ browserFeatureDetection?: boolean; /** @description Whether to track bots and spiders. Default is false. */ trackBots?: boolean; /** * @description Custom dimensions schema for website config * @example { * "dimension1": "value1", * "dimension2": "value2" * } */ customDimensions?: { [key: string]: string; }; /** @description The custom user ID to track */ userId?: string; }; }; }; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description The javascript tracking code, available when generating tracking code with params ?code=true */ script: string; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; /** @description Default Response */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v1/websites/{id}/track-event": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** @description Track event for a website */ post: { parameters: { query?: { /** @description If true, use code-based tracking */ code?: boolean; }; header?: { /** @description The Matomo token_auth to use for the request */ "x-matomo-token"?: string; }; path: { /** @description Website UUID */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { event: { /** * @description The event category. * @example Category 1 */ category: string; /** * @description The event action. * @example Action 1 */ action: string; /** * @description The event name. * @example Event 1 */ name?: string; /** * @description The event value. Must be a float or integer value (numeric), not a string. * @example 1 */ value?: number; }; metadataOverride?: { /** @description The URL of the page */ url?: string; /** * Format: IPv4/IPv6 * @description The IPv4/IPv6 address of the user, 'x-matomo-token' header is required to override this parameter */ clientIp?: string; /** @description The user agent of the user */ userAgent?: string; /** @description The referrer of the user */ referrer?: string; /** @description The language of the user */ language?: string; /** @description The resolution of the device */ screenResolution?: string; timestamp?: string | number; }; contextOverride?: { /** @description The user ID of the user, User ID is any non-empty unique string identifying the user (such as an email address or a username). */ userId?: string; /** @description Define the custom dimensions for tracking events. Set a dimension to null to remove it for this event. */ customDimensions?: { [key: string]: string | null; }; }; /** @description Array of site IDs, if not provided, the tracking will be applied to all the website's site_ids */ siteIds?: number[]; }; }; }; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description The javascript tracking code, available when generating tracking code with params ?code=true */ script: string; }; }; }; }; /** @description Default Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { [key: string]: unknown; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; /** @description Default Response */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v1/websites/{id}/track-page-view": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** @description Track page view for a website */ post: { parameters: { query?: { /** @description If true, use code-based tracking */ code?: boolean; }; header?: { /** @description The Matomo token_auth to use for the request */ "x-matomo-token"?: string; }; path: { /** @description Website UUID */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { event: { /** @description The title of the page */ title: string; }; metadataOverride?: { /** @description The URL of the page */ url?: string; /** * Format: IPv4/IPv6 * @description The IPv4/IPv6 address of the user, 'x-matomo-token' header is required to override this parameter */ clientIp?: string; /** @description The user agent of the user */ userAgent?: string; /** @description The referrer of the user */ referrer?: string; /** @description The language of the user */ language?: string; /** @description The resolution of the device */ screenResolution?: string; timestamp?: string | number; }; contextOverride?: { /** @description The user ID of the user, User ID is any non-empty unique string identifying the user (such as an email address or a username). */ userId?: string; /** @description Define the custom dimensions for tracking events. Set a dimension to null to remove it for this event. */ customDimensions?: { [key: string]: string | null; }; }; /** @description Array of site IDs, if not provided, the tracking will be applied to all the website's site_ids */ siteIds?: number[]; }; }; }; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description The javascript tracking code, available when generating tracking code with params ?code=true */ script: string; }; }; }; }; /** @description Default Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { [key: string]: unknown; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; /** @description Default Response */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v1/websites/{id}/track-search": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** @description Track search for a website */ post: { parameters: { query?: { /** @description If true, use code-based tracking */ code?: boolean; }; header?: { /** @description The Matomo token_auth to use for the request */ "x-matomo-token"?: string; }; path: { /** @description Website UUID */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { event: { /** @description The search keyword,When specified, the request will not be tracked as a normal pageview but will instead be tracked as a Site Search request. */ query: string; /** @description when search is specified, you can optionally specify a search category with this parameter. */ category?: string; /** @description when search is specified, we also recommend setting count to the number of search results displayed on the results page. When keywords are tracked with &search_count=0 they will appear in the 'No Result Search Keyword' report. */ count?: number; }; metadataOverride?: { /** @description The URL of the page */ url?: string; /** * Format: IPv4/IPv6 * @description The IPv4/IPv6 address of the user, 'x-matomo-token' header is required to override this parameter */ clientIp?: string; /** @description The user agent of the user */ userAgent?: string; /** @description The referrer of the user */ referrer?: string; /** @description The language of the user */ language?: string; /** @description The resolution of the device */ screenResolution?: string; timestamp?: string | number; }; contextOverride?: { /** @description The user ID of the user, User ID is any non-empty unique string identifying the user (such as an email address or a username). */ userId?: string; /** @description Define the custom dimensions for tracking events. Set a dimension to null to remove it for this event. */ customDimensions?: { [key: string]: string | null; }; }; /** @description Array of site IDs, if not provided, the tracking will be applied to all the website's site_ids */ siteIds?: number[]; }; }; }; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description The javascript tracking code, available when generating tracking code with params ?code=true */ script: string; }; }; }; }; /** @description Default Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { [key: string]: unknown; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; /** @description Default Response */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v1/websites/{id}/track-link": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** @description Track link that could be an outgoing link or a download link */ post: { parameters: { query?: { /** @description If true, use code-based tracking */ code?: boolean; }; header?: { /** @description The Matomo token_auth to use for the request */ "x-matomo-token"?: string; }; path: { /** @description Website UUID */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { event: { /** @description The type of the link - either 'link' for outgoing links or 'download' for downloads */ linkType: "link" | "download"; /** @description The URL of the link */ link: string; }; metadataOverride?: { /** @description The URL of the page */ url?: string; /** * Format: IPv4/IPv6 * @description The IPv4/IPv6 address of the user, 'x-matomo-token' header is required to override this parameter */ clientIp?: string; /** @description The user agent of the user */ userAgent?: string; /** @description The referrer of the user */ referrer?: string; /** @description The language of the user */ language?: string; /** @description The resolution of the device */ screenResolution?: string; timestamp?: string | number; }; contextOverride?: { /** @description The user ID of the user, User ID is any non-empty unique string identifying the user (such as an email address or a username). */ userId?: string; /** @description Define the custom dimensions for tracking events. Set a dimension to null to remove it for this event. */ customDimensions?: { [key: string]: string | null; }; }; /** @description Array of site IDs, if not provided, the tracking will be applied to all the website's site_ids */ siteIds?: number[]; }; }; }; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description The javascript tracking code, available when generating tracking code with params ?code=true */ script: string; }; }; }; }; /** @description Default Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { [key: string]: unknown; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; /** @description Default Response */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v1/websites/{id}/track-content-impression": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** @description Track content impression for a website */ post: { parameters: { query?: { /** @description If true, use code-based tracking */ code?: boolean; }; header?: { /** @description The Matomo token_auth to use for the request */ "x-matomo-token"?: string; }; path: { /** @description Website UUID */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { event: { /** @description The name of the content block */ name: string; /** @description The piece of the content that was displayed (e.g. link to an image) */ piece: string; /** @description The target of the content leads to (e.g. URL of some external website) */ target: string; }; metadataOverride?: { /** @description The URL of the page */ url?: string; /** * Format: IPv4/IPv6 * @description The IPv4/IPv6 address of the user, 'x-matomo-token' header is required to override this parameter */ clientIp?: string; /** @description The user agent of the user */ userAgent?: string; /** @description The referrer of the user */ referrer?: string; /** @description The language of the user */ language?: string; /** @description The resolution of the device */ screenResolution?: string; timestamp?: string | number; }; contextOverride?: { /** @description The user ID of the user, User ID is any non-empty unique string identifying the user (such as an email address or a username). */ userId?: string; /** @description Define the custom dimensions for tracking events. Set a dimension to null to remove it for this event. */ customDimensions?: { [key: string]: string | null; }; }; /** @description Array of site IDs, if not provided, the tracking will be applied to all the website's site_ids */ siteIds?: number[]; }; }; }; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description The javascript tracking code, available when generating tracking code with params ?code=true */ script: string; }; }; }; }; /** @description Default Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { [key: string]: unknown; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; /** @description Default Response */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v1/websites/{id}/track-content-interaction": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** @description Track content interaction for a website */ post: { parameters: { query?: { /** @description If true, use code-based tracking */ code?: boolean; }; header?: { /** @description The Matomo token_auth to use for the request */ "x-matomo-token"?: string; }; path: { /** @description Website UUID */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": { event: { /** @description The name of the content block */ name: string; /** @description The piece of the content that was displayed (e.g. link to an image) */ piece: string; /** @description The target of the content leads to (e.g. URL of some external website) */ target: string; /** @description The interaction of the content, example: 'click' */ interaction: string; }; metadataOverride?: { /** @description The URL of the page */ url?: string; /** * Format: IPv4/IPv6 * @description The IPv4/IPv6 address of the user, 'x-matomo-token' header is required to override this parameter */ clientIp?: string; /** @description The user agent of the user */ userAgent?: string; /** @description The referrer of the user */ referrer?: string; /** @description The language of the user */ language?: string; /** @description The resolution of the device */ screenResolution?: string; timestamp?: string | number; }; contextOverride?: { /** @description The user ID of the user, User ID is any non-empty unique string identifying the user (such as an email address or a username). */ userId?: string; /** @description Define the custom dimensions for tracking events. Set a dimension to null to remove it for this event. */ customDimensions?: { [key: string]: string | null; }; }; /** @description Array of site IDs, if not provided, the tracking will be applied to all the website's site_ids */ siteIds?: number[]; }; }; }; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { /** @description The javascript tracking code, available when generating tracking code with params ?code=true */ script: string; }; }; }; }; /** @description Default Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { [key: string]: unknown; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; /** @description Default Response */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/health/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Check the health of the API */ get: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { status: string; }; }; }; }; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/health/db": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Check the database connection */ get: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { status: string; }; }; }; }; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v1/auth/token": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** @description Generate an access token using oauth2 client credentials flow */ post: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The organization ID */ organizationId: string; /** @description The application ID */ applicationId: string; /** @description The application secret */ applicationSecret: string; /** * @description The scopes to generate the token for * @example [ * "analytics:website:read", * "analytics:website:write" * ] */ scopes: string[]; /** @description The Logto OIDC endpoint */ logtoOidcEndpoint: string; }; }; }; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { accessToken: string; }; }; }; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v1/audit-logs/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Get all audit logs */ get: { parameters: { query?: { offset?: number; limit?: number; resource?: string; action?: string; user?: string; from?: string; to?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { auditLogId: string; createdAt: string; eventType: "website.create" | "website.update"; userId?: string; title: string; organizationId?: string; }[]; metadata?: { /** @description Object containing the links to the related endpoints */ links?: { self: { /** @description URL pointing to the request itself */ href?: string; }; next?: { /** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */ href?: string; }; prev?: { /** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */ href?: string; }; first: { /** @description URL pointing to the first page of results in a paginated response */ href?: string; }; last: { /** @description URL pointing to the first page of results in a paginated response */ href?: string; }; /** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */ pages: { [key: string]: { /** @description URL pointing to the first page of results in a paginated response */ href?: string; }; }; }; /** @description Number representing the total number of available items */ totalCount?: number; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; /** @description Default Response */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/v1/audit-logs/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Get audit log by id */ get: { parameters: { query?: never; header?: never; path: { id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { data: { auditLogId: string; createdAt: string; eventType: "website.create" | "website.update"; userId?: string; title: string; organizationId?: string; }; metadata?: { /** @description Object containing the links to the related endpoints */ links?: { self: { /** @description URL pointing to the request itself */ href?: string; }; next?: { /** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */ href?: string; }; prev?: { /** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */ href?: string; }; first: { /** @description URL pointing to the first page of results in a paginated response */ href?: string; }; last: { /** @description URL pointing to the first page of results in a paginated response */ href?: string; }; /** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */ pages: { [key: string]: { /** @description URL pointing to the first page of results in a paginated response */ href?: string; }; }; }; /** @description Number representing the total number of available items */ totalCount?: number; }; }; }; }; /** @description Default Response */ "4XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; /** @description Default Response */ "5XX": { headers: { [name: string]: unknown; }; content: { "application/json": { code: string; detail: string; name: string; }; }; }; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/openapi.json": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Default Response */ 200: { headers: { [name: string]: unknown; }; content?: never; }; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; } export type webhooks = Record; export interface components { schemas: never; responses: never; parameters: never; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export type operations = Record; //# sourceMappingURL=schema.d.ts.map