Skip to main content

Session SDK

The Session SDK provides methods to manage user sessions and retrieve session analytics for your games on the GetJar platform.

Initialization​

import { Configuration, Session } from '@eightpointio/getjar-iap-sdk';

const config = new Configuration({
  basePath: 'url',
  headers: { 'x-api-key': 'key' }
});

const sessionClient = new Session(config);

Methods​

createSession​

Creates a new user session for an game.

Parameters:

  • payload (ICreateSessionRequest): Session data
    • gameId (string, optional): Game ID
    • gameId (number, optional): Game ID
    • cognitoUserId (string): User's Cognito ID
    • platform (Platform): Platform being used
    • gameVersion (string): Game version
    • metadata (Record, optional): Additional session data
    • gameName (string, optional): Game name

Returns: Promise<ISession>

const session = await sessionClient.createSession({
  gameId: 'game-123',
  cognitoUserId: 'user-456',
  platform: Platform.WEB,
  gameVersion: '1.0.0',
  metadata: {
    deviceType: 'desktop',
    browser: 'Chrome'
  }
});

getSessionById​

Retrieves a specific session by its ID.

Parameters:

  • sessionId (string): Session ID

Returns: Promise<ISession>

const session = await sessionClient.getSessionById('session-789');

getGameSessions​

Retrieves all sessions for a specific game with optional filtering and pagination.

Parameters:

  • gameId (string): Game ID
  • props (IQuerySessionsRequest, optional): Query parameters
    • limit (number): Items per page
    • page (number): Page number
    • sortOrder (SortOrderEnum): Sort order
    • startDate (string): Filter from date
    • endDate (string): Filter to date
    • gameId (string): Additional game filter
    • platform (Platform): Filter by platform

Returns: Promise<PaginatedResponse<ISession>>

const sessions = await sessionClient.getGameSessions('game-123', {
  limit: 50,
  page: 1,
  platform: Platform.WEB,
  startDate: '2025-01-01',
  endDate: '2025-01-31'
});

terminateSession​

Manually terminates an active session.

Parameters:

  • sessionId (string): Session ID
  • payload (object): Termination data
    • reason (string, optional): Reason for termination
    • endedAt (string, optional): Custom end timestamp

Returns: Promise<void>

await sessionClient.terminateSession('session-789', {
  reason: 'User logged out',
  endedAt: new Date().toISOString()
});

Types​

Platform​

enum Platform {
  IOS = 'ios',
  ANDROID = 'android',
  WEB = 'web',
  WINDOWS = 'windows',
  MACOS = 'macos',
  LINUX = 'linux',
  OTHER = 'other'
}

ISession​

interface ISession {
  sessionId: string;
  cognitoUserId: string;
  gameId: string;
  gameName?: string;
  platform: Platform;
  gameVersion: string;
  metadata?: Record;
  createdAt: Date;
  duration?: number;
  updatedAt: Date;
  deletedAt?: Date;
}

PaginatedResponse​

interface PaginatedResponse<T> {
  items: T[];
  pagination: {
    total: number;
    page: number;
    limit: number;
    totalPages: number;
    hasNextPage: boolean;
    hasPreviousPage: boolean;
  };
}