# GetEventsRequest

## Example Usage

```typescript
import { GetEventsRequest } from "@flexprice/sdk/sdk/models";

let value: GetEventsRequest = {
  endTime: new Date("2024-12-09T00:00:00Z"),
  order: "desc",
  sort: "timestamp",
  startTime: new Date("2024-11-09T00:00:00Z"),
};
```

## Fields

| Field                                                                                                      | Type                                                                                                       | Required                                                                                                   | Description                                                                                                | Example                                                                                                    |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `endTime`                                                                                                  | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)              | :heavy_minus_sign:                                                                                         | End time of the events to be fetched in ISO 8601 format<br/>Defaults to now if not provided                | 2024-12-09T00:00:00Z                                                                                       |
| `eventId`                                                                                                  | *string*                                                                                                   | :heavy_minus_sign:                                                                                         | Event ID is the idempotency key for the event                                                              |                                                                                                            |
| `eventName`                                                                                                | *string*                                                                                                   | :heavy_minus_sign:                                                                                         | Event name / Unique identifier for the event in your system                                                |                                                                                                            |
| `externalCustomerId`                                                                                       | *string*                                                                                                   | :heavy_minus_sign:                                                                                         | Customer ID in your system that was sent with the event                                                    |                                                                                                            |
| `iterFirstKey`                                                                                             | *string*                                                                                                   | :heavy_minus_sign:                                                                                         | First key to iterate over the events                                                                       |                                                                                                            |
| `iterLastKey`                                                                                              | *string*                                                                                                   | :heavy_minus_sign:                                                                                         | Last key to iterate over the events                                                                        |                                                                                                            |
| `offset`                                                                                                   | *number*                                                                                                   | :heavy_minus_sign:                                                                                         | Offset to fetch the events and is set to 0 by default                                                      |                                                                                                            |
| `order`                                                                                                    | *string*                                                                                                   | :heavy_minus_sign:                                                                                         | Order by condition. Allowed values (case sensitive): asc, desc (default: desc)                             | desc                                                                                                       |
| `pageSize`                                                                                                 | *number*                                                                                                   | :heavy_minus_sign:                                                                                         | Page size to fetch the events and is set to 50 by default                                                  |                                                                                                            |
| `propertyFilters`                                                                                          | Record<string, *string*[]>                                                                                 | :heavy_minus_sign:                                                                                         | Property filters to filter the events by the keys in `properties` field of the event                       |                                                                                                            |
| `sort`                                                                                                     | *string*                                                                                                   | :heavy_minus_sign:                                                                                         | Sort by the field. Allowed values (case sensitive): timestamp, event_name (default: timestamp)             | timestamp                                                                                                  |
| `source`                                                                                                   | *string*                                                                                                   | :heavy_minus_sign:                                                                                         | Source to filter the events by the source                                                                  |                                                                                                            |
| `startTime`                                                                                                | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)              | :heavy_minus_sign:                                                                                         | Start time of the events to be fetched in ISO 8601 format<br/>Defaults to last 7 days from now if not provided | 2024-11-09T00:00:00Z                                                                                       |