getListSessionsJobResult( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves the job status and a list of session IDs, if ready.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Session Recording Analytics - all permissions
Learn more about app permissions.
Method Declaration
Copy
function getListSessionsJobResult(
  jobId: string,
  options: GetListSessionsJobResultOptions,
): Promise<GetListSessionsJobResultResponse>;
Method Parameters
jobIdstringRequired

List sessions job ID.


optionsGetListSessionsJobResultOptionsRequired

Field options. The limit and offset filters must be passed.

Returns
Return Type:Promise<GetListSessionsJobResultResponse>
JavaScript
import { analyticsSession } from "wix-analytics-session.v2"; async function getListSessionsJobResult(jobId, options) { try { const result = await analyticsSession.getListSessionsJobResult( jobId, options, ); return result; } catch (error) { console.error(error); // Handle the error } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?