Sheet Session Information

Session Information

Purpose

To get the details of a particular document session.

HTTP Request URL

https://{api.office-integrator_domain}/sheet/officeapi/v1/sessions/<session_id>?apikey=<apikey>

Request Parameters

Parameter	Data Type	Description
Mandatory Parameters
apikey	String	Uniquely identifies the web application in which the Sheet editor is integrated.
session_id	String	Unique user session id of the spreadsheet.

Note:

Users can find the 'session_id' in all Zoho Sheet API responses. For example, the "session_id" is captured as part of the response and can be seen in Preview, Edit and Co-Edit APIs.

Sample Request

Copiedhttps://api.office-integrator.com/sheet/officeapi/v1/sessions/d26aa7b8029b5rf8d34c7yu00139392357d12ffcb21c1?apikey=423s*****

Sample Response

Copied{
	'status' : active/inactive/invalid
	'info': {
		'document_id': '12345',
		'created_time_ms': <time in millis>,
		'created_time': UTC,
		'expires_on_ms': <time_in_millis>,
		'expires_on': <2018-05-08T13:54:41Z>
	}
}

Status Description:

active - If the session details is available and opened.
inactive - If the session url is not yet opened.
invalid - If no such session is available for that APIKey.