ListUserEventsRequest

Example Usage

import { ListUserEventsRequest } from "@vercel/sdk/models/listusereventsop.js";

let value: ListUserEventsRequest = {
  limit: 20,
  since: "2019-12-08T10:00:38.976Z",
  until: "2019-12-09T23:00:38.976Z",
  types: "login,team-member-join,domain-buy",
  userId: "aeIInYVk59zbFF2SxfyxxmuO",
  principalId: "aeIInYVk59zbFF2SxfyxxmuO",
  projectIds: "aeIInYVk59zbFF2SxfyxxmuO",
  entityId: "scl_123",
  withPayload: "true",
  teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
  slug: "my-team-url-slug",
};

Fields

Field	Type	Required	Description	Example
limit	number	:heavy_minus_sign:	Maximum number of items which may be returned.	20
since	string	:heavy_minus_sign:	Timestamp to only include items created since then.	2019-12-08T10:00:38.976Z
until	string	:heavy_minus_sign:	Timestamp to only include items created until then.	2019-12-09T23:00:38.976Z
types	string	:heavy_minus_sign:	Comma-delimited list of event "types" to filter the results by.	login,team-member-join,domain-buy
userId	string	:heavy_minus_sign:	Deprecated. Use principalId instead. If principalId and userId both exist, principalId will be used.	aeIInYVk59zbFF2SxfyxxmuO
principalId	string	:heavy_minus_sign:	When retrieving events for a Team, the principalId parameter may be specified to filter events generated by a specific principal.	aeIInYVk59zbFF2SxfyxxmuO
projectIds	string	:heavy_minus_sign:	Comma-delimited list of project IDs to filter the results by.	aeIInYVk59zbFF2SxfyxxmuO
entityId	string	:heavy_minus_sign:	Filters events to those associated with a specific entity (matched against payload.id). For example, a connector ID.	scl_123
withPayload	string	:heavy_minus_sign:	When set to true, the response will include the payload field for each event.	true
teamId	string	:heavy_minus_sign:	The Team identifier to perform the request on behalf of.	team_1a2b3c4d5e6f7g8h9i0j1k2l
slug	string	:heavy_minus_sign:	The Team slug to perform the request on behalf of.	my-team-url-slug