Records the end of the current player's active session.

The SDK will automatically create a new session ID when the application is started, this method can be useful to call when the app goes into the background to allow reporting on player session length.

View interactive version here

Request Parameters

Parameter Required Type Description

Response Parameters

A response to an end session request

Parameter Type Description
scriptData ScriptData A JSON Map of any data added either to the Request or the Response by your Cloud Code
sessionDuration number The length of this session

Nested types


A collection of arbitrary data that can be added to a message via a Cloud Code script.

Parameter Type Description
myKey string An arbitrary data key
myValue JSON An arbitrary data value.

Code Samples


    using GameSparks.Api;
    using GameSparks.Api.Requests;
    using GameSparks.Api.Responses;
    new EndSessionRequest()
        .Send((response) => {
        GSData scriptData = response.ScriptData;
        long? sessionDuration = response.SessionDuration;

ActionScript 3

    import com.gamesparks.*;
    import com.gamesparks.api.requests.*;
    import com.gamesparks.api.responses.*;
    import com.gamesparks.api.types.*;

        .send(function(response:com.gamesparks.api.responses.EndSessionResponse):void {
        var scriptData:ScriptData = response.getScriptData(); 
        var sessionDuration:Number = response.getSessionDuration(); 


    #import "GS.h"
    #import "GSAPI.h"
    GSEndSessionRequest* request = [[GSEndSessionRequest alloc] init];
    [request setCallback:^ (GSEndSessionResponse* response) {
    NSDictionary* scriptData = [response getScriptData]; 
    NSNumber* sessionDuration = [response getSessionDuration]; 
    [gs send:request];


    #include <GameSparks/generated/GSRequests.h>
    using namespace GameSparks::Core;
    using namespace GameSparks::Api::Responses;
    using namespace GameSparks::Api::Requests;

    void EndSessionRequest_Response(GS& gsInstance, const EndSessionResponse& response) {
    GSData scriptData = response.getScriptData(); 
    Optional::t_LongOptional sessionDuration = response.getSessionDuration(); 

    EndSessionRequest request(gsInstance);


import com.gamesparks.sdk.api.autogen.GSRequestBuilder.EndSessionRequest;
import com.gamesparks.sdk.api.autogen.GSResponseBuilder.EndSessionResponse;
import com.gamesparks.sdk.api.autogen.GSTypes.*;
import com.gamesparks.sdk.api.GSEventListener;

    .send(new GSEventListener<EndSessionResponse>() {
        public void onEvent(EndSessionResponse response) {
            Long sessionDuration = response.getSessionDuration(); 

Cloud Code

    var request = new SparkRequests.EndSessionRequest();
    var response = request.Send();

var scriptData = response.scriptData; 
var sessionDuration = response.sessionDuration;