glitch-javascript-sdk 1.8.4 → 1.8.5

package/dist/esm/api/Fingerprinting.d.ts

@@ -0,0 +1,132 @@
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+declare class Fingerprinting {
+    /**
+     * List identified user fingerprints with filtering options
+     *
+     * @param params Filtering options:
+     *   - title_id?: string - Filter by title ID
+     *   - device_id?: string - Filter by device ID
+     *   - user_install_id?: string - Filter by user install ID
+     *   - browser_fingerprint?: string - Filter by browser fingerprint hash
+     *   - device_fingerprint?: string - Filter by device fingerprint hash
+     *   - is_bot?: boolean - Filter by bot status
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - sort?: 'first_seen_at'|'last_seen_at'|'match_confidence' - Sort field
+     *   - order?: 'asc'|'desc' - Sort order
+     *   - per_page?: number - Items per page (max 100)
+     * @returns Promise with paginated fingerprints data
+     */
+    static listFingerprints<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get cross-platform user journey reports
+     *
+     * @param params Report options:
+     *   - title_id: string - Required title ID
+     *   - fingerprint_id?: string - Specific fingerprint ID to analyze
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - platform?: 'web'|'ios'|'android'|'steam'|'console' - Filter by platform
+     *   - event_type?: string - Filter by event type
+     *   - group_by?: 'day'|'week'|'month'|'year' - Grouping period
+     *   - include_paths?: boolean - Include journey paths in response
+     * @returns Promise with user journey report data
+     */
+    static userJourneyReport<T>(params: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get cross-platform attribution reports
+     *
+     * @param params Report options:
+     *   - title_id: string - Required title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - conversion_event?: 'game_install'|'game_purchase'|'web_event' - Conversion event to analyze
+     *   - attribution_model?: 'first_touch'|'last_touch'|'linear'|'time_decay'|'position_based' - Attribution model
+     * @returns Promise with attribution report data
+     */
+    static attributionReport<T>(params: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get cross-device identity clusters
+     *
+     * @param params Report options:
+     *   - title_id: string - Required title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - min_confidence?: number - Minimum match confidence score (0-100)
+     * @returns Promise with device cluster report data
+     */
+    static deviceClusterReport<T>(params: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get combined identity clusters and user journey reports
+     *
+     * @param params Report options:
+     *   - title_id: string - Required title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - min_confidence?: number - Minimum confidence score to include (0-100)
+     *   - platform?: string - Filter by platform
+     *   - include_journeys?: boolean - Include detailed journeys
+     * @returns Promise with identity cluster report data
+     */
+    static identityClusterReport<T>(params: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get combined attribution paths and conversion funnels
+     *
+     * @param params Report options:
+     *   - title_id: string - Required title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - conversion_event?: string - Conversion event type
+     *   - attribution_model?: string - Attribution model
+     *   - funnel_steps?: string - Comma-separated funnel steps
+     * @returns Promise with attribution and funnel report data
+     */
+    static attributionFunnelReport<T>(params: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get device and environment breakdown reports
+     *
+     * @param params Report options:
+     *   - title_id: string - Required title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - platform?: string - Filter by platform
+     *   - group_by?: 'device_type'|'os'|'browser'|'country_code' - Grouping field
+     * @returns Promise with device and environment report data
+     */
+    static deviceEnvironmentReport<T>(params: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get unique vs returning user metrics
+     *
+     * @param params Report options:
+     *   - title_id: string - Required title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - retention_period?: number - Days to consider for retention
+     * @returns Promise with retention metrics data
+     */
+    static uniqueReturningReport<T>(params: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get fraud and bot detection metrics
+     *
+     * @param params Report options:
+     *   - title_id: string - Required title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - min_confidence?: number - Minimum confidence score to flag (0-100)
+     * @returns Promise with fraud detection data
+     */
+    static fraudDetectionReport<T>(params: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get geolocation distribution of users
+     *
+     * @param params Report options:
+     *   - title_id: string - Required title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - group_by?: 'country'|'region'|'city' - Grouping level
+     * @returns Promise with geolocation report data
+     */
+    static geolocationReport<T>(params: Record<string, any>): AxiosPromise<Response<T>>;
+}
+export default Fingerprinting;

package/dist/esm/api/index.d.ts

@@ -4,6 +4,7 @@ import Competitions from "./Competitions";
 import Communities from "./Communities";
 import Users from "./Users";
 import Events from "./Events";
+import Fingerprinting from "./Fingerprinting";
 import Teams from "./Teams";
 import Waitlists from "./Waitlist";
 import Posts from "./Posts";
@@ -66,3 +67,4 @@ export { Funnel };
 export { SocialStats };
 export { Hashtags };
 export { WebsiteAnalytics };
+export { Fingerprinting };

package/dist/esm/index.d.ts

@@ -32,6 +32,7 @@ import { Funnel } from "./api";
 import { SocialStats } from "./api";
 import { Hashtags } from "./api";
 import { WebsiteAnalytics } from "./api";
+import { Fingerprinting } from "./api";
 import Requests from "./util/Requests";
 import Parser from "./util/Parser";
 import Session from "./util/Session";
@@ -85,6 +86,7 @@ declare class Glitch {
         Funnel: typeof Funnel;
         SocialStats: typeof SocialStats;
         WebsiteAnalytics: typeof WebsiteAnalytics;
+        Fingerprinting: typeof Fingerprinting;
     };
     static util: {
         Requests: typeof Requests;

package/dist/esm/index.js

@@ -8933,6 +8933,207 @@ var Events = /** @class */ (function () {
     return Events;
 }());
 
+var FingerprintingRoute = /** @class */ (function () {
+    function FingerprintingRoute() {
+    }
+    FingerprintingRoute.routes = {
+        listFingerprints: {
+            url: '/reports/fingerprinting/fingerprints',
+            method: HTTP_METHODS.GET
+        },
+        userJourneyReport: {
+            url: '/reports/fingerprinting/user-journeys',
+            method: HTTP_METHODS.GET
+        },
+        attributionReport: {
+            url: '/reports/fingerprinting/attribution',
+            method: HTTP_METHODS.GET
+        },
+        deviceClusterReport: {
+            url: '/reports/fingerprinting/device-clusters',
+            method: HTTP_METHODS.GET
+        },
+        identityClusterReport: {
+            url: '/reports/fingerprinting/identity-clusters',
+            method: HTTP_METHODS.GET
+        },
+        attributionFunnelReport: {
+            url: '/reports/fingerprinting/attribution-funnel',
+            method: HTTP_METHODS.GET
+        },
+        deviceEnvironmentReport: {
+            url: '/reports/fingerprinting/device-environment',
+            method: HTTP_METHODS.GET
+        },
+        uniqueReturningReport: {
+            url: '/reports/fingerprinting/unique-returning',
+            method: HTTP_METHODS.GET
+        },
+        fraudDetectionReport: {
+            url: '/reports/fingerprinting/fraud-detection',
+            method: HTTP_METHODS.GET
+        },
+        geolocationReport: {
+            url: '/reports/fingerprinting/geolocation',
+            method: HTTP_METHODS.GET
+        }
+    };
+    return FingerprintingRoute;
+}());
+
+var Fingerprinting = /** @class */ (function () {
+    function Fingerprinting() {
+    }
+    /**
+     * List identified user fingerprints with filtering options
+     *
+     * @param params Filtering options:
+     *   - title_id?: string - Filter by title ID
+     *   - device_id?: string - Filter by device ID
+     *   - user_install_id?: string - Filter by user install ID
+     *   - browser_fingerprint?: string - Filter by browser fingerprint hash
+     *   - device_fingerprint?: string - Filter by device fingerprint hash
+     *   - is_bot?: boolean - Filter by bot status
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - sort?: 'first_seen_at'|'last_seen_at'|'match_confidence' - Sort field
+     *   - order?: 'asc'|'desc' - Sort order
+     *   - per_page?: number - Items per page (max 100)
+     * @returns Promise with paginated fingerprints data
+     */
+    Fingerprinting.listFingerprints = function (params) {
+        return Requests.processRoute(FingerprintingRoute.routes.listFingerprints, {}, undefined, params);
+    };
+    /**
+     * Get cross-platform user journey reports
+     *
+     * @param params Report options:
+     *   - title_id: string - Required title ID
+     *   - fingerprint_id?: string - Specific fingerprint ID to analyze
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - platform?: 'web'|'ios'|'android'|'steam'|'console' - Filter by platform
+     *   - event_type?: string - Filter by event type
+     *   - group_by?: 'day'|'week'|'month'|'year' - Grouping period
+     *   - include_paths?: boolean - Include journey paths in response
+     * @returns Promise with user journey report data
+     */
+    Fingerprinting.userJourneyReport = function (params) {
+        return Requests.processRoute(FingerprintingRoute.routes.userJourneyReport, {}, undefined, params);
+    };
+    /**
+     * Get cross-platform attribution reports
+     *
+     * @param params Report options:
+     *   - title_id: string - Required title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - conversion_event?: 'game_install'|'game_purchase'|'web_event' - Conversion event to analyze
+     *   - attribution_model?: 'first_touch'|'last_touch'|'linear'|'time_decay'|'position_based' - Attribution model
+     * @returns Promise with attribution report data
+     */
+    Fingerprinting.attributionReport = function (params) {
+        return Requests.processRoute(FingerprintingRoute.routes.attributionReport, {}, undefined, params);
+    };
+    /**
+     * Get cross-device identity clusters
+     *
+     * @param params Report options:
+     *   - title_id: string - Required title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - min_confidence?: number - Minimum match confidence score (0-100)
+     * @returns Promise with device cluster report data
+     */
+    Fingerprinting.deviceClusterReport = function (params) {
+        return Requests.processRoute(FingerprintingRoute.routes.deviceClusterReport, {}, undefined, params);
+    };
+    /**
+     * Get combined identity clusters and user journey reports
+     *
+     * @param params Report options:
+     *   - title_id: string - Required title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - min_confidence?: number - Minimum confidence score to include (0-100)
+     *   - platform?: string - Filter by platform
+     *   - include_journeys?: boolean - Include detailed journeys
+     * @returns Promise with identity cluster report data
+     */
+    Fingerprinting.identityClusterReport = function (params) {
+        return Requests.processRoute(FingerprintingRoute.routes.identityClusterReport, {}, undefined, params);
+    };
+    /**
+     * Get combined attribution paths and conversion funnels
+     *
+     * @param params Report options:
+     *   - title_id: string - Required title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - conversion_event?: string - Conversion event type
+     *   - attribution_model?: string - Attribution model
+     *   - funnel_steps?: string - Comma-separated funnel steps
+     * @returns Promise with attribution and funnel report data
+     */
+    Fingerprinting.attributionFunnelReport = function (params) {
+        return Requests.processRoute(FingerprintingRoute.routes.attributionFunnelReport, {}, undefined, params);
+    };
+    /**
+     * Get device and environment breakdown reports
+     *
+     * @param params Report options:
+     *   - title_id: string - Required title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - platform?: string - Filter by platform
+     *   - group_by?: 'device_type'|'os'|'browser'|'country_code' - Grouping field
+     * @returns Promise with device and environment report data
+     */
+    Fingerprinting.deviceEnvironmentReport = function (params) {
+        return Requests.processRoute(FingerprintingRoute.routes.deviceEnvironmentReport, {}, undefined, params);
+    };
+    /**
+     * Get unique vs returning user metrics
+     *
+     * @param params Report options:
+     *   - title_id: string - Required title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - retention_period?: number - Days to consider for retention
+     * @returns Promise with retention metrics data
+     */
+    Fingerprinting.uniqueReturningReport = function (params) {
+        return Requests.processRoute(FingerprintingRoute.routes.uniqueReturningReport, {}, undefined, params);
+    };
+    /**
+     * Get fraud and bot detection metrics
+     *
+     * @param params Report options:
+     *   - title_id: string - Required title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - min_confidence?: number - Minimum confidence score to flag (0-100)
+     * @returns Promise with fraud detection data
+     */
+    Fingerprinting.fraudDetectionReport = function (params) {
+        return Requests.processRoute(FingerprintingRoute.routes.fraudDetectionReport, {}, undefined, params);
+    };
+    /**
+     * Get geolocation distribution of users
+     *
+     * @param params Report options:
+     *   - title_id: string - Required title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - group_by?: 'country'|'region'|'city' - Grouping level
+     * @returns Promise with geolocation report data
+     */
+    Fingerprinting.geolocationReport = function (params) {
+        return Requests.processRoute(FingerprintingRoute.routes.geolocationReport, {}, undefined, params);
+    };
+    return Fingerprinting;
+}());
+
 var TeamsRoute = /** @class */ (function () {
     function TeamsRoute() {
     }
@@ -13809,7 +14010,8 @@ var Glitch = /** @class */ (function () {
         Scheduler: Scheduler,
         Funnel: Funnel,
         SocialStats: SocialStats,
-        WebsiteAnalytics: WebsiteAnalytics
+        WebsiteAnalytics: WebsiteAnalytics,
+        Fingerprinting: Fingerprinting
     };
     Glitch.util = {
         Requests: Requests,