Search events

Request description

Endpoint: /events/search
Method: POST

Header

{
  "Content-Type": "application/json",
  "Authorization": "Bearer <accessToken>"
}

Note: the <accessToken> is obtained as a result of the authentication

Payload

interface ISearchEventPayload {
  userId: string;
  offset: number;
  period: number;
  outputFormat?: "json" | "csv";
  limit?: number;
}

where:

• userId: user identification
• limit: Maximum number of events to return (Value must be between 1 and 100)
• startTimestamp: Start time (in milliseconds)
• endTimestamp: End time (in milliseconds)
• outputFormat: Output format. (JSON by default)

Responses

Correct response

type ListGroupsResponseType = {
  events: IEvent[];
};

interface IEvent {
  timestamp: string; // ISO string
  eventName: string;
  userId: string;
  organizationId: string;
}

Wrong responses

{
  // empty body
}

Description: this error occurs when endpoint authorizers fail to validate the token sent in the request header.

{
  // empty body
}

Description: this error occurs when your accessToken does not have permission to search for events related to this organization.

type SearchEventResponseType = {
  errorType: SEARCH_EVENT_ERROR_TYPE;
  errorMessage?: string;
};

enum SearchEventResponseType {
  INVALID_START_TIMESTAMP = "invalidStartTimestamp",
  INVALID_END_TIMESTAMP = "invalidEndTimestamp",
  INVALID_LIMIT = "invalidLimitValue",
  INVALID_OUTPUT_FORMAT = "invalidOutputFormat",
}