Constructors

Methods

  • Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Add media to a title.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional data: object
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Analyze UTM data with optional group_by (source, campaign, medium, device_type, etc.)

    GET /titles/{title_id}/utm/analysis

    Type Parameters

    • T

    Parameters

    • title_id: string

      The UUID of the title

    • Optional params: Record<string, any>

      e.g. ?group_by=source&start_date=YYYY-MM-DD

    Returns AxiosPromise<default<T>>

    AxiosPromise

  • Search messages across all sessions of a title.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • List all chat sessions for a title.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Get a specific chat session and its messages.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • session_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Update a specific chat message.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • message_id: string
    • data: object

    Returns AxiosPromise<default<T>>

  • Create a new game install record.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • data: object
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Create a new purchase record.
    Matches POST /titles/{title_id}/purchases

    Type Parameters

    • T

    Parameters

    • title_id: string
    • data: object
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Create a new API token for a title. Returns { full_token: string, token: TitleToken }.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional data: {
          expires_at?: string;
      }
      • Optional expires_at?: string

    Returns AxiosPromise<default<T>>

  • Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Retrieve the UTM analytics data for a title (paginated, filterable, sortable).

    GET /titles/{title_id}/utm

    Type Parameters

    • T

    Parameters

    • title_id: string

      The UUID of the title

    • Optional params: Record<string, any>

      Optional query params: start_date, end_date, source, device_type, sort_by, etc.

    Returns AxiosPromise<default<T>>

    AxiosPromise

  • Get the web tracking token used for websites.

    GET /titles/{title_id}/webTrackingToken

    Type Parameters

    • T

    Parameters

    • title_id: string

      The UUID of the title

    • Optional params: Record<string, any>

      Optional query params:

    Returns AxiosPromise<default<T>>

    AxiosPromise

  • Retrieve the wishlist data for a specific title.

    Type Parameters

    • T

    Parameters

    • title_id: string

      The UUID of the title

    • Optional params: Record<string, any>

      Optional query params, e.g. { platform: 'steam', start_date: '2025-01-01', end_date: '2025-01-31'}

    Returns AxiosPromise<default<T>>

    AxiosPromise

  • Bulk import access keys for a title from a CSV or Excel file. The file must contain 'platform' and 'code' columns.

    Type Parameters

    • T

    Parameters

    • title_id: string

      The UUID of the title.

    • file: File | Blob

      The CSV or Excel file to upload.

    • Optional data: Record<string, any>

      Optional additional form data.

    • Optional params: Record<string, any>

      Optional query parameters.

    Returns AxiosPromise<default<T>>

    AxiosPromise

  • Upload a CSV/Excel file containing daily UTM analytics for a specific title.

    Type Parameters

    • T

    Parameters

    • title_id: string

      The UUID of the title

    • file: File | Blob

      The CSV or Excel file

    • Optional data: Record<string, any>

      Optional form fields (if needed)

    • Optional params: Record<string, any>

      Optional query parameters

    Returns AxiosPromise<default<T>>

    AxiosPromise

  • Upload a CSV/Excel file containing wishlist data for a title.

    Type Parameters

    • T

    Parameters

    • title_id: string

      The UUID of the title

    • file: File | Blob

      The CSV or Excel file

    • Optional data: Record<string, any>

      Any additional form data, e.g. platform

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

    AxiosPromise

  • Distribution of installs by total revenue, plus a histogram array.
    Matches GET /titles/{title_id}/purchases/reports/install-distribution

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Stats by item SKU, purchase type, and repeat purchase analysis.
    Matches GET /titles/{title_id}/purchases/reports/item-type-stats

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • List game installs for a specific title.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • List all purchase events for a specific title.
    Matches GET /titles/{title_id}/purchases

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • List retention events for a specific title.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • List sessions for a specific title, with optional filters and pagination. Returns a paginated list of sessions with start/end times, session_length, user info, etc.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • List all tokens for a title.

    Type Parameters

    • T

    Parameters

    • title_id: string

    Returns AxiosPromise<default<T>>

  • Show breakdown of revenue per currency, with optional USD conversion.
    Matches GET /titles/{title_id}/purchases/reports/currency

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • 30-day LTV (Lifetime Value) per install.
    Matches GET /titles/{title_id}/purchases/reports/ltv30

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Revenue by time (daily, weekly, or monthly).
    Matches GET /titles/{title_id}/purchases/reports/time

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Get a summary of total revenue, grouped by day or purchase_type.
    Matches GET /titles/{title_id}/purchases/summary

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Remove media from a title.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • media_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Get a summary report of retention events for a specific title.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Revoke a specific token by ID.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • token_id: string

    Returns AxiosPromise<default<T>>

  • Get aggregated average session length data (daily/weekly/monthly) for a title. Optionally filter by platform/device_type/OS/version and group by one dimension.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Type Parameters

    • T

    Parameters

    • title_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Update the ordering of media items (images, videos, etc.) for a title.

    Type Parameters

    • T

    Parameters

    • title_id: string

      The ID of the title to update

    • media_order: {
          media_id: string;
          order: number;
      }[]

      An array of objects, each containing: - media_id: string (the UUID of the media) - order: number (the new order/index)

    Returns AxiosPromise<default<T>>

    Promise containing the server response

  • View a single game install record.

    Type Parameters

    • T

    Parameters

    • title_id: string
    • install_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

  • Retrieve a single purchase record by ID.
    Matches GET /titles/{title_id}/purchases/{purchase_id}

    Type Parameters

    • T

    Parameters

    • title_id: string
    • purchase_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

Generated using TypeDoc