getUserActivity()

getUserActivity(options: UserActivityOptions): Promise<UserActivity[]>

Defined in: packages/core/src/index.ts:676

Get user activity logs within a date range

Parameters

Parameter	Type	Description
options	UserActivityOptions	Activity query options (start_date, end_date required; page, limit optional)

Returns

Promise<UserActivity[]>

Array of user activity records

Throws

400 - Invalid date range

Throws

401 - Not authenticated

Example

import { getUserActivity } from "@cpod/sdk";

const activities = await getUserActivity({
  start_date: "2024-01-01",
  end_date: "2024-01-31",
  page: 1,
  limit: 50,
});

activities.forEach(activity => {
  console.log(`${activity.action} at ${activity.timestamp}`);
});