Static activeStatic addStatic addStatic analyzeAnalyze UTM data with optional group_by (source, campaign, medium, device_type, etc.)
GET /titles/{title_id}/utm/analysis
The UUID of the title
Optional params: Record<string, any>e.g. ?group_by=source&start_date=YYYY-MM-DD
AxiosPromise
Static approveStatic attributionStatic behavioralGenerate the drop-off report for a specific behavioral funnel.
Optional params: Record<string, any>{ start_date?: string, end_date?: string }
Static bulkStatic chatStatic chatStatic chatStatic chatStatic cohortsStatic completeStatic confirmStatic createStatic createStatic createStatic createStatic createStatic createStatic createStatic deleteStatic deleteStatic deleteStatic distinctStatic eventStatic eventStatic generateGenerate or regenerate AI-powered HTML content for a landing page.
The UUID of the landing page.
An object containing the prompt, language_code, and privacy_mode.
Optional params: Record<string, any>Static geoStatic getGet an aggregated report of ad conversion events for charting.
Optional unique_Static getStatic getStatic getProxies a request through the backend to the matchmaker. This avoids HTTPS -> HTTP mixed content blocks.
The UUID of the game title.
Optional params: Record<string, any>AxiosPromise containing { signallingServer: string }
Static getStatic getInitializes a play session. Handles age-gating and license verification. Returns the CDN URL for WASM/iFrame or Signaling URL for Pixel Streaming.
Optional params: Record<string, any>Static getRetrieve the UTM analytics data for a title (paginated, filterable, sortable).
GET /titles/{title_id}/utm
The UUID of the title
Optional params: Record<string, any>Optional query params: start_date, end_date, source, device_type, sort_by, etc.
AxiosPromise
Static getGet the web tracking token used for websites.
GET /titles/{title_id}/webTrackingToken
The UUID of the title
Optional params: Record<string, any>Optional query params:
AxiosPromise
Static getRetrieve the wishlist data for a specific title.
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'}
AxiosPromise
Static importBulk import access keys for a title from a CSV or Excel file. The file must contain 'platform' and 'code' columns.
The UUID of the title.
The CSV or Excel file to upload.
Optional data: Record<string, any>Optional additional form data.
Optional params: Record<string, any>Optional query parameters.
AxiosPromise
Static importUpload a CSV/Excel file containing daily UTM analytics for a specific title.
The UUID of the title
The CSV or Excel file
Optional data: Record<string, any>Optional form fields (if needed)
Optional params: Record<string, any>Optional query parameters
AxiosPromise
Static importUpload a CSV/Excel file containing wishlist data for a title.
The UUID of the title
The CSV or Excel file
Optional data: Record<string, any>Any additional form data, e.g. platform
Optional params: Record<string, any>AxiosPromise
Static initiateStatic installDistribution of installs by total revenue, plus a histogram array.
Matches GET /titles/{title_id}/purchases/reports/install-distribution
Optional params: Record<string, any>Static itemStats by item SKU, purchase type, and repeat purchase analysis.
Matches GET /titles/{title_id}/purchases/reports/item-type-stats
Optional params: Record<string, any>Static listStatic listStatic listStatic listStatic listStatic listStatic listStatic listStatic listStatic listStatic listStatic listList 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.
Optional params: Record<string, any>Static listStatic matchmakerStatic matchmakerStatic myStatic purchaseShow breakdown of revenue per currency, with optional USD conversion.
Matches GET /titles/{title_id}/purchases/reports/currency
Optional params: Record<string, any>Static purchaseStatic purchaseStatic purchaseStatic rejectStatic removeRemove a user as an administrator toa tile
Optional data: objectThe data to be passed when creating a title.
Optional params: Record<string, any>Promise
Static removeStatic resolveStatic retentionStatic retentionStatic retryStatic revokeStatic saveCreate or update a specific translation for a landing page.
The UUID of the landing page.
The full translation object to be saved.
Optional params: Record<string, any>Static searchSearch for Titles using Meilisearch or fallback based on the query and filters.
Optional params: Record<string, any>Object of query params:
Static sessionsGet aggregated average session length data (daily/weekly/monthly) for a title. Optionally filter by platform/device_type/OS/version and group by one dimension.
Optional params: Record<string, any>Static sessionsStatic storeStatic translateTrigger an AI translation for a landing page.
The UUID of the landing page.
An object containing the target language code, e.g., { language_code: 'es' }.
Optional params: Record<string, any>Static updateStatic updateUpdate administrator email preferences for a title.
The id of the title.
The id of the user/administrator.
The preference data to update (notify_promotion_schedule_reminder_email, notify_weekly_promotion_performance_email).
Optional params: Record<string, any>Promise
Static updateUpdate the status of a specific deployment build.
The UUID of the title.
The UUID of the build.
The new status ('ready', 'inactive', or 'failed').
Static updateUpdate an existing landing page.
The UUID of the landing page to update.
The new data for the landing page.
Optional params: Record<string, any>Static updateUpdate the ordering of media items (images, videos, etc.) for a title.
The ID of the title to update
An array of objects, each containing: - media_id: string (the UUID of the media) - order: number (the new order/index)
Promise containing the server response
Static uploadUpdates the banner image for the title using a Blob.
The blob to upload.
Optional data: objectAny additional data to pass along to the upload
Optional params: Record<string, any>promise
Static uploadUpdates the banner image for the title using a File object.
The file object to upload.
Optional data: objectAny additional data to pass along to the upload.
Optional params: Record<string, any>promise
Static uploadUpdates the main image for the title using a Blob.
The blob to upload.
Optional data: objectAny additional data to pass along to the upload
Optional params: Record<string, any>promise
Static uploadUpdates the main image for the title using a File object.
The file object to upload.
Optional data: objectAny additional data to pass along to the upload.
Optional params: Record<string, any>promise
Static validateThe Aegis Handshake: Verify if a player is allowed to play.
This is used by the game engine (Unity/Unreal) to confirm that the current session is valid and the user has a proper license.
The UUID of the game title.
The UUID of the specific install/session.
AxiosPromise containing { valid: boolean, user_name: string, license_type: string }
Static viewStatic viewStatic viewStatic viewStatic viewStatic wishlistStatic wishlistGet Wishlist Intelligence statistics for a title. Includes funnel data and predictive revenue forecasting. Note: Requires Title Administrator permissions.
The UUID of the title.
Static wishlistToggle a game on the current user's wishlist. If the game is not wishlisted, it will be added. If it is, it will be removed.
The UUID of the title.
Optional data: objectOptional context: { fingerprint_id?: string, short_link_click_id?: string }
Static wishlistRecord a self-assigned excitement score (1-5) for a wishlisted game.
The UUID of the title.
{ score: number } - Must be between 1 and 5.
Generated using TypeDoc
Add a user as an administrator to a title