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
createStatic
createStatic
createStatic
deleteStatic
distinctStatic
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
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
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
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
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
retentionStatic
retentionStatic
revokeStatic
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
updateStatic
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
viewStatic
viewGenerated using TypeDoc
Add a user as an administrator to a title