HyperDX External API (2.0.0)

Download OpenAPI specification:Download

API for managing HyperDX alerts and dashboards

Dashboards

Endpoints for managing dashboards and their visualizations

List Dashboards

Retrieves a list of all dashboards for the authenticated team

Authorizations:

BearerAuth

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "65f5e4a3b9e77c001a567890",
"name": "Infrastructure Monitoring",
"tiles": [{"id": "65f5e4a3b9e77c001a901234",
"name": "Server CPU",
"x": 0,
"y": 0,
"w": 6,
"h": 3,
"config": {"displayType": "line",
"sourceId": "65f5e4a3b9e77c001a111111",
"select": [{"aggFn": "avg",
"valueExpression": "cpu.usage",
"where": "host:server-01"
}
]
}
}
],
"tags": ["infrastructure",
"monitoring"
],
"filters": [{"id": "65f5e4a3b9e77c001a301001",
"type": "QUERY_EXPRESSION",
"name": "Environment",
"expression": "environment",
"sourceId": "65f5e4a3b9e77c001a111111"
}
]
},
{"id": "65f5e4a3b9e77c001a567891",
"name": "API Monitoring",
"tiles": [{"id": "65f5e4a3b9e77c001a901235",
"name": "API Errors",
"x": 0,
"y": 0,
"w": 6,
"h": 3,
"config": {"displayType": "table",
"sourceId": "65f5e4a3b9e77c001a111112",
"select": [{"aggFn": "count",
"where": "level:error"
}
],
"groupBy": "service",
"orderBy": "count DESC"
}
}
],
"tags": ["api",
"monitoring"
],
"filters": [{"id": "65f5e4a3b9e77c001a301002",
"type": "QUERY_EXPRESSION",
"name": "Service",
"expression": "service_name",
"sourceId": "65f5e4a3b9e77c001a111112"
}
]
}
]
}

Create Dashboard

Creates a new dashboard

Authorizations:

BearerAuth

Request Body schema: application/json
required

name required	string <= 1024 characters
required	Array of objects (TileInput)
tags	Array of strings <= 50 items [ items <= 32 characters ]
	Array of objects (FilterInput) Dashboard filter keys to add to the dashboard and apply across all tiles

Responses

Request samples

Payload

Content type

application/json

Example

Dashboard with a line chart

{"name": "API Monitoring Dashboard",
"tiles": [{"name": "API Request Volume",
"x": 0,
"y": 0,
"w": 6,
"h": 3,
"config": {"displayType": "line",
"sourceId": "65f5e4a3b9e77c001a111111",
"select": [{"aggFn": "count",
"where": "service:api"
}
]
}
}
],
"tags": ["api",
"monitoring"
],
"filters": [{"type": "QUERY_EXPRESSION",
"name": "Environment",
"expression": "environment",
"sourceId": "65f5e4a3b9e77c001a111111"
}
]
}

Response samples

200
400
401
500

Content type

application/json

{"data": {"id": "65f5e4a3b9e77c001a567890",
"name": "API Monitoring Dashboard",
"tiles": [{"id": "65f5e4a3b9e77c001a901234",
"name": "API Request Volume",
"x": 0,
"y": 0,
"w": 6,
"h": 3,
"config": {"displayType": "line",
"sourceId": "65f5e4a3b9e77c001a111111",
"select": [{"aggFn": "count",
"where": "service:api"
}
]
}
}
],
"tags": ["api",
"monitoring"
],
"filters": [{"id": "65f5e4a3b9e77c001a301004",
"type": "QUERY_EXPRESSION",
"name": "Environment",
"expression": "environment",
"sourceId": "65f5e4a3b9e77c001a111111"
}
]
}
}

Get Dashboard

Retrieves a specific dashboard by ID

Authorizations:

BearerAuth

path Parameters

id

required

string

Example: 65f5e4a3b9e77c001a567890

Dashboard ID

Responses

Response samples

200
401
404

Content type

application/json

{"data": {"id": "65f5e4a3b9e77c001a567890",
"name": "Infrastructure Monitoring",
"tiles": [{"id": "65f5e4a3b9e77c001a901234",
"name": "Server CPU",
"x": 0,
"y": 0,
"w": 6,
"h": 3,
"config": {"displayType": "line",
"sourceId": "65f5e4a3b9e77c001a111111",
"select": [{"aggFn": "avg",
"valueExpression": "cpu.usage",
"where": "host:server-01"
}
]
}
},
{"id": "65f5e4a3b9e77c001a901235",
"name": "Memory Usage",
"x": 6,
"y": 0,
"w": 6,
"h": 3,
"config": {"displayType": "line",
"sourceId": "65f5e4a3b9e77c001a111111",
"select": [{"aggFn": "avg",
"valueExpression": "memory.usage",
"where": "host:server-01"
}
]
}
}
],
"tags": ["infrastructure",
"monitoring"
],
"filters": [{"id": "65f5e4a3b9e77c001a301003",
"type": "QUERY_EXPRESSION",
"name": "Environment",
"expression": "environment",
"sourceId": "65f5e4a3b9e77c001a111111"
}
]
}
}

Update Dashboard

Updates an existing dashboard

Authorizations:

BearerAuth

path Parameters

id

required

string

Example: 65f5e4a3b9e77c001a567890

Dashboard ID

Request Body schema: application/json
required

name required	string <= 1024 characters
required	Array of objects (TileInput) Full list of tiles for the dashboard. Existing tiles are matched by ID; tiles with an ID that does not match an existing tile will be assigned a new generated ID.
tags	Array of strings <= 50 items [ items <= 32 characters ]
	Array of objects (Filter) Dashboard filter keys on the dashboard, applied across all tiles

Responses

Request samples

Payload

Content type

application/json

{"name": "Updated Dashboard Name",
"tiles": [{"id": "65f5e4a3b9e77c001a901234",
"name": "Updated Line Chart",
"x": 0,
"y": 0,
"w": 6,
"h": 3,
"config": {"displayType": "line",
"sourceId": "65f5e4a3b9e77c001a111111",
"select": [{"aggFn": "count",
"where": "level:error"
}
]
}
},
{"id": "new-tile-123",
"name": "New Number Chart",
"x": 6,
"y": 0,
"w": 6,
"h": 3,
"config": {"displayType": "number",
"sourceId": "65f5e4a3b9e77c001a111111",
"select": [{"aggFn": "count",
"where": "level:info"
}
]
}
}
],
"tags": ["production",
"updated"
],
"filters": [{"id": "65f5e4a3b9e77c001a301005",
"type": "QUERY_EXPRESSION",
"name": "Environment",
"expression": "environment",
"sourceId": "65f5e4a3b9e77c001a111111"
}
]
}

Response samples

200
400
401
404
500

Content type

application/json

{"data": {"id": "65f5e4a3b9e77c001a567890",
"name": "Updated Dashboard Name",
"tiles": [{"id": "65f5e4a3b9e77c001a901234",
"name": "Updated Line Chart",
"x": 0,
"y": 0,
"w": 6,
"h": 3,
"config": {"displayType": "line",
"sourceId": "65f5e4a3b9e77c001a111111",
"select": [{"aggFn": "count",
"where": "level:error"
}
]
}
},
{"id": "new-tile-123",
"name": "New Number Chart",
"x": 6,
"y": 0,
"w": 6,
"h": 3,
"config": {"displayType": "number",
"sourceId": "65f5e4a3b9e77c001a111111",
"select": [{"aggFn": "count",
"where": "level:info"
}
]
}
}
],
"tags": ["production",
"updated"
],
"filters": [{"id": "65f5e4a3b9e77c001a301005",
"type": "QUERY_EXPRESSION",
"name": "Environment",
"expression": "environment",
"sourceId": "65f5e4a3b9e77c001a111111"
}
]
}
}

Delete Dashboard

Deletes a dashboard

Authorizations:

BearerAuth

path Parameters

id

required

string

Example: 65f5e4a3b9e77c001a567890

Dashboard ID

Responses

Response samples

200
401
404

Content type

application/json

{ }

Alerts

Endpoints for managing monitoring alerts

Get Alert

Retrieves a specific alert by ID

Authorizations:

BearerAuth

path Parameters

id

required

string

Example: 65f5e4a3b9e77c001a123456

Alert ID

Responses

Response samples

200
401
404

Content type

application/json

{"data": {"id": "65f5e4a3b9e77c001a123456",
"threshold": 80,
"interval": "5m",
"thresholdType": "above",
"source": "tile",
"state": "ALERT",
"channel": {"type": "webhook",
"webhookId": "65f5e4a3b9e77c001a789012"
},
"teamId": "65f5e4a3b9e77c001a345678",
"tileId": "65f5e4a3b9e77c001a901234",
"dashboardId": "65f5e4a3b9e77c001a567890",
"createdAt": "2023-03-15T10:20:30.000Z",
"updatedAt": "2023-03-15T14:25:10.000Z"
}
}

Update Alert

Updates an existing alert

Authorizations:

BearerAuth

path Parameters

id

required

string

Example: 65f5e4a3b9e77c001a123456

Alert ID

Request Body schema: application/json
required

dashboardId	string or null Dashboard ID for tile-based alerts.
tileId	string or null Tile ID for tile-based alerts.
savedSearchId	string or null Saved search ID for saved_search alerts.
groupBy	string or null Group-by key for saved search alerts.
threshold required	number Threshold value for triggering the alert.
interval required	string (AlertInterval) Enum: "1m" "5m" "15m" "30m" "1h" "6h" "12h" "1d" Evaluation interval.
source	string (AlertSource) Enum: "saved_search" "tile" Alert source type.
thresholdType required	string (AlertThresholdType) Enum: "above" "below" Threshold comparison direction.
required	any (AlertChannel)
name	string or null Human-friendly alert name.
message	string or null Alert message template.

Responses

Request samples

Payload

Content type

application/json

{"threshold": 500,
"interval": "1h",
"thresholdType": "above",
"source": "tile",
"dashboardId": "65f5e4a3b9e77c001a567890",
"tileId": "65f5e4a3b9e77c001a901234",
"channel": {"type": "webhook",
"webhookId": "65f5e4a3b9e77c001a789012"
},
"name": "Updated Alert Name",
"message": "Updated threshold and interval"
}

Response samples

200
401
404
500

Content type

application/json

{"data": {"dashboardId": "65f5e4a3b9e77c001a567890",
"tileId": "65f5e4a3b9e77c001a901234",
"savedSearchId": "65f5e4a3b9e77c001a345678",
"groupBy": "ServiceName",
"threshold": 100,
"interval": "1m",
"source": "saved_search",
"thresholdType": "above",
"channel": {"type": "webhook",
"webhookId": "65f5e4a3b9e77c001a789012"
},
"name": "Test Alert",
"message": "Test Alert Message",
"id": "65f5e4a3b9e77c001a123456",
"state": "ALERT",
"teamId": "65f5e4a3b9e77c001a345678",
"silenced": {"by": "string",
"at": "2019-08-24T14:15:22Z",
"until": "2019-08-24T14:15:22Z"
},
"createdAt": "2023-01-01T00:00:00.000Z",
"updatedAt": "2023-01-01T00:00:00.000Z"
}
}

Delete Alert

Deletes an alert

Authorizations:

BearerAuth

path Parameters

id

required

string

Example: 65f5e4a3b9e77c001a123456

Alert ID

Responses

Response samples

200
401
404

Content type

application/json

{ }

List Alerts

Retrieves a list of all alerts for the authenticated team

Authorizations:

BearerAuth

Responses

Response samples

200
401

Content type

application/json

{"data": [{"id": "65f5e4a3b9e77c001a123456",
"threshold": 100,
"interval": "15m",
"thresholdType": "above",
"source": "tile",
"state": "OK",
"channel": {"type": "webhook",
"webhookId": "65f5e4a3b9e77c001a789012"
},
"teamId": "65f5e4a3b9e77c001a345678",
"tileId": "65f5e4a3b9e77c001a901234",
"dashboardId": "65f5e4a3b9e77c001a567890",
"createdAt": "2023-01-01T00:00:00.000Z",
"updatedAt": "2023-01-01T00:00:00.000Z"
}
]
}

Create Alert

Creates a new alert

Authorizations:

BearerAuth

Request Body schema: application/json
required

dashboardId	string or null Dashboard ID for tile-based alerts.
tileId	string or null Tile ID for tile-based alerts.
savedSearchId	string or null Saved search ID for saved_search alerts.
groupBy	string or null Group-by key for saved search alerts.
threshold required	number Threshold value for triggering the alert.
interval required	string (AlertInterval) Enum: "1m" "5m" "15m" "30m" "1h" "6h" "12h" "1d" Evaluation interval.
source	string (AlertSource) Enum: "saved_search" "tile" Alert source type.
thresholdType required	string (AlertThresholdType) Enum: "above" "below" Threshold comparison direction.
required	any (AlertChannel)
name	string or null Human-friendly alert name.
message	string or null Alert message template.

Responses

Request samples

Payload

Content type

application/json

{"dashboardId": "65f5e4a3b9e77c001a567890",
"tileId": "65f5e4a3b9e77c001a901234",
"threshold": 100,
"interval": "1h",
"source": "tile",
"thresholdType": "above",
"channel": {"type": "webhook",
"webhookId": "65f5e4a3b9e77c001a789012"
},
"name": "Error Spike Alert",
"message": "Error rate has exceeded 100 in the last hour"
}

Response samples

200
401
500

Content type

application/json

{"data": {"dashboardId": "65f5e4a3b9e77c001a567890",
"tileId": "65f5e4a3b9e77c001a901234",
"savedSearchId": "65f5e4a3b9e77c001a345678",
"groupBy": "ServiceName",
"threshold": 100,
"interval": "1m",
"source": "saved_search",
"thresholdType": "above",
"channel": {"type": "webhook",
"webhookId": "65f5e4a3b9e77c001a789012"
},
"name": "Test Alert",
"message": "Test Alert Message",
"id": "65f5e4a3b9e77c001a123456",
"state": "ALERT",
"teamId": "65f5e4a3b9e77c001a345678",
"silenced": {"by": "string",
"at": "2019-08-24T14:15:22Z",
"until": "2019-08-24T14:15:22Z"
},
"createdAt": "2023-01-01T00:00:00.000Z",
"updatedAt": "2023-01-01T00:00:00.000Z"
}
}

Charts

Query Chart Series Data

Retrieves time series data based on configured series parameters

Authorizations:

BearerAuth

Request Body schema: application/json
required

required	Array of objects (ChartSeries) [ 1 .. 5 ] items Array of series configurations
startTime required	number Start timestamp in milliseconds
endTime required	number End timestamp in milliseconds
granularity	string Enum: "30s" "1m" "5m" "10m" "15m" "30m" "1h" "2h" "6h" "12h" "1d" "2d" "7d" "30d" "auto" Time bucket size for aggregations
seriesReturnType	string Enum: "ratio" "column" Format of the returned data

Responses

Request samples

Payload

Content type

application/json

Example

Basic time series query

{"startTime": 1647014400000,
"endTime": 1647100800000,
"granularity": "1h",
"series": [{"sourceId": "65f5e4a3b9e77c001a123456",
"aggFn": "count",
"where": "SeverityText:error",
"groupBy": [ ]
}
]
}

Response samples

200
400
403
404
500

Content type

application/json

Example

Time series data points

{"data": [{"ts_bucket": 1647014400000,
"series_0.data": 42
},
{"ts_bucket": 1647018000000,
"series_0.data": 37
},
{"ts_bucket": 1647021600000,
"series_0.data": 53
}
]
}

Sources

List Sources

Retrieves a list of all sources for the authenticated team

Authorizations:

BearerAuth

Responses

Response samples

200
401
403

Content type

application/json

{"data": [{"id": "string",
"name": "string",
"kind": "log",
"connection": "string",
"from": {"databaseName": "string",
"tableName": "string"
},
"querySettings": [{"setting": "string",
"value": "string"
}
],
"defaultTableSelectExpression": "string",
"timestampValueExpression": "string",
"serviceNameExpression": "string",
"severityTextExpression": "string",
"bodyExpression": "string",
"eventAttributesExpression": "string",
"resourceAttributesExpression": "string",
"displayedTimestampValueExpression": "string",
"metricSourceId": "string",
"traceSourceId": "string",
"traceIdExpression": "string",
"spanIdExpression": "string",
"implicitColumnExpression": "string",
"highlightedTraceAttributeExpressions": [{"sqlExpression": "string",
"luceneExpression": "string",
"alias": "string"
}
],
"highlightedRowAttributeExpressions": [{"sqlExpression": "string",
"luceneExpression": "string",
"alias": "string"
}
],
"materializedViews": [{"databaseName": "string",
"tableName": "string",
"dimensionColumns": "string",
"minGranularity": "1s",
"minDate": "2019-08-24T14:15:22Z",
"timestampColumn": "string",
"aggregatedColumns": [{"sourceColumn": "string",
"aggFn": "string",
"mvColumn": "string"
}
]
}
]
}
]
}

HyperDX External API (2.0.0)

Dashboards

List Dashboards

Authorizations:

Responses

Response samples

Create Dashboard

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Dashboard

Authorizations:

path Parameters

Responses

Response samples

Update Dashboard

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Dashboard

Authorizations:

path Parameters

Responses

Response samples

Alerts

Get Alert

Authorizations:

path Parameters

Responses

Response samples

Update Alert

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Alert

Authorizations:

path Parameters

Responses

Response samples

List Alerts

Authorizations:

Responses

Response samples

Create Alert

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Charts

Query Chart Series Data

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Sources

List Sources

Authorizations:

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required