Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
id: create-alert
title: "Create Alert"
description: "Creates a new alert"
sidebar_label: "Create Alert"
hide_title: true
hide_table_of_contents: true
api: eJzdV21P40YQ/iur/QwXJxA48g04qjtVVRFwUlXEh4k9xHvYu+7uGkij/PfO7Dq2AwmFE6erGkWR4533eebxeCEzdKlVlVdGy4k8tQgenQCh8UFAgdbLHWkqtMASXzKSSYPMcXPmYebk5FqG/07e7EiLf9Xo/InJ5nKyCH+VRdL0tsYdmRrtUXs+gqoqVBosD745DmAhXZpjCXzl5xWSOzP9hil76gxdS59bdLkpMrqvyJ69h4IunaltihzV6vyKjZDTHLTGgsOrLKfjFTp2koHLpwZsxqm1Pp23Ss9IDx+hrAq+dTC+HeM+7E2P8PAwTZIhjA8OPx4lckneVIFv1z9KhqO9/aDfZtOZ0HU5Rds3MUySZS/bF70Nc7bblGOTJJkPdaTIuW4INs25Op2JcLR8WsoXbMHU3LOxKRbmYd1WPFp2fdjQ3vW++G3OWpsPOM2NuWOrzeXbW8ANHI7kcklGNJT/4vGKUC0i7km+ROdg9moV8VsjvwyA8eH4tBulizg1bLlRj3WgLkSXPBt1WYKdt4o0pny+OwWHWTutBI4an2F7O4A7/G4H6RpGCYh9HDLYOqytIPUENi06niNg1ci1Pr7QrFWr5Jm1xorLSt2hWNFR25Xm1HKZcnACH1PEjMpE0Qulhc9RFEDdySlwRkAAAcVcGe1i7UdJEsq4xpCXdZqSj9u6KOYiUmFX+u/mtqek5F8hpd4Md27l+EC+Cuyf1SwXsYYXlOOrEd8reyy5Ex10fgzXjct356l3YU7nuXAvxq40pF7957nRI5Rv1WeoHX58j8djy2Pf/4R2cI/ZZezVBiOaphmmbIV3FJKfWVNXJ/NXyTpKT6fYj25qTIGgN0k3lHHsN9m+NbYEOmEGwF2vSlzLcJSM9naTIX2vkmQSvh+SJPmTM6yr7AfY7T2rmgff0zsXDWPKSKD7yfA5Z37VUPvcWPU3Zu/HklvpqB9joKMmtvFGPieGQSsw0BZ9iW5UFgISt6CK2uJPizhQLtWNH4eVccEeeAKwHEClBvejAcSlm2mIs+BFfCFryw/lAd1dz/TcmqxOQ2bH519EVCHobNc4ra2ltFvRG3aU1lb5efB0QgOF9rjmmK5v+seXXJGYdF+ozTv3vuKwgxgPTBAKpMwXv6zwyoH+ivNQIK72RfducbaC7/9/0ektnv0NZ9NyyfHemrg5Rjx9Juf20x/i7JHy0FBw8591mutMJCFK0DAjRIqVVkSYAJ2JtsoMOEZbVB19ILJgxwxR0mffTdzNlrqKfM3lohuqLW+dTdU8PvpBVYDSgeZsqGicA3qWV4qDGdEPtC+gOc8KHS4WvBh/tcVyybcJObw7X9/wimxVZGWCLSkgZIQ+hvQdhvU6hrbbvD02G/Xz2efhiRrHtBVW/kXZm944n/9+ecVob96RS5OxjoUHfs+l34kMr92sHYYo3FvIAvSsjs2PNvnzDyd4Nvg=
sidebar_class_name: "post api-method"
info_path: use-cases/observability/clickstack/api-reference/hyperdx-external-api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge';

<Heading
as={"h1"}
className={"openapi__heading"}
children={"Create Alert"}
>
</Heading>
<CloudNotSupportedBadge/>

<MethodEndpoint
method={"post"}
path={"api/v2/alerts"}
context={"endpoint"}
>

</MethodEndpoint>



Creates a new alert

<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>

<ParamsDetails
parameters={undefined}
>

</ParamsDetails>

<RequestSchema
title={"Body"}
body={{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["threshold","interval","source","thresholdType","channel"],"properties":{"dashboardId":{"type":"string","example":"65f5e4a3b9e77c001a567890"},"tileId":{"type":"string","example":"65f5e4a3b9e77c001a901234"},"threshold":{"type":"number","example":100},"interval":{"type":"string","example":"1h"},"source":{"type":"string","enum":["tile","search"],"example":"tile"},"thresholdType":{"type":"string","enum":["above","below"],"example":"above"},"channel":{"type":"object","properties":{"type":{"type":"string","example":"webhook"},"webhookId":{"type":"string","example":"65f5e4a3b9e77c001a789012"}}},"name":{"type":"string","example":"Test Alert"},"message":{"type":"string","example":"Test Alert Message"}},"title":"CreateAlertRequest"},"examples":{"tileAlert":{"summary":"Create a tile-based alert","value":{"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"}}}}}}}
>

</RequestSchema>

<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successfully created alert","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","example":"65f5e4a3b9e77c001a123456"},"name":{"type":"string","example":"High Error Rate"},"message":{"type":"string","example":"Error rate exceeds threshold"},"threshold":{"type":"number","example":100},"interval":{"type":"string","example":"15m"},"thresholdType":{"type":"string","enum":["above","below"],"example":"above"},"source":{"type":"string","enum":["tile","search"],"example":"tile"},"state":{"type":"string","example":"inactive"},"channel":{"type":"object","properties":{"type":{"type":"string","example":"webhook"},"webhookId":{"type":"string","example":"65f5e4a3b9e77c001a789012"}}},"team":{"type":"string","example":"65f5e4a3b9e77c001a345678"},"tileId":{"type":"string","example":"65f5e4a3b9e77c001a901234"},"dashboard":{"type":"string","example":"65f5e4a3b9e77c001a567890"},"savedSearch":{"type":"string","nullable":true},"groupBy":{"type":"string","nullable":true},"silenced":{"type":"boolean","nullable":true},"createdAt":{"type":"string","format":"date-time","example":"2023-01-01T00:00:00.000Z"},"updatedAt":{"type":"string","format":"date-time","example":"2023-01-01T00:00:00.000Z"}},"title":"Alert"}},"title":"AlertResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"title":"Error"}}}},"500":{"description":"Server error or validation failure","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"title":"Error"}}}}}}
>

</StatusCodes>



Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
id: create-dashboard
title: "Create Dashboard"
description: "Creates a new dashboard"
sidebar_label: "Create Dashboard"
hide_title: true
hide_table_of_contents: true
api: eJztWW1v2zYQ/iuEPm2Am7hJk67+liYpGqxruiQdBgRGQEu0zJYSVZJy4hn+77s70hIVvyQNNmwokgCxQt3xjg+Pzz2S50kmbGpk5aQuk0FybAR3wjLOSnHLMm4nI81NlvQSXQnD0eosA7uU7E6i+47nNhlcJ82YTYa9xIhvtbDurc5myWBO/0ojYAZnatFLUl06UTq8xatKyZQi7H6xmMw8selEFByv3KwSEFaPvojUJb1oouuk5IXAWJXBHJ0UFj1otPW0zsgyB09xx4tK4dBHWGG7ggUsQSrvG3y4MXwGLtKJwq7LohtRZtvjHR6MD8Qrvj96I16/Tvv9l/xN/+Xe/isM/XC2p8Zowy4AdbS/i4wlYJgLE1v3wWT2sMntdpNDMJlsN9kHE24vcNsiw5HWSvAyNhxzZQUYW2Hk94Ecb7XVtUnFGdYbz/N3GOF2IoyAz9zouno7Wy2ExmcNvN3iPztheszcREDhO868IxsD7G4iLQupb99S3NCDQ9win+CDQY/y3Iic6p6N6zKlC6dZbQXDq5ANhi3rAkHgU5wl1XXplp83mbROloSX4tbdTLmqEZWC3+FfiUh9q3mJJQ6XFmYaxgvxs0HWYynUI6B6h2aYJg/piw4uWe25Amf0G/SIGZUThgEjZJIwkCX7UKeiFAwoxMyYnZWOVtOGUWIq1EDgyWgifeBlXvP8ERF/p2lVsEfAMwyKiNNMLFUcBiPkFeWD+H1TXfzCnUVbh6sVvgZBixCSB4U1wtbKWTZadyDCKhZR2Gs8TlOZYkoTbV0yhLuFAMP04wZC6SaBVsua937sJ6z3cB0dA/tzB/mJc9VNIHd747TjKmlin4DbFcV9KD5aYfwoXgQ3VikAyuucFgglrnPD71Wuv43svSHicjYnC0F9akRHAEZHxGXtvMhO3KQTOjfma6Zvy24smgJCYZ6XBMu2gFCcpUO+8Kuz3bnC3QX1HUdDxxNu3KVnmUV84wpPLQ1Qk32QO9eWSoaHRVcF9tthJ2y3l1/4XY28PY1KvLwCBHyGbefEm3UBiEHRt+2f3Uo3YYhYIE6W4vIgW89NTYtOjj6dsd90KZ3GrFlHVPiOfN2xDQmyP7SqaUuhGfap3/WppR1S19qPGhM1n7b3XDdAhZqI97PdtkDgDdMGIlueuQGvZNR3BtfDBfy2QsjfLpqFedBTjTDePQ69AthAgrmHjmHSdg2Alz4h9l5wBV7nU/xf3K7Db4ndcVjTfwTdiKdfRZmtwNdrEvVy50RiKY9qogvK9vCJ2YZT/33pxv0lTjWhIaI42HCrjTs3GZDJgOgt6dZBWPOLCe2OV41ZTX0eS2JBJx2Yv9Kl9Udtr9/Hjy5VXtYpsLAd10rNmJffWUegP1lLd+UScfC/oHUPDl//8qb/OK27LOimkp/F+bM4fxbnz+L8WZw/i/MfUpxHmmBVMy4jRS+r1o1eBA1xX7kHsbBBch7flxJsqUVipblUBdhGNzf33ndJ+g1zhb7b+0EkfxB4r/ovVzXd55LXbgKmf4l/UMEVIBPXcmxcNadLXm6KMHLsJMY4Cc8dhhvxVcwYdNtCWosbC2wkSygSme0kfp0Ha7UrwAftg3oB+pBH6Kpcqpo0wv9n9e1T2L1ERTZgWJUIQaN8wgYDj0w0VnSFXA9ZcRD7g2QXamJ3urebta/FqSoBD1+WtVFotsK+nxpGIOC9S4JPSJs8jmtjAMDGFB9NRFob6WYU6S3wpzBHNeZ1PYxvXyK2Hr7YqEEQGwqmTWYoIckIRvzFO20K7sJR/VXMCGrct4v27f9pC3Q4193X708ghkh0P4kQWu25WSquUkLQYK2K2vS4eE/wtPokeo68rxC6AmFtI1/t400TfpjhunTVfSMEnaoc+weFcErew3zm5E92egfir+QKC3FVIsOekyrhJc+RE5ZeXMGhtIyXUW+htxdQ+d51b6e/Q0+EeGTAPyoO35U69dEJO2/pYst3VktAxJ3brRSXJHnp+MzD+Vxy9nSPEIu/uqIdAYP5fMSt+GzUYoHDpHfxAGF3NJIECx4ncBCcXgJAaQFNYmI+xRe0TU0zXWU3PNTe4wiotnJbbYcR1Xw6v7zCUxi+XSt0hj6G46sf/DtIEvziDr3pcNPYPFFtUfo58edvQYJ3Tw==
sidebar_class_name: "post api-method"
info_path: use-cases/observability/clickstack/api-reference/hyperdx-external-api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge';

<Heading
as={"h1"}
className={"openapi__heading"}
children={"Create Dashboard"}
>
</Heading>
<CloudNotSupportedBadge/>

<MethodEndpoint
method={"post"}
path={"api/v2/dashboards"}
context={"endpoint"}
>

</MethodEndpoint>



Creates a new dashboard

<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>

<ParamsDetails
parameters={undefined}
>

</ParamsDetails>

<RequestSchema
title={"Body"}
body={{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"New Dashboard"},"tiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"65f5e4a3b9e77c001a901234"},"name":{"type":"string","example":"Error Rate"},"x":{"type":"integer","example":0},"y":{"type":"integer","example":0},"w":{"type":"integer","example":6},"h":{"type":"integer","example":3},"asRatio":{"type":"boolean","example":false},"series":{"type":"array","items":{"type":"object","required":["sourceId","aggFn","where","groupBy"],"properties":{"sourceId":{"type":"string","description":"ID of the data source for this series","example":"65f5e4a3b9e77c001a123456"},"aggFn":{"type":"string","description":"Aggregation function to use on the data","enum":["avg","count","count_distinct","last_value","max","min","quantile","sum"],"example":"count"},"field":{"type":"string","description":"Field to aggregate","example":"duration"},"where":{"type":"string","description":"Filter condition in Lucene query syntax","example":"level:error"},"whereLanguage":{"type":"string","description":"Query language used in the where clause","enum":["lucene","sql"],"example":"lucene"},"groupBy":{"type":"array","description":"Fields to group the results by","items":{"type":"string"},"example":["service","host"]},"metricName":{"type":"string","description":"Name of the metric (for metric data sources)","example":"http_requests_total"},"metricDataType":{"type":"string","description":"Type of metric data","enum":["sum","gauge","histogram"],"example":"gauge"},"type":{"type":"string","enum":["time","table","number","histogram","search","markdown"],"example":"time"},"dataSource":{"type":"string","enum":["events","metrics"],"example":"events"}},"title":"ChartSeries"}}},"title":"Tile"}},"tags":{"type":"array","items":{"type":"string"},"example":["development"]}},"title":"CreateDashboardRequest"},"examples":{"simpleTimeSeriesDashboard":{"summary":"Dashboard with time series chart","value":{"name":"API Monitoring Dashboard","tiles":[{"name":"API Request Volume","x":0,"y":0,"w":6,"h":3,"asRatio":false,"series":[{"type":"time","dataSource":"events","aggFn":"count","where":"service:api","groupBy":[]}]}],"tags":["api","monitoring"]}},"complexDashboard":{"summary":"Dashboard with multiple chart types","value":{"name":"Service Health Overview","tiles":[{"name":"Request Count","x":0,"y":0,"w":6,"h":3,"asRatio":false,"series":[{"type":"time","dataSource":"events","aggFn":"count","where":"service:backend","groupBy":[]}]},{"name":"Error Distribution","x":6,"y":0,"w":6,"h":3,"asRatio":false,"series":[{"type":"table","dataSource":"events","aggFn":"count","where":"level:error","groupBy":["errorType"],"sortOrder":"desc"}]}],"tags":["service-health","production"]}}}}}}}
>

</RequestSchema>

<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successfully created dashboard","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","example":"65f5e4a3b9e77c001a567890"},"name":{"type":"string","example":"Service Overview"},"tiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"65f5e4a3b9e77c001a901234"},"name":{"type":"string","example":"Error Rate"},"x":{"type":"integer","example":0},"y":{"type":"integer","example":0},"w":{"type":"integer","example":6},"h":{"type":"integer","example":3},"asRatio":{"type":"boolean","example":false},"series":{"type":"array","items":{"type":"object","required":["sourceId","aggFn","where","groupBy"],"properties":{"sourceId":{"type":"string","description":"ID of the data source for this series","example":"65f5e4a3b9e77c001a123456"},"aggFn":{"type":"string","description":"Aggregation function to use on the data","enum":["avg","count","count_distinct","last_value","max","min","quantile","sum"],"example":"count"},"field":{"type":"string","description":"Field to aggregate","example":"duration"},"where":{"type":"string","description":"Filter condition in Lucene query syntax","example":"level:error"},"whereLanguage":{"type":"string","description":"Query language used in the where clause","enum":["lucene","sql"],"example":"lucene"},"groupBy":{"type":"array","description":"Fields to group the results by","items":{"type":"string"},"example":["service","host"]},"metricName":{"type":"string","description":"Name of the metric (for metric data sources)","example":"http_requests_total"},"metricDataType":{"type":"string","description":"Type of metric data","enum":["sum","gauge","histogram"],"example":"gauge"},"type":{"type":"string","enum":["time","table","number","histogram","search","markdown"],"example":"time"},"dataSource":{"type":"string","enum":["events","metrics"],"example":"events"}},"title":"ChartSeries"}}},"title":"Tile"}},"tags":{"type":"array","items":{"type":"string"},"example":["production","monitoring"]}},"title":"Dashboard"}},"title":"DashboardResponse"},"examples":{"createdDashboard":{"summary":"Created dashboard response","value":{"data":{"id":"65f5e4a3b9e77c001a567890","name":"API Monitoring Dashboard","tiles":[{"id":"65f5e4a3b9e77c001a901234","name":"API Request Volume","x":0,"y":0,"w":6,"h":3,"asRatio":false,"series":[{"type":"time","dataSource":"events","aggFn":"count","where":"service:api","groupBy":[]}]}],"tags":["api","monitoring"]}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"title":"Error"},"example":{"message":"Unauthorized access. API key is missing or invalid."}}}},"500":{"description":"Server error or validation failure","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"title":"Error"},"example":{"message":"Dashboard validation failed: name is required"}}}}}}
>

</StatusCodes>



Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
id: delete-alert
title: "Delete Alert"
description: "Deletes an alert"
sidebar_label: "Delete Alert"
hide_title: true
hide_table_of_contents: true
api: eJzFVE1v2zAM/SuGThsQNG6atlhu2ZJhxXYo2hUYEOTA2EyszpZUSiqaGf7vI20nTZtupwHLwdEHH/n4SLFWOfqMtAvaGjVRMywxoE/AJFAiBTVQ1iGBXF/lbJC3BtP+LsDGq8lCtXuvlgPlgKBiC5LzWhneMErnbKwlgINQ8JrwIWpC9hgo4kD5rMAK1KRWYesE4QNps1HN4BXBNlJyNWMf+ASVK8X44nx9jmM4W33Ay8ssTU/hdHQ2Pr9QzVJCeWeNRy/eR2kqfy993sYsQ+/XsSy3SZdgvk8/syagCYIC50qdtVoM771A62PidnWPmQAdiXJBt4E5j6BDS3ZeubC96UlJgvs86oZ/AzVOT4853hmIobCkf2H+z1ipitOGDb6h+yFhIktqx218zK2ribEhWdto/h89PuTWK+xzn4pHabiJGoLTw8fRsC2rH9Y6b/jSIz3uWjVSKXbqdcddk81jJptken2VdBCu258RnyIRZ783XUqgLJIO2zbSRwRCmkYhtlgeXt+KMF3uh0b79IsQnOpfi+xXrRGfdIvPlioIUhEm+hW3rU7arG3rotfrC7ui2Y9k/sSv1EApWR2lIA7WlpIKDGxY8WSH6vTj+ZAnOfhiZYFyz3CRsYOOTtKTVPraWR8YL7H7MdBNl2Q3PV6ErJ+b5q0p1AsQ8CkMXQk8SzhCW4C6L/GCW00LkxF/Opq8mPDoYYEL5iImdb0Cj3dUNo0cP0QkqQkvH4E0rEQhrlCuvay5kdZQevwL1Xc3/SR7nxyMpjfZ9odgtsISyig7Xv7kQrUjslmyVYGQc0mFRXcx5eHkwgHk6EVJB+0bfzb/Nv8+58r/Biuf/Bc=
sidebar_class_name: "delete api-method"
info_path: use-cases/observability/clickstack/api-reference/hyperdx-external-api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge';

<Heading
as={"h1"}
className={"openapi__heading"}
children={"Delete Alert"}
>
</Heading>
<CloudNotSupportedBadge/>

<MethodEndpoint
method={"delete"}
path={"api/v2/alerts/{id}"}
context={"endpoint"}
>

</MethodEndpoint>



Deletes an alert

<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>

<ParamsDetails
parameters={[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Alert ID","example":"65f5e4a3b9e77c001a123456"}]}
>

</ParamsDetails>

<RequestSchema
title={"Body"}
body={undefined}
>

</RequestSchema>

<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successfully deleted alert","content":{"application/json":{"schema":{"type":"object","properties":{},"title":"EmptyResponse"},"example":{}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"title":"Error"}}}},"404":{"description":"Alert not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"title":"Error"}}}}}}
>

</StatusCodes>



Loading