| Key | Type | Required | Field Type | Relation | Default | Constraints | Enum | Description | |
|---|---|---|---|---|---|---|---|---|---|
period Period | Int | Required | property | - | 0 | - | - | Time period | |
countryCode Country Code | String | Optional | property | - | null | - | - | ISO country code | |
countryName Country Name | String | Optional | property | - | null | - | - | Name of the country | |
city City | String | Optional | property | - | null | - | - | City name | |
postal Postal | Int | Optional | property | - | null | - | - | Postal code | |
location Location | Coordinate | Optional | property | - | null | - | - | Geographic location | |
ipv4 IPv4 | String | Optional | property | - | null | - | - | IPv4 address | |
state State | String | Optional | property | - | null | - | - | State or province | |
osName OS Name | String | Optional | property | - | null | - | - | Operating system name | |
osVersion OS Version | String | Optional | property | - | null | - | - | Operating system version | |
browserName Browser Name | String | Optional | property | - | null | - | - | Web browser name | |
browserVersion Browser Version | String | Optional | property | - | null | - | - | Web browser version | |
mobileModel Mobile Model | String | Optional | property | - | null | - | - | Mobile device model | |
mobileVendor Mobile Vendor | String | Optional | property | - | null | - | - | Mobile device vendor | |
deviceType Device Type | String | Optional | property | - | null | - | - | Type of device | |
at At | Date | Required | property | - | [function] | - | - | Access time |
| Key | Type | Required | Field Type | Relation | Default | Constraints | Enum | Description | |
|---|---|---|---|---|---|---|---|---|---|
request Request | Int | Required | property | - | 0 | - | - | Number of requests | |
device Device | Int | Required | property | - | 0 | - | - | Number of devices | |
ip IP | Int | Required | property | - | 0 | - | - | Number of unique IPs | |
country Country | Int | Required | property | - | 0 | - | - | Number of countries |
| Key | Type | Required | Field Type | Relation | Default | Constraints | Enum | Description | |
|---|---|---|---|---|---|---|---|---|---|
jwt JWT | String | Required | property | - | null | - | - | JSON Web Token | |
refreshToken Refresh Token | String | Optional | property | - | null | - | - | Refresh token for token renewal | |
expiresAt Expires At | Date | Optional | property | - | null | - | - | Access token expiration time |
| Key | Type | Required | Field Type | Relation | Default | Constraints | Enum | Description | |
|---|---|---|---|---|---|---|---|---|---|
type Type | String | Required | property | - | Point | - | Point | Coordinate type | |
coordinates Coordinates | [Float] | Required | property | - | [0,0] | - | - | Longitude and latitude values | |
altitude Altitude | Float | Required | property | - | 0 | - | - | Altitude in meters |
| Key | Type | Required | Field Type | Relation | Default | Constraints | Enum | Description | |
|---|---|---|---|---|---|---|---|---|---|
docs Documents | Any | Required | property | - | [] | - | - | Search result documents | |
skip Skip | Int | Required | property | - | 0 | - | - | Number of results skipped | |
limit Limit | Int | Required | property | - | 20 | - | - | Maximum number of results | |
sort Sort | String | Required | property | - | notImplemented | - | - | Sort order | |
total Total | Int | Required | property | - | 0 | - | - | Total number of results |
| Key | Ref Name | Type | Values | Used By |
|---|---|---|---|---|
| coordinateType | coordinateType | String | coordinate.type | |
| responsive | responsive | String | - |