Руководство
Типы данных
Типы данных при работе с API Status200.
Select
Select can be used to select fields from an Object in List or Get Item API. By default only IDs are returned. Use a select object mapping field names to booleans.
Example Select Request Body
{
"select": {
"name": true,
// other fields
}
}Sort
Sort list results by field. Default is createdAt descending. Use a sort object with field names mapped to ASC or DESC.
Example Sort Request Body
{
"sort": {
"name": "ASC",
// other fields
}
}Query
Equal To
Filter with exact equality on a field using Equal To.
Example EqualTo Request Body
{
"query": {
"age": {
"_type": "EqualTo",
value: 10
}
}
}Equal To Or Null
Match a field equal to a value or null.
Example EqualToOrNull Request Body
{
"query": {
"age": {
"_type": "EqualToOrNull",
value: 10
}
}
}Not Equal To
Exclude rows where a field equals a value.
Example Not EqualTo Request Body
{
"query": {
"name": {
"_type": "NotEqual",
"value": "Hello"
}
}
}Is Null
Match rows where a field is null.
Example
{
"query": {
"age": {
"_type": "IsNull"
}
}
}Is Not Null
Match rows where a field is not null.
Example
{
"query": {
"age": {
"_type": "NotNull"
}
}
}Greater Than
Numeric or date comparisons: greater than.
Example
{
"query": {
"age": {
"_type": "GreaterThan",
"value": 10
}
}
}Greater Than or Equal
Greater than or equal comparison.
Example
{
"query": {
"age": {
"_type": "GreaterThanOrEqual",
"value": 10
}
}
}Less Than
Less than comparison.
Example
{
"query": {
"age": {
"_type": "LessThan",
"value": 10
}
}
}Less Than or Equal
Less than or equal comparison.
Example
{
"query": {
"age": {
"_type": "LessThanOrEqual",
"value": 10
}
}
}Includes
Match if a field value is in a set of values (array).
Example
{
"query": {
"labels": {
"_type": "Includes",
"value": [
"aaa00000-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"bbb00000-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
]
}
}
}All types
General
- ObjectIDA unique identifier for objects, typically a UUID string.
- DecimalA decimal number type for precise numeric values.
- NameA structured name type representing a text name value.
- EqualToA query filter that matches objects where a field is equal to the specified value.
- EqualToOrNullA query filter that matches objects where a field is equal to the specified value or is null.
- RecurringObject describing a recurring interval schedule (e.g., every 5 minutes, daily).
- RestrictionTimesObject describing on-call duty time restrictions (daily or weekly windows).
- PositiveNumberA number type that must be greater than zero.
- NotEqualA query filter that matches objects where a field is not equal to the specified value.
- EmailAn email address type with built-in format validation.
- PhoneA phone number type with built-in format validation.
- ColorA color value represented as a hex string (e.g., #3498db).
- DomainA domain name type (e.g., example.com).
- VersionA semantic version type (e.g., 1.0.0).
- IPAn IP address type supporting both IPv4 and IPv6 formats.
- RouteA URL route/path segment type.
- URLA full URL type with protocol, host, and path.
- PermissionA string identifier representing an access control permission in Status200.
- SearchA query filter for text search that matches objects containing the specified string.
- GreaterThanA query filter that matches objects where a field is greater than the specified value.
- GreaterThanOrEqualA query filter that matches objects where a field is greater than or equal to the specified value.
- GreaterThanOrNullA query filter that matches objects where a field is greater than the specified value or is null.
- LessThanOrNullA query filter that matches objects where a field is less than the specified value or is null.
- LessThanA query filter that matches objects where a field is less than the specified value.
- LessThanOrEqualA query filter that matches objects where a field is less than or equal to the specified value.
- PortA network port number type (1-65535).
- HostnameA hostname type (e.g., api.example.com).
- HashedStringA string that is stored in hashed form. Used for sensitive data like passwords and API keys.
- DateTimeAn ISO 8601 date-time string (e.g., 2024-01-15T10:30:00.000Z).
- BufferA binary data buffer, typically base64-encoded when serialized to JSON.
- InBetweenA query filter that matches objects where a field value is between two specified values (inclusive).
- NotNullA query filter that matches objects where a field is not null.
- IsNullA query filter that matches objects where a field is null.
- IncludesA query filter that matches objects where a field value is included in the specified array of values.
- DashboardComponentA configuration object for a dashboard component including its type, layout, and settings.
- DashboardViewConfigA configuration object for a dashboard view including its components and layout.
Monitor
- MonitorStepsComplex nested object describing monitor check configuration including steps and default status.
- MonitorStepA single monitor step defining a check target, request configuration, and criteria for determining status.
- MonitorCriteriaA collection of monitor criteria instances used to evaluate monitor check results.
- MonitorCriteriaInstanceA single criteria rule defining conditions and the resulting monitor status when conditions are met.
- CriteriaFilterA single filter condition within a MonitorCriteriaInstance that defines what to check and how to compare it.
- CriteriaIncidentConfiguration for an incident that is automatically created when a MonitorCriteriaInstance's conditions are met.
- CriteriaAlertConfiguration for an alert that is automatically created when a MonitorCriteriaInstance's conditions are met.
- CheckOnEnum specifying what aspect of a monitor response to evaluate (e.g., response code, response time, body content).
- FilterTypeEnum specifying the comparison operator used in a CriteriaFilter (e.g., Equal To, Greater Than, Contains).
- FilterConditionEnum specifying how multiple filters are combined: 'All' (AND) or 'Any' (OR).
- MonitorStepLogMonitorConfiguration for a Log monitor step, defining which logs to query and evaluate.
- MonitorStepTraceMonitorConfiguration for a Trace monitor step, defining which spans to query and evaluate.
- MonitorStepMetricMonitorConfiguration for a Metric monitor step, defining which metrics to query and evaluate.
- MonitorStepSnmpMonitorConfiguration for an SNMP monitor step, defining the SNMP device connection and OIDs to query.