Class default

Constructors

constructor

Methods

adCampaignPerformanceReport attributionFunnelReport attributionReport deviceClusterReport deviceEnvironmentReport fraudDetectionReport geolocationReport identityClusterReport installJourneyReport listFingerprints pixelAttributionReport uniqueReturningReport userJourneyReport

Constructors

constructor

Methods

Static adCampaignPerformanceReport

  • adCampaignPerformanceReport<T>(params): AxiosPromise<default<T>>

  • Get how the ad campaigns are performing and turning into installs

    Type Parameters

    • T

    Parameters

    • params: Record<string, any>

      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 AxiosPromise<default<T>>

    Promise with geolocation report data

Static attributionFunnelReport

  • attributionFunnelReport<T>(params): AxiosPromise<default<T>>

  • Get combined attribution paths and conversion funnels

    Type Parameters

    • T

    Parameters

    • params: Record<string, any>

      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 AxiosPromise<default<T>>

    Promise with attribution and funnel report data

Static attributionReport

  • attributionReport<T>(params): AxiosPromise<default<T>>

  • Get cross-platform attribution reports

    Type Parameters

    • T

    Parameters

    • params: Record<string, any>

      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 AxiosPromise<default<T>>

    Promise with attribution report data

Static deviceClusterReport

  • deviceClusterReport<T>(params): AxiosPromise<default<T>>

  • Get cross-device identity clusters

    Type Parameters

    • T

    Parameters

    • params: Record<string, any>

      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 AxiosPromise<default<T>>

    Promise with device cluster report data

Static deviceEnvironmentReport

  • deviceEnvironmentReport<T>(params): AxiosPromise<default<T>>

  • Get device and environment breakdown reports

    Type Parameters

    • T

    Parameters

    • params: Record<string, any>

      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 AxiosPromise<default<T>>

    Promise with device and environment report data

Static fraudDetectionReport

  • fraudDetectionReport<T>(params): AxiosPromise<default<T>>

  • Get fraud and bot detection metrics

    Type Parameters

    • T

    Parameters

    • params: Record<string, any>

      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 AxiosPromise<default<T>>

    Promise with fraud detection data

Static geolocationReport

  • geolocationReport<T>(params): AxiosPromise<default<T>>

  • Get geolocation distribution of users

    Type Parameters

    • T

    Parameters

    • params: Record<string, any>

      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 AxiosPromise<default<T>>

    Promise with geolocation report data

Static identityClusterReport

  • identityClusterReport<T>(params): AxiosPromise<default<T>>

  • Get combined identity clusters and user journey reports

    Type Parameters

    • T

    Parameters

    • params: Record<string, any>

      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 AxiosPromise<default<T>>

    Promise with identity cluster report data

Static installJourneyReport

  • installJourneyReport<T>(params): AxiosPromise<default<T>>

  • Get an understanding of the path people take to install your game

    Type Parameters

    • T

    Parameters

    • params: Record<string, any>

      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 AxiosPromise<default<T>>

    Promise with geolocation report data

Static listFingerprints

  • listFingerprints<T>(params?): AxiosPromise<default<T>>

  • List identified user fingerprints with filtering options

    Type Parameters

    • T

    Parameters

    • Optional params: Record<string, any>

      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 AxiosPromise<default<T>>

    Promise with paginated fingerprints data

Static pixelAttributionReport

  • pixelAttributionReport<T>(params): AxiosPromise<default<T>>

  • Get pixel and utem reports

    Type Parameters

    • T

    Parameters

    • params: Record<string, any>

      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 AxiosPromise<default<T>>

    Promise with geolocation report data

Static uniqueReturningReport

  • uniqueReturningReport<T>(params): AxiosPromise<default<T>>

  • Get unique vs returning user metrics

    Type Parameters

    • T

    Parameters

    • params: Record<string, any>

      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 AxiosPromise<default<T>>

    Promise with retention metrics data

Static userJourneyReport

  • userJourneyReport<T>(params): AxiosPromise<default<T>>

  • Get cross-platform user journey reports

    Type Parameters

    • T

    Parameters

    • params: Record<string, any>

      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 AxiosPromise<default<T>>

    Promise with user journey report data

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc