Operations for Applications REST API Documentation Data Structures
{
"roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
"externalId": "string"
}
The Role ARN that the customer has created in AWS IAM to allow access to Wavefront
The external id corresponding to the Role ARN
{
"name": "string",
"id": "string",
"description": "string"
}
name
id
description
{
"entityId": "string",
"viewAcl": [
{
"name": "string",
"id": "string",
"description": "string"
}
],
"modifyAcl": [
{
"name": "string",
"id": "string",
"description": "string"
}
]
}
The entity Id
List of users and user group ids that have view permission
List of users and user groups ids that have modify permission
{
"canView": [
"string"
],
"canModify": [
"string"
]
}
canView
canModify
{
"entityId": "string",
"viewAcl": [
"string"
],
"modifyAcl": [
"string"
]
}
The entity Id
List of users and user group ids that have view permission
List of users and user groups ids that have modify permission
Access policy information for customer
{
"lastUpdatedMs": "integer",
"policyRules": [
{
"name": "string",
"description": "string",
"subnet": "string",
"action": "string"
}
],
"customer": "string"
}
lastUpdatedMs
customer
{
"name": "string",
"description": "string",
"subnet": "string",
"action": "string"
}
name
description
subnet
action
Wavefront account entity.
{
"unitedRoles": [
"string"
],
"unitedPermissions": [
"string"
],
"identifier": "string",
"groups": [
"string"
],
"roles": [
"string"
],
"userGroups": [
"string"
]
}
The list of account's roles assigned directly or through user groups assigned to it
The list of account's permissions assigned directly or through united roles assigned to it
The unique identifier of an account.
The list of account's permissions.
The list of account's roles.
The list of account's user groups.
Wavefront Alert
{
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": "boolean",
"lastEventTime": "integer",
"hidden": "boolean",
"severity": "string",
"minutes": "integer",
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": "integer",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": "boolean",
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": "boolean",
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": "boolean",
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": "boolean",
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": "integer",
"snoozed": "integer",
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"querySyntaxError": "boolean",
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"notificants": [
"string"
],
"lastNotificationMillis": "integer",
"notificationResendFrequencyMinutes": "integer",
"alertsLastDay": "integer",
"alertsLastWeek": "integer",
"alertsLastMonth": "integer",
"numPointsInFailureFrame": "integer",
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"systemAlertVersion": "integer",
"alertType": "string",
"evaluateRealtimeData": "boolean",
"secureMetricDetails": "boolean",
"enablePDIncidentBySeries": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": "integer",
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": "integer",
"alertChartDescription": "string"
}
tagpaths
targetEndpoints
Whether the user has modify ACL access to the alert.
Start time (in epoch millis) of the last event associated with this alert.
hidden
Severity of the alert
The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires
name
id
The email address or integration endpoint (such as PagerDuty or web hook) to notify when the alert status changes. Comma-separated list of targets. Multiple target types can be in the list. Alert target format: ({email}|pd:{pd_key}|target:{alert target ID}). You cannot update this value.
Lists the applications from the failingHostLabelPair of the alert.
Lists the services from the failingHostLabelPair of the alert.
createdEpochMillis
updatedEpochMillis
List of alert targets display information that includes name, id and type.
Whether this alert is system-owned and not writeable
Lists the current state of the alert. Can be one or more of: FIRING,SNOOZED, IN_MAINTENANCE, INVALID, NONE, CHECKING, TRASH, NO_DATA
orphan
deleted
When this alert was created, in epoch millis
The interval between checks for this alert, in minutes. Defaults to 1 minute
createUserId
When the alert was last updated, in epoch millis
The user that last updated this alert
Whether there was an exception when the alert condition last ran
The time of the last error encountered when running this alert's condition query, in epoch millis
The last error encountered when running this alert's condition query
User-supplied additional explanatory information for this alert. Useful for linking runbooks, mitigations,, etc
Number of metrics checked by the alert condition
Number of hosts checked by the alert condition
inTrash
The time when this alert was last checked, in epoch millis
A derived field recording the number of data points scanned when the system last computed this alert's condition
Whether to include obsolete metrics in alert query
Last query time of the alert, averaged on hourly basis
A Wavefront query that is evaluated at regular intervals (default 1m). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes
conditionQueryType
Whether the condition query was created using the Query Builder. Default false
The special serialization of the Query Builder that corresponds to the condition query. Applicable only when conditionQBEnabled is true
A second query whose results are displayed in the alert user interface instead of the condition query. This field is often used to display a version of the condition query with Boolean operators removed so that numerical values are plotted
Multi - alert conditions.
displayExpressionQueryType
Whether the display expression query was created using the Query Builder. Default false
creatorId
updaterId
The special serialization of the Query Builder that corresponds to the display expression query. Applicable only when displayExpressionQBEnabled is true
A list of queries represent multiple queries in alert. It must contains at least one query with AlertSourceType as CONDITION.
The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves. When unset, this defaults to the same value as "minutes"
Targets for severity.
The until which time this alert is snoozed (not checked), in epoch millis. A negative value implies the alert is snoozed indefinitely
Whether there was an query syntax exception when the alert condition last ran
User-supplied runbook links for this alert. Useful for linking wiki page or documentation, etc to refer to when alert is triggered
User-supplied dashboard and parameters to create dashboard links. Parameters must be specified as constants or variables. Constant parameters currently only supported
Lists the sources that will not be checked for this alert, due to matching a maintenance window
The names of the active maintenance windows that are affecting this alert
Lists the series that are starting to fail, defined as failing for greater than 50% of the checks in the window determined by the "minutes" parameter
A derived field listing the webhook ids used by this alert
When this alert last caused a notification, in epoch millis
How often to re-trigger a continually failing alert. If absent or <= 0, no retriggering occurs
alertsLastDay
alertsLastWeek
alertsLastMonth
Number of points scanned in alert query time frame.
If this is a system alert, the version of it
Alert type.
Whether to alert on the real-time ingestion stream (may be noisy due to late data)
Whether to secure sensitive metric details and alert images in alert notifications, to not break Metrics Security.
enablePDIncidentBySeries
Get the ingestion policy Id associated with ingestion policy alert.
List of links to tracing applications that caused a failing series
Attribute used for default alert sort that is derived from state and severity
Alert severity list for multi-threshold type.
The y-axis unit of Alert chart.
The base of alert chart. A linear chart will have base as 1. A logarithmic chart will have the other base value.The value should be an integer and should greater than or equal to 1.
The description of alert chart. Different from alert additional info, this is used to describe the characteristics of the chart.
{
"dashboardId": "string",
"description": "string"
}
dashboardId
parameters
description
Minimal description of a Wavefront Alert
{
"name": "string",
"id": "string"
}
Name of the alert
Unique identifier, also created epoch millis, of the alert
Wavefront alert route entity
{
"method": "string",
"target": "string",
"filter": "string"
}
The end point for the alert route.EMAIL: email address. PAGERDUTY: PagerDuty routing Key. WEBHOOK: URL end point
The end point for the notification target.EMAIL: email address. PAGERDUTY: PagerDuty routing Key. WEBHOOK: URL end point
String that filters the route. Space delimited. Currently only allows single key value pair. filter: env* prod*
An AlertSource represents a single query used in an alert. Like ChartSource inDashboard, it includes the query and all the related fields.
{
"hidden": "boolean",
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": "boolean",
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
A flag to indicate whether the alert source is hidden or not.
The color of the alert source.
The alert source query name. Used as the variable name in the other query.
The alert query. Support both Wavefront Query and Prometheus Query.
The additional long description of the alert source.
The type of the alert query. Supported types are [PROMQL, WQL].
A flag indicate whether the alert source query builder enabled or not.
The string serialization of the alert source query builder, mostly used by Wavefront UI.
The types of the alert source (an array of CONDITION, AUDIT, VARIABLE) and the default one is [VARIABLE]. CONDITION alert source is the condition query in the alert. AUDIT alert source is the query to get more details when the alert changes state. VARIABLE alert source is a variable used in the other queries.
{
"key": "string",
"value": "string"
}
key
value
DTO for wavefront anomaly
{
"id": "string",
"model": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"row": "integer",
"dashboardId": "string",
"endMs": "integer",
"queryHash": "string",
"imageLink": "string",
"chartHash": "string",
"paramHash": "string",
"startMs": "integer",
"section": "integer",
"col": "integer",
"chartLink": "string",
"originalStripes": [
{
"model": "string",
"endMs": "integer",
"imageLink": "string",
"startMs": "integer"
}
],
"updatedMs": "integer",
"deleted": "boolean",
"customer": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"creatorId": "string",
"updaterId": "string"
}
unique id that defines this anomaly
model for this anomaly
createdEpochMillis
updatedEpochMillis
row number for this anomaly
dashboard id for this anomaly
endMs for this anomaly
query hash for this anomaly
image link for this anomaly
chart hash(as unique identifier) for this anomaly
param hash for this anomaly
startMs for this anomaly
section number for this anomaly
column number for this anomaly
chart link for this anomaly
map of query params belongs to this anomaly
updateMs for this anomaly
deleted
id of the customer to which this anomaly belongs
list of metrics used of this anomaly
list of hosts affected of this anomaly
creatorId
updaterId
Wavefront api token entity
{
"accountType": "string",
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"dateGenerated": "integer",
"customer": "string",
"lastUsed": "integer",
"account": "string"
}
The user or service account generated this token.
The name of the token.
The unique identifier of the token.
createdEpochMillis
The generation date of the token.
The id of the customer to which the token belongs.
The last time this token was used.
The account who generated this token.
Configurations specific to the AppDynamics integration. Only applicable when the containing Credential has service=APPDYNAMICS
{
"userName": "user1@account1",
"controllerName": "string",
"encryptedPassword": "string",
"enableRollup": "boolean",
"enableErrorMetrics": "boolean",
"enableBusinessTrxMetrics": "boolean",
"enableBackendMetrics": "boolean",
"enableOverallPerfMetrics": "boolean",
"enableIndividualNodeMetrics": "boolean",
"enableAppInfraMetrics": "boolean",
"enableServiceEndpointMetrics": "boolean",
"appFilterRegex": [
"string"
]
}
Username is combination of userName and the account name.
Name of the SaaS controller.
Password for AppDynamics user.
Set this to 'false' to get separate results for all values within the time range, by default it is 'true'.
Boolean flag to control Error metric injection.
Boolean flag to control Business Transaction metric injection.
Boolean flag to control Backend metric injection.
Boolean flag to control Overall Performance metric injection.
Boolean flag to control Individual Node metric injection.
Boolean flag to control Application Infrastructure metric injection.
Boolean flag to control Service End point metric injection.
List of regular expressions that a application name must match (case-insensitively) in order to be ingested.
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
filterType
{
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
stringValue
arrayValue
logicalValue
{
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
}
query
Configurations specific to the Azure activity logs integration. Only applicable when the containing Credential has service=AZUREACTIVITYLOG
{
"baseCredentials": {
"clientId": "string",
"clientSecret": "string",
"tenant": "string"
},
"categoryFilter": [
"string"
]
}
A list of Azure ActivityLog categories to pull events for.Allowable values are ADMINISTRATIVE, SERVICEHEALTH, ALERT, AUTOSCALE, SECURITY
{
"clientId": "string",
"clientSecret": "string",
"tenant": "string"
}
Client Id for an Azure service account within your project.
Client Secret for an Azure service account within your project. Use 'saved_secret' to retain the client secret when updating.
Tenant Id for an Azure service account within your project.
Configurations specific to the Azure integration. Only applicable when the containing Credential has service=AZURE
{
"metricFilterRegex": "^azure.(compute|network|dbforpostgresql).*$",
"baseCredentials": {
"clientId": "string",
"clientSecret": "string",
"tenant": "string"
},
"categoryFilter": [
"string"
],
"resourceGroupFilter": [
"string"
]
}
A regular expression that a metric name must match (case-insensitively) in order to be ingested
A list of Azure services (such as Microsoft.Compute/virtualMachines, Microsoft.Cache/redis etc) from which to pull metrics.
A list of Azure resource groups from which to pull metrics.
Representation of a Wavefront chart
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
If the chart has a log-scale Y-axis, the base for the logarithms
String to label the units of the chart on the Y-axis
Name of the source
Description of the chart
Whether to hide events related to the sources in the charts produced. Default false (i.e. shows events)
Summarization strategy for the chart. MEAN is default
Whether to show obsolete metrics. Default: false
The amount of historical data to use for anomaly detection baselining
Anomaly Type. Default both
Anomaly Severity. Default medium
Whether to interpolate points in the charts produced. Default: true
Whether anomaly detection is on or of, default false
Whether to filter out non anomalies. Default false
Whether to show confidence bounds. Default false
Representation of the settings of a Wavefront chart
{
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
}
Chart Type. 'line' refers to the Line Plot, 'scatter' to the Point Plot, 'stacked-area' to the Stacked Area plot, 'table' to the Tabular View, 'scatterploy-xy' to Scatter Plot, 'markdown-widget' to the Markdown display, and 'sparkline' to the Single Stat view
Min value of Y-axis. Set to null or leave blank for auto
Max value of Y-axis. Set to null or leave blank for auto
For the tabular view, a list of point tags to display when using the "custom" tag display mode
Threshold (in seconds) for time delta between consecutive points in a series above which a dotted line will replace a solid line in line plots. Default: 60s
Whether to enable a fixed tabular legend adjacent to the chart
If true, the legend uses non-summarized stats instead of summarized
The Markdown content for a Markdown display, in plain text. Use this field instead of markdownContent
.
Plot interpolation type. linear is default
Type of stacked chart (applicable only if chart type is stacked). zero (default) means stacked from y=0. expand means Normalized from 0 to 1. wiggle means Minimize weighted changes. silhouette means to Center the Stream
For the tabular view, whether to use the full time window for the query or the last X minutes
Width, in minutes, of the time window to use for "last" windowing
For the tabular view, whether to display sources. Default: true
For the tabular view, whether to display labels. Default: true
For the tabular view, whether to display raw values. Default: false
For the tabular view, whether to display value column. Default: true
deprecated
deprecated
For the tabular view, which mode to use to determine which point tags to display
For the tabular view, how many point tags to display
For the tabular view, whether to group multi metrics into a single row by a common source. If false, each metric for each source is displayed in its own row. If true, multiple metrics for the same host will be displayed as different columns in the same row
For the tabular view, whether to display display values in descending order. Default: false
For the tabular view, to select column for default sort
For plots with multiple Y-axes, max value for right-side Y-axis. Set null for auto
For plots with multiple Y-axes, min value for right-side Y-axis. Set null for auto
For plots with multiple Y-axes, units for right-side Y-axis
Default: false. Whether to scale numerical magnitude labels for left Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI)
Default: false. Whether to scale numerical magnitude labels for right Y-axis by 1024 in the IEC/Binary manner (instead of by 1000 like SI)
Default: false. Whether to automatically adjust magnitude labels and units for the left Y-axis to favor smaller magnitudes and larger units
Default: false. Whether to automatically adjust magnitude labels and units for the right Y-axis to favor smaller magnitudes and larger units
Whether to disable the display of the floating legend (but reenable it when the ctrl-key is pressed)
Where the fixed legend should be displayed with respect to the chart
For a chart with a fixed legend, a list of statistics to display in the legend
Whether to display "Top"- or "Bottom"-ranked series in the fixed legend
Whether to display Source Name fixed legend
Whether to display Metric Name fixed legend
Number of series to include in the fixed legend
Statistic to use for determining whether a series is displayed on the fixed legend
deprecated
For x-y scatterplots, max value for X-axis. Set null for auto
For x-y scatterplots, min value for X-axis. Set null for auto
For x-y scatterplots, max value for Y-axis. Set null for auto
For x-y scatterplots, min value for Y-axis. Set null for auto
For x-y scatterplots, whether to color more recent points as darker than older points. Default: false
For the single stat view, whether to display the name of the query or the value of query
For the single stat view, the color of the displayed text (when not dynamically determined). Values should be in "rgba(<rval>, <gval>, <bval>, <aval>)" format
deprecated
For the single stat view, the horizontal position of the displayed text
For the single stat view, the font size of the displayed text, in percent
For the single stat view, a string to add before the displayed text
For the single stat view, a string to append to the displayed text
For the single stat view, a misleadingly named property. This determines whether the sparkline of the statistic is displayed in the chart BACKGROUND, BOTTOM, or NONE
For the single stat view, the color of the line. Values should be in "rgba(<rval>, <gval>, <bval>, <aval>)" format
For the single stat view, the color of the background fill. Values should be in "rgba(<rval>, <gval>, <bval>, <aval>)" format
For the single stat view, a list of colors that differing query values map to. Must contain one more element than sparklineValueColorMapValuesV2. Values should be in "rgba(<rval>, <gval>, <bval>, <aval>)" format
For the single stat view, a list of boundaries for mapping different query values to colors. Must contain one less element than sparklineValueColorMapColors
deprecated
For the single stat view, whether to apply dynamic color settings to the displayed TEXT or BACKGROUND
For the single stat view, the decimal precision of the displayed number
For the single stat view, a list of display text values that different query values map to. Must contain one more element than sparklineValueTextMapThresholds
For the single stat view, a list of threshold boundaries for mapping different query values to display text. Must contain one less element than sparklineValueTextMapText
Default color that will be used in any chart rendering. Values should be in "rgba(<rval>, <gval>, <bval>, <aval>)" format
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
Name of the source
Query expression to plot on the chart
Query type of the source
Whether or not this source line should have the query builder enabled
Opaque representation of the querybuilder
A description for the purpose of this source
Whether the source is disabled
The color used to draw all results from this source (auto if unset)
Determines if this source relates to the right hand Y-axis or not
For scatter plots, does this query source the X-axis or the Y-axis
{
"name": "string",
"registeredAsParallelCapable": "boolean",
"parent": "ClassLoader Object",
"unnamedModule": "Module Object",
"definedPackages": [
{
"name": "string",
"specificationTitle": "string",
"specificationVersion": "string",
"specificationVendor": "string",
"implementationTitle": "string",
"implementationVersion": "string",
"implementationVendor": "string",
"annotations": [
{
"key": "string",
"value": "string"
}
],
"declaredAnnotations": [
{
"key": "string",
"value": "string"
}
],
"sealed": "boolean"
}
]
}
name
registeredAsParallelCapable
Wavefront Cloud Integration
{
"forceSave": "boolean",
"reuseExternalIdCredential": "string",
"name": "string",
"id": "string",
"service": "string",
"lastReceivedDataPointMs": "integer",
"lastMetricCount": "integer",
"cloudWatch": {
"namespaces": [
"string"
],
"metricFilterRegex": "^aws.(billing|instance|sqs|sns|reservedInstance|ebs|route53.health|ec2.status|elb).*$",
"baseCredentials": {
"roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
"externalId": "string"
},
"instanceSelectionTagsExpr": "string",
"volumeSelectionTagsExpr": "string",
"pointTagFilterRegex": "(region|name)",
"s3BucketNameFilterRegex": "^(test|demo).*$",
"threadDistributionInMins": "integer"
},
"cloudTrail": {
"region": "string",
"prefix": "string",
"bucketName": "string",
"baseCredentials": {
"roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
"externalId": "string"
},
"filterRule": "string"
},
"ec2": {
"metricFilterRegex": "^aws.(sqs|ebs).*$",
"baseCredentials": {
"roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
"externalId": "string"
},
"hostNameTags": [
"string"
],
"instanceSelectionTagsExpr": "string",
"volumeSelectionTagsExpr": "string",
"pointTagFilterRegex": "(region|name)"
},
"gcp": {
"metricFilterRegex": "^gcp.(compute|container|pubsub).*$",
"projectId": "string",
"gcpJsonKey": "string",
"disableHistogramToMetricConversion": "boolean",
"disableDeltaCounts": "boolean",
"categoriesToFetch": [
"string"
],
"customMetricPrefix": [
"string"
]
},
"gcpBilling": {
"projectId": "string",
"gcpJsonKey": "string",
"gcpApiKey": "string"
},
"newRelic": {
"apiKey": "string",
"appFilterRegex": "^hostingservice-(prod|dev)*$",
"hostFilterRegex": "host[1-9].xyz.com",
"newRelicMetricFilters": [
{
"appName": "string",
"metricFilterRegex": "string"
}
]
},
"appDynamics": {
"userName": "user1@account1",
"controllerName": "string",
"encryptedPassword": "string",
"enableRollup": "boolean",
"enableErrorMetrics": "boolean",
"enableBusinessTrxMetrics": "boolean",
"enableBackendMetrics": "boolean",
"enableOverallPerfMetrics": "boolean",
"enableIndividualNodeMetrics": "boolean",
"enableAppInfraMetrics": "boolean",
"enableServiceEndpointMetrics": "boolean",
"appFilterRegex": [
"string"
]
},
"dynatrace": {
"metricFilterRegex": "^dynatrace.(builtin|dsfm).*$",
"environmentID": "example",
"dynatraceAPIToken": "string"
},
"azure": {
"metricFilterRegex": "^azure.(compute|network|dbforpostgresql).*$",
"baseCredentials": {
"clientId": "string",
"clientSecret": "string",
"tenant": "string"
},
"categoryFilter": [
"string"
],
"resourceGroupFilter": [
"string"
]
},
"azureActivityLog": {
"baseCredentials": {
"clientId": "string",
"clientSecret": "string",
"tenant": "string"
},
"categoryFilter": [
"string"
]
},
"lastErrorMs": "integer",
"lastProcessorId": "string",
"lastProcessingTimestamp": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"serviceRefreshRateInMins": "integer",
"vrops": {
"baseURL": "https://www.mgmt.cloud.vmware.com/vrops-cloud",
"metricFilterRegex": "^vrops.(vmware|cloudhealthadapter).(clustercomputeresource|datastore).*$",
"categoriesToFetch": [
"string"
],
"vropsAPIToken": "string",
"organizationID": "string"
},
"disabled": "boolean",
"lastError": "string",
"deleted": "boolean",
"inTrash": "boolean",
"lastErrorEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"creatorId": "string",
"updaterId": "string",
"snowflake": {
"userName": "string",
"password": "string",
"metricFilterRegex": "string",
"privateKey": "string",
"role": "string",
"accountID": "string",
"warehouse": "string"
}
}
forceSave
reuseExternalIdCredential
The human-readable name of this integration
id
A value denoting which cloud service this integration integrates with
A list of point tag key-values to add to every point ingested using this integration
Time that this integration last received a data point, in epoch millis
Number of metrics / events ingested by this integration the last time it ran
Time, in epoch millis, of the last error encountered by Wavefront servers when fetching data using this integration
Opaque id of the last Wavefront integrations service to act on this integration
Time, in epoch millis, that this integration was last processed
createdEpochMillis
updatedEpochMillis
Service refresh rate in minutes.
True when an aws credential failed to authenticate.
Digest of the last error encountered by Wavefront servers when fetching data using this integration
deleted
inTrash
creatorId
updaterId
Configurations specific to the CloudTrail AWS integration. Only applicable when the containing Credential has service=CLOUDTRAIL
{
"region": "string",
"prefix": "string",
"bucketName": "string",
"baseCredentials": {
"roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
"externalId": "string"
},
"filterRule": "string"
}
The AWS region of the S3 bucket where CloudTrail logs are stored
The common prefix, if any, appended to all CloudTrail log files
Name of the S3 bucket where CloudTrail logs are stored
Rule to filter cloud trail log event.
Configuration specific to the CloudWatch AWS integration. Only applicable when the containing Credential has service=CLOUDWATCH
{
"namespaces": [
"string"
],
"metricFilterRegex": "^aws.(billing|instance|sqs|sns|reservedInstance|ebs|route53.health|ec2.status|elb).*$",
"baseCredentials": {
"roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
"externalId": "string"
},
"instanceSelectionTagsExpr": "string",
"volumeSelectionTagsExpr": "string",
"pointTagFilterRegex": "(region|name)",
"s3BucketNameFilterRegex": "^(test|demo).*$",
"threadDistributionInMins": "integer"
}
A list of namespace that limit what we query from CloudWatch.
A regular expression that a CloudWatch metric name must match (case-insensitively) in order to be ingested
A string->string map of allow list of AWS instance tag-value pairs (in AWS). If the instance's AWS tags match this allow list, CloudWatch data about this instance is ingested. Multiple entries are OR'ed
A string->string map of allow list of AWS volume tag-value pairs (in AWS). If the volume's AWS tags match this allow list, CloudWatch data about this volume is ingested. Multiple entries are OR'ed
A string expressing the allow list of AWS instance tag-value pairs. If the instance's AWS tags match this allow list, CloudWatch data about this instance is ingested. Multiple entries are OR'ed and also OR'ed with entries from instanceSelectionTags. Key-value pairs in the string are separated by commas and in the form k=v. Example: "k1=v1, k1=v2, k3=v3".
A string expressing the allow list of AWS volume tag-value pairs. If the volume's AWS tags match this allow list, CloudWatch data about this volume is ingested. Multiple entries are OR'ed and also OR'ed with entries from volumeSelectionTags. Key-value pairs in the string are separated by commas and in the form k=v. Example: "k1=v1, k1=v2, k3=v3".
A regular expression that AWS tag key name must match (case-insensitively) in order to be ingested
A regular expression that a AWS S3 Bucket name must match (case-insensitively) in order to be ingested
ThreadDistributionInMins
{
"clusterAlias": "string",
"statusPageLink": "string"
}
clusterAlias
statusPageLink
{
"logicalTypeName": "string",
"recommendedSchema": {
"logicalType": {
"name": "string"
},
"error": "boolean",
"elementType": "Schema Object",
"fullName": "string",
"fields": [
{}
],
"name": "string",
"valueType": "Schema Object",
"namespace": "string",
"enumDefault": "string",
"doc": "string",
"aliases": [
"string"
],
"union": "boolean",
"enumSymbols": [
"string"
],
"fixedSize": "integer",
"types": [
"Schema Object"
]
}
}
logicalTypeName
{
"unitedRoles": [
"string"
],
"unitedPermissions": [
"string"
],
"userGroups": [
"string"
],
"id": "string",
"identifier": "string",
"groups": [
"string"
],
"customer": "string",
"lastSuccessfulLogin": "integer",
"escapedIdentifier": "string",
"gravatarUrl": "string",
"self": "boolean"
}
The list of account's roles assigned directly or through user groups assigned to it
The list of account's permissions assigned directly or through united roles assigned to it
List of user group identifiers this user belongs to
The unique identifier of this user, which should be their valid email address
The unique identifier of this user, which should be their valid email address
List of permission groups this user has been granted access to
The id of the customer to which the user belongs
The last time the user logged in, in epoch milliseconds
URL Escaped Identifier
URL id For User's gravatar (see gravatar.com), if one exists.
Whether this user is the one calling the API
Wavefront dashboard entity
{
"modifyAclAccess": "boolean",
"hidden": "boolean",
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"customer": "string",
"url": "string",
"eventFilterType": "string",
"forceV2UI": "boolean",
"sections": [
{
"name": "string",
"id": "string",
"rows": [
{
"heightFactor": "integer",
"charts": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
]
}
]
}
],
"disableRefreshInLiveMode": "boolean",
"hideChartWarning": "boolean",
"displayDescription": "boolean",
"displaySectionTableOfContents": "boolean",
"displayQueryParameters": "boolean",
"chartTitleScalar": "integer",
"eventQuery": "string",
"defaultTimeWindow": "string",
"defaultStartTime": "integer",
"defaultEndTime": "integer",
"chartTitleColor": "string",
"chartTitleBgColor": "string",
"viewsLastDay": "integer",
"viewsLastWeek": "integer",
"viewsLastMonth": "integer",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"includeObsoleteMetrics": "boolean",
"creatorId": "string",
"updaterId": "string",
"numCharts": "integer",
"numFavorites": "integer",
"favorite": "boolean"
}
Whether the user has modify ACL access to the dashboard.
hidden
Deprecated. An obsolete representation of dashboard parameters
Name of the dashboard
Unique identifier, also URL slug, of the dashboard
Human-readable description of the dashboard
createdEpochMillis
updatedEpochMillis
Whether this dashboard is system-owned and not writeable
orphan
deleted
id of the customer to which this dashboard belongs
Unique identifier, also URL slug, of the dashboard
How charts belonging to this dashboard should display events. BYCHART is default if unspecified
Whether to force this dashboard to use the V2 UI
The current (as of Wavefront 4.0) JSON representation of dashboard parameters. This is a map from a parameter name to its representation
Refresh variables in Live Mode
Hide chart warning
Whether the dashboard description section is opened by default when the dashboard is shown
Whether the "pills" quick-linked the sections of the dashboard are displayed by default when the dashboard is shown
Whether the dashboard parameters section is opened by default when the dashboard is shown
Scale (normally 100) of chart title text size
Event query to run on dashboard charts
Default time window to query charts
Default start time in milliseconds to query charts
Default end time in milliseconds to query charts
Text color of the chart title text are, in rgba(rvalue,gvalue,bvalue,avalue)
Background color of the chart title text area, in rgba(rvalue,gvalue,bvalue,avalue)
viewsLastDay
viewsLastWeek
viewsLastMonth
Whether to include the obsolete metrics
creatorId
updaterId
numCharts
numFavorites
favorite
Minimal description of a Wavefront dashboard
{
"name": "string",
"id": "string",
"description": "string"
}
Name of the dashboard
Unique identifier, also URL slug, of the dashboard
Human-readable description of the dashboard
{
"defaultValue": "string",
"description": "string",
"label": "string",
"parameterType": "string",
"multivalue": "boolean",
"allowAll": "boolean",
"dynamicFieldType": "string",
"queryValue": "string",
"hideFromView": "boolean",
"tagKey": "string",
"reverseDynSort": "boolean",
"valueOrdering": [
"string"
],
"order": "integer",
"tagsBlackListRegex": "string"
}
defaultValue
description
label
parameterType
valuesToReadableStrings
multivalue
allowAll
dynamicFieldType
queryValue
hideFromView
tagKey
Whether to reverse alphabetically sort the returned result.
valueOrdering
order
The regular expression to filter out source tags from the Current Values list.
{
"name": "string",
"id": "string",
"rows": [
{
"heightFactor": "integer",
"charts": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
]
}
]
}
Name of this section
Id of this section
{
"heightFactor": "integer",
"charts": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
]
}
Scalar for the height of this row. 100 is normal and default. 50 is half height
Default Saved search queries for Application Status
{
"defaultUserSearch": {
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string"
},
"defaultCustomerSearch": {
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string"
}
}
Default Saved search queries for Traces
{
"defaultUserSearch": {
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string"
},
"defaultCustomerSearch": {
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string"
}
}
Wavefront Derived Metric
{
"tagpaths": [
"string"
],
"minutes": "integer",
"name": "string",
"id": "string",
"query": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"deleted": "boolean",
"created": "integer",
"queryQBEnabled": "boolean",
"queryQBSerialization": "string",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"creatorId": "string",
"updaterId": "string"
}
tagpaths
Number of minutes to query for the derived metric
name
id
A Wavefront query that is evaluated at regular intervals (default 1m).
createdEpochMillis
updatedEpochMillis
Lists the current state of the derived metric. Can be one or more of: INVALID, ACTIVE, TRASH, NO_DATA
deleted
When this derived metric was created, in epoch millis
Whether the query was created using the Query Builder. Default false
The special serialization of the Query Builder that corresponds to the query. Applicable only when queryQBEnabled is true
The interval between executing the query, in minutes. Defaults to 1 minute
createUserId
When the derived metric definition was last updated, in epoch millis
The user that last updated this derived metric definition
Whether there was an exception when the query last ran
The time of the last error encountered when running the query, in epoch millis
The last error encountered when running the query
User-supplied additional explanatory information for the derived metric
Number of metrics checked by the query
Number of hosts checked by the query
inTrash
The last time when the derived metric query was run, in epoch millis
A derived field recording the number of data points scanned when the system last computed the query
Whether to include obsolete metrics in query
Time for the query execute, averaged on hourly basis
creatorId
updaterId
Configurations specific to the Dynatrace Cloud Platform integration. Only applicable when the containing Credential has service=DYNATRACE
{
"metricFilterRegex": "^dynatrace.(builtin|dsfm).*$",
"environmentID": "example",
"dynatraceAPIToken": "string"
}
A regular expression that a metric name must match (case-insensitively) in order to be ingested
The ID of Dynatrace Environment
The Dynatrace API Token
Configurations specific to the EC2 AWS integration. Only applicable when the containing Credential has service=EC2
{
"metricFilterRegex": "^aws.(sqs|ebs).*$",
"baseCredentials": {
"roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
"externalId": "string"
},
"hostNameTags": [
"string"
],
"instanceSelectionTagsExpr": "string",
"volumeSelectionTagsExpr": "string",
"pointTagFilterRegex": "(region|name)"
}
A regular expression that a metric name must match (case-insensitively) in order to be ingested
A list of AWS instance tags that, when found, will be used as the "source" name in a series. Default: ["hostname", "host", "name"]. If no tag in this list is found, the series source is set to the instance id.
A string expressing the allow list of AWS instance tag-value pairs. If the instance's AWS tags match this allow list, data about this instance is ingested from EC2 APIs Multiple entries are OR'ed. Key-value pairs in the string are separated by commas and in the form k=v. Example: "k1=v1, k1=v2, k3=v3".
A string expressing the allow list of AWS volume tag-value pairs. If the volume's AWS tags match this allow list, Data about this volume is ingested from EBS APIs. Multiple entries are OR'ed. Key-value pairs in the string are separated by commas and in the form k=v. Example: "k1=v1, k1=v2, k3=v3".
A regular expression that AWS tag key name must match (case-insensitively) in order to be ingested
Wavefront Event
{
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
}
The customer to which the event belongs
A string->
map of additional dimension info on the event
The name of the event. If 'annotations.prettyName' is present, 'name' will be equivalent to that value
A string->string map of additional annotations on the event
id
Start time of the event, in epoch millis. If the JSON value is missing or set to 0, startTime will be set to the current time
End time of the event, in epoch millis. Set to startTime + 1 for an instantaneous event
createdEpochMillis
updatedEpochMillis
A list of event tags
A list of metrics affected by the event
createdAt
A list of sources/hosts affected by the event
In some event queries, multiple events that occur nearly simultaneously are summarized under a single event. This value specifies the number of events summarized under this one
The list of tags on the alert which created this event.
Whether this event was created by a user, versus the system. Default: system
Whether the event is an artificial event generated by a literal expression or alert backtesting, i.e. not stored in the Wavefront backend
creatorId
updaterId
updatedAt
runningState
canDelete
canClose
creatorType
{
"cursor": "string",
"limit": 100,
"query": [
{
"key": "string",
"value": "string",
"values": [
"string"
],
"matchingMethod": "string",
"negated": "boolean",
"start": "integer",
"end": "integer"
}
],
"timeRange": {
"earliestStartTimeEpochMillis": "integer",
"latestStartTimeEpochMillis": "integer"
},
"relatedEventTimeRange": {
"earliestStartTimeEpochMillis": "integer",
"latestStartTimeEpochMillis": "integer"
},
"sortTimeAscending": "boolean",
"sortScoreMethod": "string"
}
The id (exclusive) from which search results resume returning. Users should supply an entity 'id' to this property. Its main purpose is to resume where a previous search left off because of the 'limit' parameter. If a user supplies the last id in a set of results to cursor, while keeping the query the same, the system will return the next page of results
The number of results to return. Default: 100
Whether to sort event results ascending in start time. Default: false
Whether to sort events on similarity score : {NONE, SCORE_ASC, SCORE_DES}. Default: NONE. If sortScoreMethod is set to SCORE_ASC or SCORE_DES, it will override time sort
Refinement of time range over which to search (for events). Operates on the start time of the event.
{
"earliestStartTimeEpochMillis": "integer",
"latestStartTimeEpochMillis": "integer"
}
Start of search time window, in milliseconds since the Unix Epoch. Events whose start time occurs after this value will be returned. If no value is supplied, defaults to 2 hours prior the present time.
End of the search time window, in milliseconds since the Unix Epoch. Events whose start time occurs before this value will be returned. If no value is supplied, defaults to now.
Links that can be generated from Wavefront to other analytical platforms
{
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"template": "string",
"metricFilterRegex": "string",
"sourceFilterRegex": "string",
"isLogIntegration": "boolean",
"creatorId": "string",
"updaterId": "string"
}
Name of the external link. Will be displayed in context (right-click) menus on charts
id
Human-readable description for this external link
createdEpochMillis
updatedEpochMillis
The mustache template for this link. This template must expand to a full URL, including scheme, origin, etc
Controls whether a link displayed in the context menu of a highlighted series. If present, the metric name of the highlighted series must match this regular expression in order for the link to be displayed
Controls whether a link displayed in the context menu of a highlighted series. If present, the source name of the highlighted series must match this regular expression in order for the link to be displayed
Controls whether a link displayed in the context menu of a highlighted series. This is a map from string to regular expression. The highlighted series must contain point tags whose keys are present in the keys of this map and whose values match the regular expressions associated with those keys in order for the link to be displayed
Whether this is a "Log Integration" subType of external link
creatorId
updaterId
{
"items": [
"string"
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
List of requested items
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"limit": "integer",
"offset": "integer",
"query": [
{
"key": "string",
"value": "string",
"values": [
"string"
],
"matchingMethod": "string",
"negated": "boolean",
"start": "integer",
"end": "integer"
}
],
"facetQuery": "string",
"facetQueryMatchingMethod": "string"
}
The number of results to return. Default: 100, Maximum allowed: 1000
The number of results to skip before returning values. Default: 0
A list of queries by which to limit the search results. Entities that match ALL queries in the list are returned
A string against which facet results are compared. If the facet result CONTAINs, STARTSWITH, or is an EXACT match for this value, as specified by facetQueryMatchingMethod, then it is returned.
The matching method used to filter when 'facetQuery' is used. Defaults to CONTAINS.
{
"limit": "integer"
}
The requested limit
The requested facets, returned in a map whose key is the facet property and whose value is a list of facet values
{
"query": [
{
"key": "string",
"value": "string",
"values": [
"string"
],
"matchingMethod": "string",
"negated": "boolean",
"start": "integer",
"end": "integer"
}
],
"limit": "integer",
"facets": [
"string"
],
"facetQuery": "string",
"facetQueryMatchingMethod": "string"
}
A list of queries by which to limit the search results. Entities that match ALL queries in this list constitute a set of 'entity search results'. All facets listed in the 'facets' search parameter of all entities within 'entity search results' are scanned to produce the search results (of facet values).
The number of results to return. Default 100, Maximum allowed: 1000
A list of facets (property keys) to return values from found in entities matching 'query'. Examples are 'tags', 'creatorId', etc
A string against which facet results are compared. If the facet result either CONTAINs, STARTSWITH, or is an EXACT match for this value, as specified by facetQueryMatchingMethod, then it is returned
The matching method used to filter when 'facetQuery' is used. Defaults to CONTAINS.
{
"keyClassEnabled": "boolean",
"classPropEnabled": "boolean"
}
keyClassEnabled
classPropEnabled
objectProps
Configurations specific to the Google Cloud Platform Billing integration. Only applicable when the containing Credential has service=GCPBilling
{
"projectId": "string",
"gcpJsonKey": "string",
"gcpApiKey": "string"
}
The Google Cloud Platform (GCP) project id.
Private key for a Google Cloud Platform (GCP) service account within your project. The account must at least be granted Monitoring Viewer permissions. This key must be in the JSON format generated by GCP. Use '{"project_id": "%s"}' to retain the existing key when updating.
API key for Google Cloud Platform (GCP). Use 'saved_api_key' to retain existing API key when updating
Configurations specific to the Google Cloud Platform integration. Only applicable when the containing Credential has service=GCP
{
"metricFilterRegex": "^gcp.(compute|container|pubsub).*$",
"projectId": "string",
"gcpJsonKey": "string",
"disableHistogramToMetricConversion": "boolean",
"disableDeltaCounts": "boolean",
"categoriesToFetch": [
"string"
],
"customMetricPrefix": [
"string"
]
}
A regular expression that a metric name must match (case-insensitively) in order to be ingested
The Google Cloud Platform (GCP) project id.
Private key for a Google Cloud Platform (GCP) service account within your project. The account must at least be granted Monitoring Viewer permissions. This key must be in the JSON format generated by GCP. Use '{"project_id": "%s"}' to retain the existing key when updating.
Whether to disable the ingestion of bucket data for GCP distributions. Ingestion is enabled by default.
Whether to disable the ingestion of counts for GCP delta metrics. Ingestion is enabled by default.
A list of Google Cloud Platform (GCP) services (such as ComputeEngine, PubSub, etc) from which to pull metrics. Allowable values are APPENGINE, BIGQUERY, BIGTABLE, CLOUDFUNCTIONS, CLOUDIOT, CLOUDSQL, CLOUDTASKS, COMPUTE, CONTAINER, DATAFLOW, DATAPROC, DATASTORE, FIREBASEDATABASE, FIREBASEHOSTING, FIRESTORE, INTERCONNECT, KUBERNETES, LOADBALANCING, LOGGING, ML, MONITORING, PUBSUB, REDIS, ROUTER, SERVICERUNTIME, SPANNER, STORAGE, TPU, VPN
List of custom metric prefix to fetch the data from
{
"failed": "integer",
"success": "integer"
}
failed
success
errorBreakdown
An entry in the edit-history of an entity such as alert or dashboard
{
"id": "string",
"inTrash": "boolean",
"version": "integer",
"updateUser": "string",
"updateTime": "integer",
"changeDescription": [
"string"
]
}
id
inTrash
version
updateUser
updateTime
changeDescription
{
"items": [
{
"id": "string",
"inTrash": "boolean",
"version": "integer",
"updateUser": "string",
"updateTime": "integer",
"changeDescription": [
"string"
]
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
Wavefront ingestion policy alert
{
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": "boolean",
"lastEventTime": "integer",
"conditionsThresholdOperator": "string",
"hidden": "boolean",
"severity": "string",
"minutes": "integer",
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": "integer",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": "boolean",
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": "boolean",
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": "boolean",
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": "boolean",
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": "integer",
"snoozed": "integer",
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"querySyntaxError": "boolean",
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"notificants": [
"string"
],
"lastNotificationMillis": "integer",
"notificationResendFrequencyMinutes": "integer",
"alertsLastDay": "integer",
"alertsLastWeek": "integer",
"alertsLastMonth": "integer",
"numPointsInFailureFrame": "integer",
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"systemAlertVersion": "integer",
"alertType": "string",
"evaluateRealtimeData": "boolean",
"secureMetricDetails": "boolean",
"enablePDIncidentBySeries": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": "integer",
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": "integer",
"alertChartDescription": "string"
}
tagpaths
targetEndpoints
Whether the user has modify ACL access to the alert.
Start time (in epoch millis) of the last event associated with this alert.
Multi - alert conditions.
conditionsThresholdOperator
hidden
Severity of the alert
The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires
name
id
The email address or integration endpoint (such as PagerDuty or web hook) to notify when the alert status changes. Comma-separated list of targets. Multiple target types can be in the list. Alert target format: ({email}|pd:{pd_key}|target:{alert target ID}). You cannot update this value.
Lists the applications from the failingHostLabelPair of the alert.
Lists the services from the failingHostLabelPair of the alert.
createdEpochMillis
updatedEpochMillis
List of alert targets display information that includes name, id and type.
Whether this alert is system-owned and not writeable
Lists the current state of the alert. Can be one or more of: FIRING,SNOOZED, IN_MAINTENANCE, INVALID, NONE, CHECKING, TRASH, NO_DATA
orphan
deleted
When this alert was created, in epoch millis
The interval between checks for this alert, in minutes. Defaults to 1 minute
createUserId
When the alert was last updated, in epoch millis
The user that last updated this alert
Whether there was an exception when the alert condition last ran
The time of the last error encountered when running this alert's condition query, in epoch millis
The last error encountered when running this alert's condition query
User-supplied additional explanatory information for this alert. Useful for linking runbooks, mitigations,, etc
Number of metrics checked by the alert condition
Number of hosts checked by the alert condition
inTrash
The time when this alert was last checked, in epoch millis
A derived field recording the number of data points scanned when the system last computed this alert's condition
Whether to include obsolete metrics in alert query
Last query time of the alert, averaged on hourly basis
A Wavefront query that is evaluated at regular intervals (default 1m). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes
conditionQueryType
Whether the condition query was created using the Query Builder. Default false
The special serialization of the Query Builder that corresponds to the condition query. Applicable only when conditionQBEnabled is true
A second query whose results are displayed in the alert user interface instead of the condition query. This field is often used to display a version of the condition query with Boolean operators removed so that numerical values are plotted
Multi - alert conditions.
displayExpressionQueryType
Whether the display expression query was created using the Query Builder. Default false
creatorId
updaterId
The special serialization of the Query Builder that corresponds to the display expression query. Applicable only when displayExpressionQBEnabled is true
A list of queries represent multiple queries in alert. It must contains at least one query with AlertSourceType as CONDITION.
The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves. When unset, this defaults to the same value as "minutes"
Targets for severity.
The until which time this alert is snoozed (not checked), in epoch millis. A negative value implies the alert is snoozed indefinitely
Whether there was an query syntax exception when the alert condition last ran
User-supplied runbook links for this alert. Useful for linking wiki page or documentation, etc to refer to when alert is triggered
User-supplied dashboard and parameters to create dashboard links. Parameters must be specified as constants or variables. Constant parameters currently only supported
Lists the sources that will not be checked for this alert, due to matching a maintenance window
The names of the active maintenance windows that are affecting this alert
Lists the series that are starting to fail, defined as failing for greater than 50% of the checks in the window determined by the "minutes" parameter
A derived field listing the webhook ids used by this alert
When this alert last caused a notification, in epoch millis
How often to re-trigger a continually failing alert. If absent or <= 0, no retriggering occurs
alertsLastDay
alertsLastWeek
alertsLastMonth
Number of points scanned in alert query time frame.
If this is a system alert, the version of it
Alert type.
Whether to alert on the real-time ingestion stream (may be noisy due to late data)
Whether to secure sensitive metric details and alert images in alert notifications, to not break Metrics Security.
enablePDIncidentBySeries
Get the ingestion policy Id associated with ingestion policy alert.
List of links to tracing applications that caused a failing series
Attribute used for default alert sort that is derived from state and severity
Alert severity list for multi-threshold type.
The y-axis unit of Alert chart.
The base of alert chart. A linear chart will have base as 1. A logarithmic chart will have the other base value.The value should be an integer and should greater than or equal to 1.
The description of alert chart. Different from alert additional info, this is used to describe the characteristics of the chart.
Api model for ingestion policy metadata
{
"usageInBillingPeriod": "integer",
"customer": "string",
"ingestionPolicyId": "string"
}
ingestion policy usage in billing period
ID of the customer to which the ingestion policy metadata belongs
The unique ID for the ingestion policy to which the metadata belongs
Api model for ingestion policy
{
"accounts": [
{
"name": "string",
"id": "string",
"description": "string"
}
],
"groups": [
{
"name": "string",
"id": "string",
"description": "string"
}
],
"metadata": {
"usageInBillingPeriod": "integer",
"customer": "string",
"ingestionPolicyId": "string"
},
"name": "string",
"id": "string",
"description": "string",
"scope": "string",
"alert": {
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": "boolean",
"lastEventTime": "integer",
"hidden": "boolean",
"severity": "string",
"minutes": "integer",
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": "integer",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": "boolean",
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": "boolean",
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": "boolean",
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": "boolean",
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": "integer",
"snoozed": "integer",
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"querySyntaxError": "boolean",
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"notificants": [
"string"
],
"lastNotificationMillis": "integer",
"notificationResendFrequencyMinutes": "integer",
"alertsLastDay": "integer",
"alertsLastWeek": "integer",
"alertsLastMonth": "integer",
"numPointsInFailureFrame": "integer",
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"systemAlertVersion": "integer",
"alertType": "string",
"evaluateRealtimeData": "boolean",
"secureMetricDetails": "boolean",
"enablePDIncidentBySeries": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": "integer",
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": "integer",
"alertChartDescription": "string"
},
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string",
"sources": [
"string"
],
"alertId": "string",
"isLimited": "boolean",
"limitPPS": "integer",
"namespaces": [
"string"
],
"pointTags": [
{
"key": "string",
"value": "string"
}
],
"tagsAnded": "boolean"
}
The name of the ingestion policy
The unique ID for the ingestion policy
The description of the ingestion policy
The scope of the ingestion policy
The last time when the ingestion policy is updated, in epoch milliseconds
The account that updated this ingestion policy last time
ID of the customer to which the ingestion policy belongs
The sources associated with the ingestion policy
The ingestion policy alert Id
Whether the ingestion policy is limited
The PPS limit of the ingestion policy
The namespaces associated with the ingestion policy
Whether tags should be AND-ed or OR-ed.If true, a metric must contain all tags in order for the ingestion policy to apply. If false, the tags are OR-ed, and a metric must contain one of the tags. Default: false
Api model for ingestion policy
{
"alert": {
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": "boolean",
"lastEventTime": "integer",
"conditionsThresholdOperator": "string",
"hidden": "boolean",
"severity": "string",
"minutes": "integer",
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": "integer",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": "boolean",
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": "boolean",
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": "boolean",
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": "boolean",
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": "integer",
"snoozed": "integer",
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"querySyntaxError": "boolean",
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"notificants": [
"string"
],
"lastNotificationMillis": "integer",
"notificationResendFrequencyMinutes": "integer",
"alertsLastDay": "integer",
"alertsLastWeek": "integer",
"alertsLastMonth": "integer",
"numPointsInFailureFrame": "integer",
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"systemAlertVersion": "integer",
"alertType": "string",
"evaluateRealtimeData": "boolean",
"secureMetricDetails": "boolean",
"enablePDIncidentBySeries": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": "integer",
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": "integer",
"alertChartDescription": "string"
},
"accounts": [
"string"
],
"groups": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"scope": "string",
"sources": [
"string"
],
"alertId": "string",
"isLimited": "boolean",
"limitPPS": "integer",
"namespaces": [
"string"
],
"pointTags": [
{
"key": "string",
"value": "string"
}
],
"tagsAnded": "boolean",
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string"
}
The accounts associated with the ingestion policy
The groups associated with the ingestion policy
The name of the ingestion policy
The unique ID for the ingestion policy
The description of the ingestion policy
The scope of the ingestion policy
The sources associated with the ingestion policy
The ingestion policy alert Id
Whether the ingestion policy is limited
The PPS limit of the ingestion policy
The namespaces associated with the ingestion policy
Whether tags should be AND-ed or OR-ed.If true, a metric must contain all tags in order for the ingestion policy to apply. If false, the tags are OR-ed, and a metric must contain one of the tags. Default: false
The last time when the ingestion policy is updated, in epoch milliseconds
The account that updated this ingestion policy last time
ID of the customer to which the ingestion policy belongs
Install Alerts
{
"target": "string"
}
target
Wavefront integrations are a set of incoming metrics along with a bundle of functionality (initially dashboards but alerts, webhooks, and the like in the near future
{
"version": "string",
"hidden": "boolean",
"name": "string",
"id": "string",
"description": "string",
"icon": "string",
"metrics": {
"chartObjs": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
],
"display": [
"string"
],
"required": [
"string"
],
"charts": [
"string"
],
"prefixes": [
"string"
],
"ppsDimensions": [
"string"
]
},
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"aliasOf": "string",
"aliasIntegrations": [
{
"name": "string",
"id": "string",
"description": "string",
"icon": "string",
"baseUrl": "string"
}
],
"dashboards": [
{
"name": "string",
"description": "string",
"dashboardObj": {
"modifyAclAccess": "boolean",
"hidden": "boolean",
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"customer": "string",
"url": "string",
"eventFilterType": "string",
"forceV2UI": "boolean",
"sections": [
{
"name": "string",
"id": "string",
"rows": [
{
"heightFactor": "integer",
"charts": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
]
}
]
}
],
"disableRefreshInLiveMode": "boolean",
"hideChartWarning": "boolean",
"displayDescription": "boolean",
"displaySectionTableOfContents": "boolean",
"displayQueryParameters": "boolean",
"chartTitleScalar": "integer",
"eventQuery": "string",
"defaultTimeWindow": "string",
"defaultStartTime": "integer",
"defaultEndTime": "integer",
"chartTitleColor": "string",
"chartTitleBgColor": "string",
"viewsLastDay": "integer",
"viewsLastWeek": "integer",
"viewsLastMonth": "integer",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"includeObsoleteMetrics": "boolean",
"creatorId": "string",
"updaterId": "string",
"numCharts": "integer",
"numFavorites": "integer",
"favorite": "boolean"
},
"url": "string",
"dashboardMinObj": {
"name": "string",
"id": "string",
"description": "string"
}
}
],
"status": {
"contentStatus": "string",
"installStatus": "string"
},
"baseUrl": "string",
"alerts": [
{
"name": "string",
"description": "string",
"alertObj": {
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": "boolean",
"lastEventTime": "integer",
"hidden": "boolean",
"severity": "string",
"minutes": "integer",
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": "integer",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": "boolean",
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": "boolean",
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": "boolean",
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": "boolean",
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": "integer",
"snoozed": "integer",
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"querySyntaxError": "boolean",
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"notificants": [
"string"
],
"lastNotificationMillis": "integer",
"notificationResendFrequencyMinutes": "integer",
"alertsLastDay": "integer",
"alertsLastWeek": "integer",
"alertsLastMonth": "integer",
"numPointsInFailureFrame": "integer",
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"systemAlertVersion": "integer",
"alertType": "string",
"evaluateRealtimeData": "boolean",
"secureMetricDetails": "boolean",
"enablePDIncidentBySeries": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": "integer",
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": "integer",
"alertChartDescription": "string"
},
"url": "string",
"alertMinObj": {
"name": "string",
"id": "string"
}
}
],
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string",
"overview": "string",
"setup": "string",
"metricsDocs": "string",
"haveMetricDropdown": "boolean",
"setups": [
{
"type": "string",
"description": "string",
"title": "string",
"filePath": "string"
}
]
}
Integration version string
Integration is hidden or not
Integration name
id
Integration description
URI path to the integration icon
createdEpochMillis
updatedEpochMillis
If set, designates this integration as an alias integration, of the integration whose id is specified.
If set, a list of objects describing integrations that alias this one.
A list of dashboards belonging to this integration
Base URL for this integration's assets
deleted
creatorId
updaterId
Descriptive text giving an overview of integration functionality
How the integration will be set-up
Metric Preview File Name
Integration have metric dropdown or not
A alert definition belonging to a particular integration
{
"name": "string",
"description": "string",
"alertObj": {
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": "boolean",
"lastEventTime": "integer",
"hidden": "boolean",
"severity": "string",
"minutes": "integer",
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": "integer",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": "boolean",
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": "boolean",
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": "boolean",
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": "boolean",
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": "integer",
"snoozed": "integer",
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"querySyntaxError": "boolean",
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"notificants": [
"string"
],
"lastNotificationMillis": "integer",
"notificationResendFrequencyMinutes": "integer",
"alertsLastDay": "integer",
"alertsLastWeek": "integer",
"alertsLastMonth": "integer",
"numPointsInFailureFrame": "integer",
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"systemAlertVersion": "integer",
"alertType": "string",
"evaluateRealtimeData": "boolean",
"secureMetricDetails": "boolean",
"enablePDIncidentBySeries": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": "integer",
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": "integer",
"alertChartDescription": "string"
},
"url": "string",
"alertMinObj": {
"name": "string",
"id": "string"
}
}
An integration that aliases this one
{
"name": "string",
"id": "string",
"description": "string",
"icon": "string",
"baseUrl": "string"
}
Name of the alias Integration
ID of the alias Integration
Description of the alias Integration
Icon path of the alias Integration
Base URL of this alias Integration
A dashboard definition belonging to a particular integration
{
"name": "string",
"description": "string",
"dashboardObj": {
"modifyAclAccess": "boolean",
"hidden": "boolean",
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"customer": "string",
"url": "string",
"eventFilterType": "string",
"forceV2UI": "boolean",
"sections": [
{
"name": "string",
"id": "string",
"rows": [
{
"heightFactor": "integer",
"charts": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
]
}
]
}
],
"disableRefreshInLiveMode": "boolean",
"hideChartWarning": "boolean",
"displayDescription": "boolean",
"displaySectionTableOfContents": "boolean",
"displayQueryParameters": "boolean",
"chartTitleScalar": "integer",
"eventQuery": "string",
"defaultTimeWindow": "string",
"defaultStartTime": "integer",
"defaultEndTime": "integer",
"chartTitleColor": "string",
"chartTitleBgColor": "string",
"viewsLastDay": "integer",
"viewsLastWeek": "integer",
"viewsLastMonth": "integer",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"includeObsoleteMetrics": "boolean",
"creatorId": "string",
"updaterId": "string",
"numCharts": "integer",
"numFavorites": "integer",
"favorite": "boolean"
},
"url": "string",
"dashboardMinObj": {
"name": "string",
"id": "string",
"description": "string"
}
}
Dashboard name
Dashboard description
URL path to the JSON definition of this dashboard
A functional group of integrations defined together in a manifest
{
"integrations": [
"string"
],
"integrationObjs": [
{
"version": "string",
"hidden": "boolean",
"name": "string",
"id": "string",
"description": "string",
"icon": "string",
"metrics": {
"chartObjs": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
],
"display": [
"string"
],
"required": [
"string"
],
"charts": [
"string"
],
"prefixes": [
"string"
],
"ppsDimensions": [
"string"
]
},
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"aliasOf": "string",
"aliasIntegrations": [
{
"name": "string",
"id": "string",
"description": "string",
"icon": "string",
"baseUrl": "string"
}
],
"dashboards": [
{
"name": "string",
"description": "string",
"dashboardObj": {
"modifyAclAccess": "boolean",
"hidden": "boolean",
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"customer": "string",
"url": "string",
"eventFilterType": "string",
"forceV2UI": "boolean",
"sections": [
{
"name": "string",
"id": "string",
"rows": [
{
"heightFactor": "integer",
"charts": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
]
}
]
}
],
"disableRefreshInLiveMode": "boolean",
"hideChartWarning": "boolean",
"displayDescription": "boolean",
"displaySectionTableOfContents": "boolean",
"displayQueryParameters": "boolean",
"chartTitleScalar": "integer",
"eventQuery": "string",
"defaultTimeWindow": "string",
"defaultStartTime": "integer",
"defaultEndTime": "integer",
"chartTitleColor": "string",
"chartTitleBgColor": "string",
"viewsLastDay": "integer",
"viewsLastWeek": "integer",
"viewsLastMonth": "integer",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"includeObsoleteMetrics": "boolean",
"creatorId": "string",
"updaterId": "string",
"numCharts": "integer",
"numFavorites": "integer",
"favorite": "boolean"
},
"url": "string",
"dashboardMinObj": {
"name": "string",
"id": "string",
"description": "string"
}
}
],
"status": {
"contentStatus": "string",
"installStatus": "string"
},
"baseUrl": "string",
"alerts": [
{
"name": "string",
"description": "string",
"alertObj": {
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": "boolean",
"lastEventTime": "integer",
"hidden": "boolean",
"severity": "string",
"minutes": "integer",
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": "integer",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": "boolean",
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": "boolean",
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": "boolean",
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": "boolean",
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": "integer",
"snoozed": "integer",
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"querySyntaxError": "boolean",
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"notificants": [
"string"
],
"lastNotificationMillis": "integer",
"notificationResendFrequencyMinutes": "integer",
"alertsLastDay": "integer",
"alertsLastWeek": "integer",
"alertsLastMonth": "integer",
"numPointsInFailureFrame": "integer",
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"systemAlertVersion": "integer",
"alertType": "string",
"evaluateRealtimeData": "boolean",
"secureMetricDetails": "boolean",
"enablePDIncidentBySeries": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": "integer",
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": "integer",
"alertChartDescription": "string"
},
"url": "string",
"alertMinObj": {
"name": "string",
"id": "string"
}
}
],
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string",
"overview": "string",
"setup": "string",
"metricsDocs": "string",
"haveMetricDropdown": "boolean",
"setups": [
{
"type": "string",
"description": "string",
"title": "string",
"filePath": "string"
}
]
}
],
"title": "string",
"subtitle": "string"
}
A list of paths to JSON definitions for integrations in this group
Materialized JSONs for integrations belonging to this group, as referenced by integrations
Title of this integration group
Subtitle of this integration group
Definition of the metrics belonging this integration
{
"chartObjs": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
],
"display": [
"string"
],
"required": [
"string"
],
"charts": [
"string"
],
"prefixes": [
"string"
],
"ppsDimensions": [
"string"
]
}
Set of metrics that are displayed in the metric panel during integration setup
Set of "canary" metrics that define the "liveness" of this integration's metric ingestion
URLs for JSON definitions of charts that display info about this integration's metrics
Set of metric prefix namespaces belonging to this integration
For reported points belonging to this integration, these point tags are escalated to the internal point-rate counters so that reporting can be broken out by these dimensions
Status of this integration
{
"contentStatus": "string",
"installStatus": "string"
}
Status of integration content, e.g. dashboards
Whether the customer or an automated process has installed the dashboards for this integration
A Map from names of the required metrics to an object representing their reporting status. The reporting status object has 3 boolean fields denoting whether the metric has been received during the corresponding time period: ever
, recentExceptNow
, and now
. now
is on the order of a few hours, and recentExceptNow
is on the order of the past few days, excluding the period considered to be now
.
A Map from the ids of the alerts contained in this integration to their install status. The install status can take on one of three values, VISIBLE
, HIDDEN
, and NOT_LOADED
Representation of a wavefront kubernetes components
{
"name": "string",
"lastUpdated": "integer"
}
Name of the monitored cluster component
Status of the monitored cluster component
Last updated time of the monitored cluster component
Representation of a wavefront kubernetes components statuses
{
"name": "string",
"description": "string",
"status": "boolean"
}
Name of the component status
Description of component status
Status value
{
"name": "string"
}
name
{
"columns": [
"string"
]
}
columns
Wavefront maintenance window entity
{
"id": "string",
"reason": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"title": "string",
"customerId": "string",
"creatorId": "string",
"updaterId": "string",
"startTimeInSeconds": "integer",
"endTimeInSeconds": "integer",
"relevantCustomerTags": [
"string"
],
"relevantHostNames": [
"string"
],
"relevantHostTags": [
"string"
],
"relevantCustomerTagsAnded": "boolean",
"relevantHostTagsAnded": "boolean",
"hostTagGroupHostNamesGroupAnded": "boolean",
"pointTagFilter": "string",
"pointTagFilterAnded": "boolean",
"eventName": "string",
"targets": [
"string"
],
"sortAttr": "integer",
"runningState": "string"
}
id
The purpose of this maintenance window
createdEpochMillis
updatedEpochMillis
Title of this maintenance window
customerId
creatorId
updaterId
The time in epoch seconds when this maintenance window will start
The time in epoch seconds when this maintenance window will end
List of alert tags whose matching alerts will be put into maintenance because of this maintenance window
List of source/host names that will be put into maintenance because of this maintenance window
List of source/host tags whose matching sources/hosts will be put into maintenance because of this maintenance window
Whether to AND customer tags listed in relevantCustomerTags. If true, a customer must contain all tags in order for the maintenance window to apply. If false, the tags are OR'ed, and a customer must contain one of the tags. Default: false
Whether to AND source/host tags listed in relevantHostTags. If true, a source/host must contain all tags in order for the maintenance window to apply. If false, the tags are OR'ed, and a source/host must contain one of the tags. Default: false
If true, a source/host must be in 'relevantHostNames' and have tags matching the specification formed by 'relevantHostTags' and 'relevantHostTagsAnded' in order for this maintenance window to apply. If false, a source/host must either be in 'relevantHostNames' or match 'relevantHostTags' and 'relevantHostTagsAnded'. Default: false
Query that filters on point tags of timeseries scanned by alert.
Whether to AND point tags filter listed in pointTagFilter. If true, a timeseries must contain the point tags along with other filters in order for the maintenance window to apply.If false, the tags are OR'ed, the customer must contain one of the tags. Default: false
The name of an event associated with the creation/update of this maintenance window
List of targets to notify, overriding the alert's targets.
Numeric value used in default sorting
runningState
A message for display to a particular user, all users within a customer, or all users on a cluster
{
"source": "string",
"severity": "string",
"id": "string",
"target": "string",
"content": "string",
"scope": "string",
"startEpochMillis": "integer",
"endEpochMillis": "integer",
"display": "string",
"title": "string",
"read": "boolean"
}
Message severity
id
For scope=CUSTOMER or scope=USER, the individual customer or user id
Message content
A string->string map of additional properties associated with this message
The audience scope that this message should reach
When this message will begin to be displayed, in epoch millis
When this message will stop being displayed, in epoch millis
The form of display for this message
Title of this message
A derived field for whether the current user has read this message
Details of the reporting metric
{
"host": "string",
"last_update": "integer"
}
The source reporting this metric
Approximate time of last reporting, in milliseconds since the Unix epoch
A key-value map of the point tags associated with this source
Response container for MetricDetails
{
"continuationToken": "string",
"hosts": [
{
"host": "string",
"last_update": "integer"
}
]
}
Token used for pagination of results
{
"status": "string",
"ever": "boolean",
"recentExceptNow": "boolean",
"now": "boolean"
}
status
ever
recentExceptNow
now
Metrics policy entity for read requests.
{
"policyRules": [
{
"accounts": [
{
"name": "string",
"id": "string",
"description": "string"
}
],
"userGroups": [
{
"name": "string",
"id": "string",
"description": "string"
}
],
"roles": [
{
"name": "string",
"id": "string",
"description": "string"
}
],
"name": "string",
"id": "string",
"description": "string",
"tagsAnded": "boolean",
"tags": [
{
"key": "string",
"value": "string"
}
],
"prefixes": [
"string"
],
"accessType": "string"
}
],
"updatedEpochMillis": "integer",
"customer": "string",
"updaterId": "string"
}
The date time of the metrics policy update
The customer identifier of the metrics policy
The id of the metrics policy updater
Metrics policy entity for write requests
{
"policyRules": [
{
"accounts": [
"string"
],
"roles": [
"string"
],
"userGroups": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"tagsAnded": "boolean",
"tags": [
{
"key": "string",
"value": "string"
}
],
"prefixes": [
"string"
],
"accessType": "string"
}
],
"updatedEpochMillis": "integer",
"customer": "string",
"updaterId": "string"
}
The date time of the metrics policy update
The customer identifier of the metrics policy
The id of the metrics policy updater
{
"name": "string",
"classLoader": "ClassLoader Object",
"descriptor": {
"open": "boolean",
"automatic": "boolean"
},
"named": "boolean",
"annotations": [
{
"key": "string",
"value": "string"
}
],
"declaredAnnotations": [
{
"key": "string",
"value": "string"
}
],
"packages": [
"string"
]
}
name
named
packages
{
"open": "boolean",
"automatic": "boolean"
}
open
automatic
{
"serviceCount": "integer",
"hidden": "boolean",
"application": "string",
"status": "string",
"lastReported": "integer",
"satisfiedLatencyMillis": "integer",
"created": "integer",
"updateUserId": "string",
"lastUpdated": "integer"
}
Number of monitored service of monitored application
Monitored application is hidden or not
Application Name of the monitored application
Status of monitored application
Last reported epoch of monitored application
Satisfied latency of monitored application
Created epoch of monitored application
Last update user id of monitored application
Last update epoch of monitored application
Representation of a wavefront monitored cluster
{
"version": "string",
"name": "string",
"id": "string",
"components": [
{
"name": "string",
"lastUpdated": "integer"
}
],
"tags": [
"string"
],
"deleted": "boolean",
"alias": "string",
"platform": "string",
"monitored": "boolean",
"lastUpdated": "integer"
}
Version of monitored cluster
Name of the monitored cluster
Id of monitored cluster which is same as actual cluster id
additionalTags
tags
deleted
ID of a monitored cluster that was merged into this one.
Monitored cluster type
monitored
lastUpdated
{
"serviceInstanceCount": "integer",
"hidden": "boolean",
"source": "string",
"component": "string",
"application": "string",
"service": "string",
"customDashboardLink": "string",
"status": "string",
"lastReported": "integer",
"satisfiedLatencyMillis": "integer",
"created": "integer",
"updateUserId": "string",
"lastUpdated": "integer"
}
Service Instance count of the monitored service
Monitored service is hidden or not
Source of the monitored service
Component Name of the monitored service
Application Name of the monitored service
Service Name of the monitored service
Customer dashboard link
Status of monitored service
Last reported epoch of monitored service
Satisfied latency of monitored service
Created epoch of monitored service
Last update user id of monitored service
Last update epoch of monitored service
Configurations specific to the NewRelic integration. Only applicable when the containing Credential has service=NEWRELIC
{
"apiKey": "string",
"appFilterRegex": "^hostingservice-(prod|dev)*$",
"hostFilterRegex": "host[1-9].xyz.com",
"newRelicMetricFilters": [
{
"appName": "string",
"metricFilterRegex": "string"
}
]
}
New Relic REST API Key.
A regular expression that a application name must match (case-insensitively) in order to collect metrics.
A regular expression that a host name must match (case-insensitively) in order to collect metrics.
{
"appName": "string",
"metricFilterRegex": "string"
}
appName
metricFilterRegex
Wavefront notificant entity
{
"method": "string",
"id": "string",
"contentType": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"title": "string",
"customerId": "string",
"triggers": [
"string"
],
"template": "string",
"recipient": "string",
"emailSubject": "string",
"isHtmlContent": "boolean",
"routes": [
{
"method": "string",
"target": "string",
"filter": "string"
}
],
"creatorId": "string",
"updaterId": "string"
}
The notification method used for notification target.
id
The value of the Content-Type header of the webhook POST request.
Description
createdEpochMillis
updatedEpochMillis
Title
customerId
A list of occurrences on which this webhook will be fired. Valid values are ALERT_OPENED, ALERT_UPDATED, ALERT_RESOLVED, ALERT_MAINTENANCE, ALERT_SNOOZED
A mustache template that will form the body of the POST request, email and summary of the PagerDuty.
The end point for the notification target.EMAIL: email address. PAGERDUTY: PagerDuty routing Key. WEBHOOK: URL end point
A string->string map specifying the custom HTTP header key / value pairs that will be sent in the requests of this web hook
The subject title of an email notification target
Determine whether the email alert target content is sent as html or text.
creatorId
updaterId
Notification Messages for preview
{
"name": "string",
"method": "string",
"id": "string",
"content": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string",
"subject": "string"
}
The alert target name, easier to read than ID
The notification method, can either be WEBHOOK, EMAIL or PAGERDUTY
id
content
createdEpochMillis
updatedEpochMillis
deleted
creatorId
updaterId
subject
additionalInfo
{
"name": "string",
"specificationTitle": "string",
"specificationVersion": "string",
"specificationVendor": "string",
"implementationTitle": "string",
"implementationVersion": "string",
"implementationVendor": "string",
"annotations": [
{
"key": "string",
"value": "string"
}
],
"declaredAnnotations": [
{
"key": "string",
"value": "string"
}
],
"sealed": "boolean"
}
name
specificationTitle
specificationVersion
specificationVendor
implementationTitle
implementationVersion
implementationVendor
sealed
{
"items": [
{
"unitedRoles": [
"string"
],
"unitedPermissions": [
"string"
],
"identifier": "string",
"groups": [
"string"
],
"roles": [
"string"
],
"userGroups": [
"string"
]
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": "boolean",
"lastEventTime": "integer",
"hidden": "boolean",
"severity": "string",
"minutes": "integer",
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": "integer",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": "boolean",
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": "boolean",
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": "boolean",
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": "boolean",
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": "integer",
"snoozed": "integer",
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"querySyntaxError": "boolean",
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"notificants": [
"string"
],
"lastNotificationMillis": "integer",
"notificationResendFrequencyMinutes": "integer",
"alertsLastDay": "integer",
"alertsLastWeek": "integer",
"alertsLastMonth": "integer",
"numPointsInFailureFrame": "integer",
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"systemAlertVersion": "integer",
"alertType": "string",
"evaluateRealtimeData": "boolean",
"secureMetricDetails": "boolean",
"enablePDIncidentBySeries": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": "integer",
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": "integer",
"alertChartDescription": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": "boolean",
"lastEventTime": "integer",
"hidden": "boolean",
"severity": "string",
"minutes": "integer",
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": "integer",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": "boolean",
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": "boolean",
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": "boolean",
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": "boolean",
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": "integer",
"snoozed": "integer",
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"querySyntaxError": "boolean",
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"notificants": [
"string"
],
"lastNotificationMillis": "integer",
"notificationResendFrequencyMinutes": "integer",
"alertsLastDay": "integer",
"alertsLastWeek": "integer",
"alertsLastMonth": "integer",
"numPointsInFailureFrame": "integer",
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"systemAlertVersion": "integer",
"alertType": "string",
"evaluateRealtimeData": "boolean",
"secureMetricDetails": "boolean",
"enablePDIncidentBySeries": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": "integer",
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": "integer",
"alertChartDescription": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
A map from alert state to the number of alerts in that state within the search results
{
"items": [
{
"id": "string",
"model": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"row": "integer",
"dashboardId": "string",
"endMs": "integer",
"queryHash": "string",
"imageLink": "string",
"chartHash": "string",
"paramHash": "string",
"startMs": "integer",
"section": "integer",
"col": "integer",
"chartLink": "string",
"originalStripes": [
{
"model": "string",
"endMs": "integer",
"imageLink": "string",
"startMs": "integer"
}
],
"updatedMs": "integer",
"deleted": "boolean",
"customer": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"accountType": "string",
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"dateGenerated": "integer",
"customer": "string",
"lastUsed": "integer",
"account": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"forceSave": "boolean",
"reuseExternalIdCredential": "string",
"name": "string",
"id": "string",
"service": "string",
"lastReceivedDataPointMs": "integer",
"lastMetricCount": "integer",
"cloudWatch": {
"namespaces": [
"string"
],
"metricFilterRegex": "^aws.(billing|instance|sqs|sns|reservedInstance|ebs|route53.health|ec2.status|elb).*$",
"baseCredentials": {
"roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
"externalId": "string"
},
"instanceSelectionTagsExpr": "string",
"volumeSelectionTagsExpr": "string",
"pointTagFilterRegex": "(region|name)",
"s3BucketNameFilterRegex": "^(test|demo).*$",
"threadDistributionInMins": "integer"
},
"cloudTrail": {
"region": "string",
"prefix": "string",
"bucketName": "string",
"baseCredentials": {
"roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
"externalId": "string"
},
"filterRule": "string"
},
"ec2": {
"metricFilterRegex": "^aws.(sqs|ebs).*$",
"baseCredentials": {
"roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
"externalId": "string"
},
"hostNameTags": [
"string"
],
"instanceSelectionTagsExpr": "string",
"volumeSelectionTagsExpr": "string",
"pointTagFilterRegex": "(region|name)"
},
"gcp": {
"metricFilterRegex": "^gcp.(compute|container|pubsub).*$",
"projectId": "string",
"gcpJsonKey": "string",
"disableHistogramToMetricConversion": "boolean",
"disableDeltaCounts": "boolean",
"categoriesToFetch": [
"string"
],
"customMetricPrefix": [
"string"
]
},
"gcpBilling": {
"projectId": "string",
"gcpJsonKey": "string",
"gcpApiKey": "string"
},
"newRelic": {
"apiKey": "string",
"appFilterRegex": "^hostingservice-(prod|dev)*$",
"hostFilterRegex": "host[1-9].xyz.com",
"newRelicMetricFilters": [
{
"appName": "string",
"metricFilterRegex": "string"
}
]
},
"appDynamics": {
"userName": "user1@account1",
"controllerName": "string",
"encryptedPassword": "string",
"enableRollup": "boolean",
"enableErrorMetrics": "boolean",
"enableBusinessTrxMetrics": "boolean",
"enableBackendMetrics": "boolean",
"enableOverallPerfMetrics": "boolean",
"enableIndividualNodeMetrics": "boolean",
"enableAppInfraMetrics": "boolean",
"enableServiceEndpointMetrics": "boolean",
"appFilterRegex": [
"string"
]
},
"dynatrace": {
"metricFilterRegex": "^dynatrace.(builtin|dsfm).*$",
"environmentID": "example",
"dynatraceAPIToken": "string"
},
"azure": {
"metricFilterRegex": "^azure.(compute|network|dbforpostgresql).*$",
"baseCredentials": {
"clientId": "string",
"clientSecret": "string",
"tenant": "string"
},
"categoryFilter": [
"string"
],
"resourceGroupFilter": [
"string"
]
},
"azureActivityLog": {
"baseCredentials": {
"clientId": "string",
"clientSecret": "string",
"tenant": "string"
},
"categoryFilter": [
"string"
]
},
"lastErrorMs": "integer",
"lastProcessorId": "string",
"lastProcessingTimestamp": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"serviceRefreshRateInMins": "integer",
"vrops": {
"baseURL": "https://www.mgmt.cloud.vmware.com/vrops-cloud",
"metricFilterRegex": "^vrops.(vmware|cloudhealthadapter).(clustercomputeresource|datastore).*$",
"categoriesToFetch": [
"string"
],
"vropsAPIToken": "string",
"organizationID": "string"
},
"disabled": "boolean",
"lastError": "string",
"deleted": "boolean",
"inTrash": "boolean",
"lastErrorEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"creatorId": "string",
"updaterId": "string",
"snowflake": {
"userName": "string",
"password": "string",
"metricFilterRegex": "string",
"privateKey": "string",
"role": "string",
"accountID": "string",
"warehouse": "string"
}
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"unitedRoles": [
"string"
],
"unitedPermissions": [
"string"
],
"userGroups": [
"string"
],
"id": "string",
"identifier": "string",
"groups": [
"string"
],
"customer": "string",
"lastSuccessfulLogin": "integer",
"escapedIdentifier": "string",
"gravatarUrl": "string",
"self": "boolean"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"modifyAclAccess": "boolean",
"hidden": "boolean",
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"customer": "string",
"url": "string",
"eventFilterType": "string",
"forceV2UI": "boolean",
"sections": [
{
"name": "string",
"id": "string",
"rows": [
{
"heightFactor": "integer",
"charts": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
]
}
]
}
],
"disableRefreshInLiveMode": "boolean",
"hideChartWarning": "boolean",
"displayDescription": "boolean",
"displaySectionTableOfContents": "boolean",
"displayQueryParameters": "boolean",
"chartTitleScalar": "integer",
"eventQuery": "string",
"defaultTimeWindow": "string",
"defaultStartTime": "integer",
"defaultEndTime": "integer",
"chartTitleColor": "string",
"chartTitleBgColor": "string",
"viewsLastDay": "integer",
"viewsLastWeek": "integer",
"viewsLastMonth": "integer",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"includeObsoleteMetrics": "boolean",
"creatorId": "string",
"updaterId": "string",
"numCharts": "integer",
"numFavorites": "integer",
"favorite": "boolean"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"tagpaths": [
"string"
],
"minutes": "integer",
"name": "string",
"id": "string",
"query": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"deleted": "boolean",
"created": "integer",
"queryQBEnabled": "boolean",
"queryQBSerialization": "string",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"tagpaths": [
"string"
],
"minutes": "integer",
"name": "string",
"id": "string",
"query": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"deleted": "boolean",
"created": "integer",
"queryQBEnabled": "boolean",
"queryQBSerialization": "string",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
A map from the state of the derived metric definition to the number of entities in that state within the search results
{
"items": [
{
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"template": "string",
"metricFilterRegex": "string",
"sourceFilterRegex": "string",
"isLogIntegration": "boolean",
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"accounts": [
{
"name": "string",
"id": "string",
"description": "string"
}
],
"groups": [
{
"name": "string",
"id": "string",
"description": "string"
}
],
"metadata": {
"usageInBillingPeriod": "integer",
"customer": "string",
"ingestionPolicyId": "string"
},
"name": "string",
"id": "string",
"description": "string",
"scope": "string",
"alert": {
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": "boolean",
"lastEventTime": "integer",
"hidden": "boolean",
"severity": "string",
"minutes": "integer",
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": "integer",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": "boolean",
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": "boolean",
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": "boolean",
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": "boolean",
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": "integer",
"snoozed": "integer",
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"querySyntaxError": "boolean",
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"notificants": [
"string"
],
"lastNotificationMillis": "integer",
"notificationResendFrequencyMinutes": "integer",
"alertsLastDay": "integer",
"alertsLastWeek": "integer",
"alertsLastMonth": "integer",
"numPointsInFailureFrame": "integer",
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"systemAlertVersion": "integer",
"alertType": "string",
"evaluateRealtimeData": "boolean",
"secureMetricDetails": "boolean",
"enablePDIncidentBySeries": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": "integer",
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": "integer",
"alertChartDescription": "string"
},
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string",
"sources": [
"string"
],
"alertId": "string",
"isLimited": "boolean",
"limitPPS": "integer",
"namespaces": [
"string"
],
"pointTags": [
{
"key": "string",
"value": "string"
}
],
"tagsAnded": "boolean"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"version": "string",
"hidden": "boolean",
"name": "string",
"id": "string",
"description": "string",
"icon": "string",
"metrics": {
"chartObjs": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
],
"display": [
"string"
],
"required": [
"string"
],
"charts": [
"string"
],
"prefixes": [
"string"
],
"ppsDimensions": [
"string"
]
},
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"aliasOf": "string",
"aliasIntegrations": [
{
"name": "string",
"id": "string",
"description": "string",
"icon": "string",
"baseUrl": "string"
}
],
"dashboards": [
{
"name": "string",
"description": "string",
"dashboardObj": {
"modifyAclAccess": "boolean",
"hidden": "boolean",
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"customer": "string",
"url": "string",
"eventFilterType": "string",
"forceV2UI": "boolean",
"sections": [
{
"name": "string",
"id": "string",
"rows": [
{
"heightFactor": "integer",
"charts": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
]
}
]
}
],
"disableRefreshInLiveMode": "boolean",
"hideChartWarning": "boolean",
"displayDescription": "boolean",
"displaySectionTableOfContents": "boolean",
"displayQueryParameters": "boolean",
"chartTitleScalar": "integer",
"eventQuery": "string",
"defaultTimeWindow": "string",
"defaultStartTime": "integer",
"defaultEndTime": "integer",
"chartTitleColor": "string",
"chartTitleBgColor": "string",
"viewsLastDay": "integer",
"viewsLastWeek": "integer",
"viewsLastMonth": "integer",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"includeObsoleteMetrics": "boolean",
"creatorId": "string",
"updaterId": "string",
"numCharts": "integer",
"numFavorites": "integer",
"favorite": "boolean"
},
"url": "string",
"dashboardMinObj": {
"name": "string",
"id": "string",
"description": "string"
}
}
],
"status": {
"contentStatus": "string",
"installStatus": "string"
},
"baseUrl": "string",
"alerts": [
{
"name": "string",
"description": "string",
"alertObj": {
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": "boolean",
"lastEventTime": "integer",
"hidden": "boolean",
"severity": "string",
"minutes": "integer",
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": "integer",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": "boolean",
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": "boolean",
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": "boolean",
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": "boolean",
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": "integer",
"snoozed": "integer",
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"querySyntaxError": "boolean",
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"notificants": [
"string"
],
"lastNotificationMillis": "integer",
"notificationResendFrequencyMinutes": "integer",
"alertsLastDay": "integer",
"alertsLastWeek": "integer",
"alertsLastMonth": "integer",
"numPointsInFailureFrame": "integer",
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"systemAlertVersion": "integer",
"alertType": "string",
"evaluateRealtimeData": "boolean",
"secureMetricDetails": "boolean",
"enablePDIncidentBySeries": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": "integer",
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": "integer",
"alertChartDescription": "string"
},
"url": "string",
"alertMinObj": {
"name": "string",
"id": "string"
}
}
],
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string",
"overview": "string",
"setup": "string",
"metricsDocs": "string",
"haveMetricDropdown": "boolean",
"setups": [
{
"type": "string",
"description": "string",
"title": "string",
"filePath": "string"
}
]
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"id": "string",
"reason": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"title": "string",
"customerId": "string",
"creatorId": "string",
"updaterId": "string",
"startTimeInSeconds": "integer",
"endTimeInSeconds": "integer",
"relevantCustomerTags": [
"string"
],
"relevantHostNames": [
"string"
],
"relevantHostTags": [
"string"
],
"relevantCustomerTagsAnded": "boolean",
"relevantHostTagsAnded": "boolean",
"hostTagGroupHostNamesGroupAnded": "boolean",
"pointTagFilter": "string",
"pointTagFilterAnded": "boolean",
"eventName": "string",
"targets": [
"string"
],
"sortAttr": "integer",
"runningState": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"source": "string",
"severity": "string",
"id": "string",
"target": "string",
"content": "string",
"scope": "string",
"startEpochMillis": "integer",
"endEpochMillis": "integer",
"display": "string",
"title": "string",
"read": "boolean"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"serviceCount": "integer",
"hidden": "boolean",
"application": "string",
"status": "string",
"lastReported": "integer",
"satisfiedLatencyMillis": "integer",
"created": "integer",
"updateUserId": "string",
"lastUpdated": "integer"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"version": "string",
"name": "string",
"id": "string",
"components": [
{
"name": "string",
"lastUpdated": "integer"
}
],
"tags": [
"string"
],
"deleted": "boolean",
"alias": "string",
"platform": "string",
"monitored": "boolean",
"lastUpdated": "integer"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"serviceInstanceCount": "integer",
"hidden": "boolean",
"source": "string",
"component": "string",
"application": "string",
"service": "string",
"customDashboardLink": "string",
"status": "string",
"lastReported": "integer",
"satisfiedLatencyMillis": "integer",
"created": "integer",
"updateUserId": "string",
"lastUpdated": "integer"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"method": "string",
"id": "string",
"contentType": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"title": "string",
"customerId": "string",
"triggers": [
"string"
],
"template": "string",
"recipient": "string",
"emailSubject": "string",
"isHtmlContent": "boolean",
"routes": [
{
"method": "string",
"target": "string",
"filter": "string"
}
],
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"version": "string",
"name": "string",
"id": "string",
"status": "string",
"customerId": "string",
"deleted": "boolean",
"lastCheckInTime": "integer",
"inTrash": "boolean",
"hostname": "string",
"proxyname": "string",
"lastKnownError": "string",
"lastErrorTime": "integer",
"lastErrorEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"timeDrift": "integer",
"bytesLeftForBuffer": "integer",
"bytesPerMinuteForBuffer": "integer",
"localQueueSize": "integer",
"sshAgent": "boolean",
"ephemeral": "boolean",
"shutdown": "boolean",
"truncate": "boolean",
"collectorSetsRateLimit": "boolean",
"collectorRateLimit": "integer",
"histogramRateLimit": "integer",
"sourceTagsRateLimit": "number",
"eventsRateLimit": "number",
"spanRateLimit": "integer",
"spanLogsRateLimit": "integer",
"preprocessorRules": "string",
"userId": "string",
"histoDisabled": "boolean",
"traceDisabled": "boolean",
"spanLogsDisabled": "boolean",
"logsDisabled": "boolean",
"statusCause": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"relatedData": {
"relatedId": "string",
"summary": "string",
"alertDescription": "string",
"anomalyChartLink": "string",
"commonSources": [
"string"
],
"commonMetrics": [
"string"
],
"commonDimensions": [
"string"
],
"enhancedScore": "number"
},
"similarityScore": "number",
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"relatedEventDTO": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"relatedData": {
"relatedId": "string",
"summary": "string",
"alertDescription": "string",
"anomalyChartLink": "string",
"commonSources": [
"string"
],
"commonMetrics": [
"string"
],
"commonDimensions": [
"string"
],
"enhancedScore": "number"
},
"similarityScore": "number",
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"relatedAnomalyDTO": {
"relatedData": {
"relatedId": "string",
"summary": "string",
"alertDescription": "string",
"anomalyChartLink": "string",
"commonSources": [
"string"
],
"commonMetrics": [
"string"
],
"commonDimensions": [
"string"
],
"enhancedScore": "number"
},
"id": "string",
"model": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"row": "integer",
"dashboardId": "string",
"endMs": "integer",
"queryHash": "string",
"imageLink": "string",
"chartHash": "string",
"paramHash": "string",
"startMs": "integer",
"section": "integer",
"col": "integer",
"chartLink": "string",
"originalStripes": [
{
"model": "string",
"endMs": "integer",
"imageLink": "string",
"startMs": "integer"
}
],
"updatedMs": "integer",
"deleted": "boolean",
"customer": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"creatorId": "string",
"updaterId": "string"
},
"similarityScore": "number"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": "integer",
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": "integer",
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": "boolean",
"usersRemovable": "boolean",
"usersAddable": "boolean",
"permsEditable": "boolean",
"deletable": "boolean"
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": [
"string"
],
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"entityType": "string",
"userId": "string",
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": [
"string"
],
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"unitedRoles": [
"string"
],
"unitedPermissions": [
"string"
],
"tokens": [
{
"tokenID": "string",
"tokenName": "string",
"account": "string",
"accountType": "string",
"lastUsed": "integer",
"dateGenerated": "integer"
}
],
"userGroups": [
{
"id": "04e5fd3a-c916-45aa-923c-2fa02e9eddac",
"name": "string",
"customer": "string",
"users": [
"string"
],
"userCount": "integer",
"properties": {
"nameEditable": "boolean",
"usersEditable": "boolean",
"rolesEditable": "boolean"
},
"description": "string",
"roles": [
"RoleDTO Object"
]
}
],
"roles": [
{
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": "integer",
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": "integer",
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": "boolean",
"usersRemovable": "boolean",
"usersAddable": "boolean",
"permsEditable": "boolean",
"deletable": "boolean"
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string"
}
],
"active": "boolean",
"description": "string",
"identifier": "string",
"groups": [
"string"
],
"lastUsed": "integer"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"hidden": "boolean",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"markedNewEpochMillis": "integer",
"creatorId": "string",
"updaterId": "string",
"sourceName": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"name": "string",
"id": "string",
"active": "boolean",
"description": "string",
"expression": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"samplingPercent": "integer",
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"items": [
{
"users": [
"string"
],
"userCount": "integer",
"properties": {
"nameEditable": "boolean",
"usersEditable": "boolean",
"rolesEditable": "boolean"
},
"roles": [
{
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": "integer",
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": "integer",
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": "boolean",
"usersRemovable": "boolean",
"usersAddable": "boolean",
"permsEditable": "boolean",
"deletable": "boolean"
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string"
}
],
"roleCount": "integer",
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"customer": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
{
"value": "number",
"timestamp": "integer"
}
value
The timestamp of the point in milliseconds
Policy rule entity for read requests.
{
"accounts": [
{
"name": "string",
"id": "string",
"description": "string"
}
],
"userGroups": [
{
"name": "string",
"id": "string",
"description": "string"
}
],
"roles": [
{
"name": "string",
"id": "string",
"description": "string"
}
],
"name": "string",
"id": "string",
"description": "string",
"tagsAnded": "boolean",
"tags": [
{
"key": "string",
"value": "string"
}
],
"prefixes": [
"string"
],
"accessType": "string"
}
The name of the policy rule
id
The description of the policy rule
Whether tags should be AND-ed or OR-ed.If true, a metric must contain all tags in order for the policy rule to apply. If false, the tags are OR-ed, and a metric must contain one of the tags. Default: false
The prefixes of the policy rule
The access type of the policy rule
Policy rule entity for write requests.
{
"accounts": [
"string"
],
"roles": [
"string"
],
"userGroups": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"tagsAnded": "boolean",
"tags": [
{
"key": "string",
"value": "string"
}
],
"prefixes": [
"string"
],
"accessType": "string"
}
The list of account identifiers of the policy rule
The list of role identifiers of the policy rule
The list of user group identifiers of the policy rule
The name of the policy rule
id
The description of the policy rule
Whether tags should be AND-ed or OR-ed.If true, a metric must contain all tags in order for the policy rule to apply. If false, the tags are OR-ed, and a metric must contain one of the tags. Default: false
The prefixes of the policy rule
The access type of the policy rule
Wavefront forwarding proxy
{
"version": "string",
"name": "string",
"id": "string",
"status": "string",
"customerId": "string",
"deleted": "boolean",
"lastCheckInTime": "integer",
"inTrash": "boolean",
"hostname": "string",
"proxyname": "string",
"lastKnownError": "string",
"lastErrorTime": "integer",
"lastErrorEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"timeDrift": "integer",
"bytesLeftForBuffer": "integer",
"bytesPerMinuteForBuffer": "integer",
"localQueueSize": "integer",
"sshAgent": "boolean",
"ephemeral": "boolean",
"shutdown": "boolean",
"truncate": "boolean",
"collectorSetsRateLimit": "boolean",
"collectorRateLimit": "integer",
"histogramRateLimit": "integer",
"sourceTagsRateLimit": "number",
"eventsRateLimit": "number",
"spanRateLimit": "integer",
"spanLogsRateLimit": "integer",
"preprocessorRules": "string",
"userId": "string",
"histoDisabled": "boolean",
"traceDisabled": "boolean",
"spanLogsDisabled": "boolean",
"logsDisabled": "boolean",
"statusCause": "string"
}
version
Proxy name (modifiable)
id
the proxy's status
customerId
deleted
Last time when this proxy checked in (in milliseconds since the unix epoch)
inTrash
Host name of the machine running the proxy
Proxy name set by customer
deprecated
deprecated
Time drift of the proxy's clock compared to Wavefront servers
Number of bytes of space remaining in the persistent disk queue of this proxy
Bytes used per minute by the persistent disk queue of this proxy
Number of items in the persistent disk queue of this proxy
deprecated
When true, this proxy is expected to be ephemeral (possibly hosted on a short-lived container) and will be deleted after a period of inactivity (not checking in)
When true, attempt to shut down this proxy remotely
When true, attempt to truncate down this proxy backlog remotely
When true, this proxy's rate limit is controlled remotely
Proxy's rate limit
Proxy's rate limit for histograms
Proxy's rate limit for source tag operations
Proxy's rate limit for events
Proxy's rate limit for spans
Proxy's rate limit for span logs
Proxy's preprocessor rules
The user associated with this proxy
Proxy's histogram feature disabled
Proxy's spans feature disabled
Proxy's span logs feature disabled
Proxy's logs feature disabled for customer
The reason why the proxy is in current status
A representation of events as returned by the querying api, rather than the event api
{
"name": "string",
"start": "integer",
"end": "integer",
"hosts": [
"string"
],
"summarized": "integer",
"isEphemeral": "boolean"
}
Event name
Start time of event, in epoch millis
End time of event, in epoch millis
Tags (annotations) on the event
Sources (hosts) to which the event pertains
In some event queries, multiple events that occur nearly simultaneously are summarized under a single event. This value specifies the number of events summarized under this one
Whether the event is an artificial event generated by a literal expression or alert backtesting, i.e. not stored in the Wavefront backend
{
"errorMessage": "string",
"name": "string",
"query": "string",
"stats": {
"keys": "integer",
"points": "integer",
"metrics": "integer",
"edges": "integer",
"spans": "integer",
"distributions": "integer",
"summaries": "integer",
"queries": "integer",
"buffer_keys": "integer",
"compacted_keys": "integer",
"skipped_compacted_keys": "integer",
"compacted_points": "integer",
"cached_compacted_keys": "integer",
"latency": "integer",
"s3_keys": "integer",
"cpu_ns": "integer",
"metrics_used": "integer",
"hosts_used": "integer",
"query_tasks": "integer"
},
"warnings": "string",
"events": [
{
"name": "string",
"start": "integer",
"end": "integer",
"hosts": [
"string"
],
"summarized": "integer",
"isEphemeral": "boolean"
}
],
"spans": [
{
"name": "string",
"annotations": [
{}
],
"host": "string",
"startMs": "integer",
"spanId": "string",
"traceId": "string",
"durationMs": "integer"
}
],
"timeseries": [
{
"label": "string",
"host": "string",
"data": [
[
{}
]
]
}
],
"granularity": "integer",
"errorType": "string",
"traces": [
{
"end_ms": "integer",
"spans": [
{
"name": "string",
"annotations": [
{}
],
"host": "string",
"startMs": "integer",
"spanId": "string",
"traceId": "string",
"durationMs": "integer"
}
],
"start_ms": "integer",
"traceId": "string",
"total_duration_ms": "integer"
}
],
"dimensions": [
{
"key": [
"string"
],
"valueList": [
{
"count": "integer",
"value": [
"string"
]
}
]
}
],
"traceDimensions": [
{
"key": [
"string"
],
"valueList": [
{
"count": "integer",
"value": [
"string"
]
}
]
}
]
}
Error message, if query execution did not finish successfully
The name of this query
The query used to obtain this result
The warnings incurred by this query
The granularity of the returned results, in seconds
Error type, if query execution did not finish successfully
{
"inputQuery": "string",
"translatedInput": "string",
"queryType": "string"
}
inputQuery
translatedInput
queryType
Recent search queries for Application Status
{
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"creatorId": "string",
"updaterId": "string"
}
id
createdEpochMillis
updatedEpochMillis
creatorId
updaterId
Recent search queries for Traces
{
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"creatorId": "string",
"updaterId": "string"
}
id
createdEpochMillis
updatedEpochMillis
creatorId
updaterId
Wrapper around a Wavefront Event describing how this anomaly is related to another event
{
"relatedData": {
"relatedId": "string",
"summary": "string",
"alertDescription": "string",
"anomalyChartLink": "string",
"commonSources": [
"string"
],
"commonMetrics": [
"string"
],
"commonDimensions": [
"string"
],
"enhancedScore": "number"
},
"id": "string",
"model": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"row": "integer",
"dashboardId": "string",
"endMs": "integer",
"queryHash": "string",
"imageLink": "string",
"chartHash": "string",
"paramHash": "string",
"startMs": "integer",
"section": "integer",
"col": "integer",
"chartLink": "string",
"originalStripes": [
{
"model": "string",
"endMs": "integer",
"imageLink": "string",
"startMs": "integer"
}
],
"updatedMs": "integer",
"deleted": "boolean",
"customer": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"creatorId": "string",
"updaterId": "string"
}
unique id that defines this anomaly
model for this anomaly
createdEpochMillis
updatedEpochMillis
row number for this anomaly
dashboard id for this anomaly
endMs for this anomaly
query hash for this anomaly
image link for this anomaly
chart hash(as unique identifier) for this anomaly
param hash for this anomaly
startMs for this anomaly
section number for this anomaly
column number for this anomaly
chart link for this anomaly
map of query params belongs to this anomaly
updateMs for this anomaly
deleted
id of the customer to which this anomaly belongs
list of metrics used of this anomaly
list of hosts affected of this anomaly
creatorId
updaterId
Data object capturing how this event is related to another, requested event.
{
"relatedId": "string",
"summary": "string",
"alertDescription": "string",
"anomalyChartLink": "string",
"commonSources": [
"string"
],
"commonMetrics": [
"string"
],
"commonDimensions": [
"string"
],
"enhancedScore": "number"
}
ID of the event to which this event is related
Text summary of why the two events are related
If this event is generated by an alert, the description of that alert.
Chart Link of the anomaly to which this event is related
Set of common sources between the 2 events or anomalies
Set of common metrics/labels between the 2 events or anomalies
Set of common dimensions between the 2 events, presented in key=value format
Enhanced score to sort related events and anomalies
Wrapper around a Wavefront Event describing how this event is related to another event
{
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"relatedData": {
"relatedId": "string",
"summary": "string",
"alertDescription": "string",
"anomalyChartLink": "string",
"commonSources": [
"string"
],
"commonMetrics": [
"string"
],
"commonDimensions": [
"string"
],
"enhancedScore": "number"
},
"similarityScore": "number",
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
}
similarity score
The customer to which the event belongs
A string->
map of additional dimension info on the event
The name of the event. If 'annotations.prettyName' is present, 'name' will be equivalent to that value
A string->string map of additional annotations on the event
id
Start time of the event, in epoch millis. If the JSON value is missing or set to 0, startTime will be set to the current time
End time of the event, in epoch millis. Set to startTime + 1 for an instantaneous event
createdEpochMillis
updatedEpochMillis
A list of event tags
A list of metrics affected by the event
createdAt
A list of sources/hosts affected by the event
In some event queries, multiple events that occur nearly simultaneously are summarized under a single event. This value specifies the number of events summarized under this one
The list of tags on the alert which created this event.
Whether this event was created by a user, versus the system. Default: system
Whether the event is an artificial event generated by a literal expression or alert backtesting, i.e. not stored in the Wavefront backend
creatorId
updaterId
updatedAt
runningState
canDelete
canClose
creatorType
Refinement of time range over which to search over a firing event with no default value. Operates on the start time of the event.
{
"earliestStartTimeEpochMillis": "integer",
"latestStartTimeEpochMillis": "integer"
}
Start of search time window, in milliseconds since the Unix Epoch. Events whose start time occurs after this value will be returned. If no value is supplied, will return null
End of the search time window, in milliseconds since the Unix Epoch. Events whose start time occurs before this value will be returned. If no value is supplied, will return null
{
"relatedEventDTO": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"relatedData": {
"relatedId": "string",
"summary": "string",
"alertDescription": "string",
"anomalyChartLink": "string",
"commonSources": [
"string"
],
"commonMetrics": [
"string"
],
"commonDimensions": [
"string"
],
"enhancedScore": "number"
},
"similarityScore": "number",
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"relatedAnomalyDTO": {
"relatedData": {
"relatedId": "string",
"summary": "string",
"alertDescription": "string",
"anomalyChartLink": "string",
"commonSources": [
"string"
],
"commonMetrics": [
"string"
],
"commonDimensions": [
"string"
],
"enhancedScore": "number"
},
"id": "string",
"model": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"row": "integer",
"dashboardId": "string",
"endMs": "integer",
"queryHash": "string",
"imageLink": "string",
"chartHash": "string",
"paramHash": "string",
"startMs": "integer",
"section": "integer",
"col": "integer",
"chartLink": "string",
"originalStripes": [
{
"model": "string",
"endMs": "integer",
"imageLink": "string",
"startMs": "integer"
}
],
"updatedMs": "integer",
"deleted": "boolean",
"customer": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"creatorId": "string",
"updaterId": "string"
},
"similarityScore": "number"
}
similarityScore
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
}
}
response
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"lastUpdatedMs": "integer",
"policyRules": [
{
"name": "string",
"description": "string",
"subnet": "string",
"action": "string"
}
],
"customer": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": "string"
}
response
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"unitedRoles": [
"string"
],
"unitedPermissions": [
"string"
],
"identifier": "string",
"groups": [
"string"
],
"roles": [
"string"
],
"userGroups": [
"string"
]
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": "boolean",
"lastEventTime": "integer",
"hidden": "boolean",
"severity": "string",
"minutes": "integer",
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": "integer",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": "boolean",
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": "boolean",
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": "boolean",
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": "boolean",
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": "integer",
"snoozed": "integer",
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"querySyntaxError": "boolean",
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"notificants": [
"string"
],
"lastNotificationMillis": "integer",
"notificationResendFrequencyMinutes": "integer",
"alertsLastDay": "integer",
"alertsLastWeek": "integer",
"alertsLastMonth": "integer",
"numPointsInFailureFrame": "integer",
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"systemAlertVersion": "integer",
"alertType": "string",
"evaluateRealtimeData": "boolean",
"secureMetricDetails": "boolean",
"enablePDIncidentBySeries": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": "integer",
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": "integer",
"alertChartDescription": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"accountType": "string",
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"dateGenerated": "integer",
"customer": "string",
"lastUsed": "integer",
"account": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"forceSave": "boolean",
"reuseExternalIdCredential": "string",
"name": "string",
"id": "string",
"service": "string",
"lastReceivedDataPointMs": "integer",
"lastMetricCount": "integer",
"cloudWatch": {
"namespaces": [
"string"
],
"metricFilterRegex": "^aws.(billing|instance|sqs|sns|reservedInstance|ebs|route53.health|ec2.status|elb).*$",
"baseCredentials": {
"roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
"externalId": "string"
},
"instanceSelectionTagsExpr": "string",
"volumeSelectionTagsExpr": "string",
"pointTagFilterRegex": "(region|name)",
"s3BucketNameFilterRegex": "^(test|demo).*$",
"threadDistributionInMins": "integer"
},
"cloudTrail": {
"region": "string",
"prefix": "string",
"bucketName": "string",
"baseCredentials": {
"roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
"externalId": "string"
},
"filterRule": "string"
},
"ec2": {
"metricFilterRegex": "^aws.(sqs|ebs).*$",
"baseCredentials": {
"roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
"externalId": "string"
},
"hostNameTags": [
"string"
],
"instanceSelectionTagsExpr": "string",
"volumeSelectionTagsExpr": "string",
"pointTagFilterRegex": "(region|name)"
},
"gcp": {
"metricFilterRegex": "^gcp.(compute|container|pubsub).*$",
"projectId": "string",
"gcpJsonKey": "string",
"disableHistogramToMetricConversion": "boolean",
"disableDeltaCounts": "boolean",
"categoriesToFetch": [
"string"
],
"customMetricPrefix": [
"string"
]
},
"gcpBilling": {
"projectId": "string",
"gcpJsonKey": "string",
"gcpApiKey": "string"
},
"newRelic": {
"apiKey": "string",
"appFilterRegex": "^hostingservice-(prod|dev)*$",
"hostFilterRegex": "host[1-9].xyz.com",
"newRelicMetricFilters": [
{
"appName": "string",
"metricFilterRegex": "string"
}
]
},
"appDynamics": {
"userName": "user1@account1",
"controllerName": "string",
"encryptedPassword": "string",
"enableRollup": "boolean",
"enableErrorMetrics": "boolean",
"enableBusinessTrxMetrics": "boolean",
"enableBackendMetrics": "boolean",
"enableOverallPerfMetrics": "boolean",
"enableIndividualNodeMetrics": "boolean",
"enableAppInfraMetrics": "boolean",
"enableServiceEndpointMetrics": "boolean",
"appFilterRegex": [
"string"
]
},
"dynatrace": {
"metricFilterRegex": "^dynatrace.(builtin|dsfm).*$",
"environmentID": "example",
"dynatraceAPIToken": "string"
},
"azure": {
"metricFilterRegex": "^azure.(compute|network|dbforpostgresql).*$",
"baseCredentials": {
"clientId": "string",
"clientSecret": "string",
"tenant": "string"
},
"categoryFilter": [
"string"
],
"resourceGroupFilter": [
"string"
]
},
"azureActivityLog": {
"baseCredentials": {
"clientId": "string",
"clientSecret": "string",
"tenant": "string"
},
"categoryFilter": [
"string"
]
},
"lastErrorMs": "integer",
"lastProcessorId": "string",
"lastProcessingTimestamp": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"serviceRefreshRateInMins": "integer",
"vrops": {
"baseURL": "https://www.mgmt.cloud.vmware.com/vrops-cloud",
"metricFilterRegex": "^vrops.(vmware|cloudhealthadapter).(clustercomputeresource|datastore).*$",
"categoriesToFetch": [
"string"
],
"vropsAPIToken": "string",
"organizationID": "string"
},
"disabled": "boolean",
"lastError": "string",
"deleted": "boolean",
"inTrash": "boolean",
"lastErrorEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"creatorId": "string",
"updaterId": "string",
"snowflake": {
"userName": "string",
"password": "string",
"metricFilterRegex": "string",
"privateKey": "string",
"role": "string",
"accountID": "string",
"warehouse": "string"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"clusterAlias": "string",
"statusPageLink": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"modifyAclAccess": "boolean",
"hidden": "boolean",
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"customer": "string",
"url": "string",
"eventFilterType": "string",
"forceV2UI": "boolean",
"sections": [
{
"name": "string",
"id": "string",
"rows": [
{
"heightFactor": "integer",
"charts": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
]
}
]
}
],
"disableRefreshInLiveMode": "boolean",
"hideChartWarning": "boolean",
"displayDescription": "boolean",
"displaySectionTableOfContents": "boolean",
"displayQueryParameters": "boolean",
"chartTitleScalar": "integer",
"eventQuery": "string",
"defaultTimeWindow": "string",
"defaultStartTime": "integer",
"defaultEndTime": "integer",
"chartTitleColor": "string",
"chartTitleBgColor": "string",
"viewsLastDay": "integer",
"viewsLastWeek": "integer",
"viewsLastMonth": "integer",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"includeObsoleteMetrics": "boolean",
"creatorId": "string",
"updaterId": "string",
"numCharts": "integer",
"numFavorites": "integer",
"favorite": "boolean"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"defaultUserSearch": {
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string"
},
"defaultCustomerSearch": {
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"defaultUserSearch": {
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string"
},
"defaultCustomerSearch": {
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"tagpaths": [
"string"
],
"minutes": "integer",
"name": "string",
"id": "string",
"query": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"deleted": "boolean",
"created": "integer",
"queryQBEnabled": "boolean",
"queryQBSerialization": "string",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"creatorId": "string",
"updaterId": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"template": "string",
"metricFilterRegex": "string",
"sourceFilterRegex": "string",
"isLogIntegration": "boolean",
"creatorId": "string",
"updaterId": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
"string"
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"limit": "integer"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"failed": "integer",
"success": "integer"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"id": "string",
"inTrash": "boolean",
"version": "integer",
"updateUser": "string",
"updateTime": "integer",
"changeDescription": [
"string"
]
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"accounts": [
{
"name": "string",
"id": "string",
"description": "string"
}
],
"groups": [
{
"name": "string",
"id": "string",
"description": "string"
}
],
"metadata": {
"usageInBillingPeriod": "integer",
"customer": "string",
"ingestionPolicyId": "string"
},
"name": "string",
"id": "string",
"description": "string",
"scope": "string",
"alert": {
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": "boolean",
"lastEventTime": "integer",
"hidden": "boolean",
"severity": "string",
"minutes": "integer",
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": "integer",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": "boolean",
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": "boolean",
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": "boolean",
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": "boolean",
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": "integer",
"snoozed": "integer",
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"querySyntaxError": "boolean",
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"notificants": [
"string"
],
"lastNotificationMillis": "integer",
"notificationResendFrequencyMinutes": "integer",
"alertsLastDay": "integer",
"alertsLastWeek": "integer",
"alertsLastMonth": "integer",
"numPointsInFailureFrame": "integer",
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"systemAlertVersion": "integer",
"alertType": "string",
"evaluateRealtimeData": "boolean",
"secureMetricDetails": "boolean",
"enablePDIncidentBySeries": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": "integer",
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": "integer",
"alertChartDescription": "string"
},
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string",
"sources": [
"string"
],
"alertId": "string",
"isLimited": "boolean",
"limitPPS": "integer",
"namespaces": [
"string"
],
"pointTags": [
{
"key": "string",
"value": "string"
}
],
"tagsAnded": "boolean"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"version": "string",
"hidden": "boolean",
"name": "string",
"id": "string",
"description": "string",
"icon": "string",
"metrics": {
"chartObjs": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
],
"display": [
"string"
],
"required": [
"string"
],
"charts": [
"string"
],
"prefixes": [
"string"
],
"ppsDimensions": [
"string"
]
},
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"aliasOf": "string",
"aliasIntegrations": [
{
"name": "string",
"id": "string",
"description": "string",
"icon": "string",
"baseUrl": "string"
}
],
"dashboards": [
{
"name": "string",
"description": "string",
"dashboardObj": {
"modifyAclAccess": "boolean",
"hidden": "boolean",
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"customer": "string",
"url": "string",
"eventFilterType": "string",
"forceV2UI": "boolean",
"sections": [
{
"name": "string",
"id": "string",
"rows": [
{
"heightFactor": "integer",
"charts": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
]
}
]
}
],
"disableRefreshInLiveMode": "boolean",
"hideChartWarning": "boolean",
"displayDescription": "boolean",
"displaySectionTableOfContents": "boolean",
"displayQueryParameters": "boolean",
"chartTitleScalar": "integer",
"eventQuery": "string",
"defaultTimeWindow": "string",
"defaultStartTime": "integer",
"defaultEndTime": "integer",
"chartTitleColor": "string",
"chartTitleBgColor": "string",
"viewsLastDay": "integer",
"viewsLastWeek": "integer",
"viewsLastMonth": "integer",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"includeObsoleteMetrics": "boolean",
"creatorId": "string",
"updaterId": "string",
"numCharts": "integer",
"numFavorites": "integer",
"favorite": "boolean"
},
"url": "string",
"dashboardMinObj": {
"name": "string",
"id": "string",
"description": "string"
}
}
],
"status": {
"contentStatus": "string",
"installStatus": "string"
},
"baseUrl": "string",
"alerts": [
{
"name": "string",
"description": "string",
"alertObj": {
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": "boolean",
"lastEventTime": "integer",
"hidden": "boolean",
"severity": "string",
"minutes": "integer",
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": "integer",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": "boolean",
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": "boolean",
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": "boolean",
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": "boolean",
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": "integer",
"snoozed": "integer",
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"querySyntaxError": "boolean",
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"notificants": [
"string"
],
"lastNotificationMillis": "integer",
"notificationResendFrequencyMinutes": "integer",
"alertsLastDay": "integer",
"alertsLastWeek": "integer",
"alertsLastMonth": "integer",
"numPointsInFailureFrame": "integer",
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"systemAlertVersion": "integer",
"alertType": "string",
"evaluateRealtimeData": "boolean",
"secureMetricDetails": "boolean",
"enablePDIncidentBySeries": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": "integer",
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": "integer",
"alertChartDescription": "string"
},
"url": "string",
"alertMinObj": {
"name": "string",
"id": "string"
}
}
],
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string",
"overview": "string",
"setup": "string",
"metricsDocs": "string",
"haveMetricDropdown": "boolean",
"setups": [
{
"type": "string",
"description": "string",
"title": "string",
"filePath": "string"
}
]
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"contentStatus": "string",
"installStatus": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": [
{
"entityId": "string",
"viewAcl": [
{
"name": "string",
"id": "string",
"description": "string"
}
],
"modifyAcl": [
{
"name": "string",
"id": "string",
"description": "string"
}
]
}
]
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": [
{
"accountType": "string",
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"dateGenerated": "integer",
"customer": "string",
"lastUsed": "integer",
"account": "string"
}
]
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": [
{
"version": "string",
"hidden": "boolean",
"name": "string",
"id": "string",
"description": "string",
"icon": "string",
"metrics": {
"chartObjs": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
],
"display": [
"string"
],
"required": [
"string"
],
"charts": [
"string"
],
"prefixes": [
"string"
],
"ppsDimensions": [
"string"
]
},
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"aliasOf": "string",
"aliasIntegrations": [
{
"name": "string",
"id": "string",
"description": "string",
"icon": "string",
"baseUrl": "string"
}
],
"dashboards": [
{
"name": "string",
"description": "string",
"dashboardObj": {
"modifyAclAccess": "boolean",
"hidden": "boolean",
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"customer": "string",
"url": "string",
"eventFilterType": "string",
"forceV2UI": "boolean",
"sections": [
{
"name": "string",
"id": "string",
"rows": [
{
"heightFactor": "integer",
"charts": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
]
}
]
}
],
"disableRefreshInLiveMode": "boolean",
"hideChartWarning": "boolean",
"displayDescription": "boolean",
"displaySectionTableOfContents": "boolean",
"displayQueryParameters": "boolean",
"chartTitleScalar": "integer",
"eventQuery": "string",
"defaultTimeWindow": "string",
"defaultStartTime": "integer",
"defaultEndTime": "integer",
"chartTitleColor": "string",
"chartTitleBgColor": "string",
"viewsLastDay": "integer",
"viewsLastWeek": "integer",
"viewsLastMonth": "integer",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"includeObsoleteMetrics": "boolean",
"creatorId": "string",
"updaterId": "string",
"numCharts": "integer",
"numFavorites": "integer",
"favorite": "boolean"
},
"url": "string",
"dashboardMinObj": {
"name": "string",
"id": "string",
"description": "string"
}
}
],
"status": {
"contentStatus": "string",
"installStatus": "string"
},
"baseUrl": "string",
"alerts": [
{
"name": "string",
"description": "string",
"alertObj": {
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": "boolean",
"lastEventTime": "integer",
"hidden": "boolean",
"severity": "string",
"minutes": "integer",
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": "integer",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": "boolean",
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": "boolean",
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": "boolean",
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": "boolean",
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": "integer",
"snoozed": "integer",
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"querySyntaxError": "boolean",
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"notificants": [
"string"
],
"lastNotificationMillis": "integer",
"notificationResendFrequencyMinutes": "integer",
"alertsLastDay": "integer",
"alertsLastWeek": "integer",
"alertsLastMonth": "integer",
"numPointsInFailureFrame": "integer",
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"systemAlertVersion": "integer",
"alertType": "string",
"evaluateRealtimeData": "boolean",
"secureMetricDetails": "boolean",
"enablePDIncidentBySeries": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": "integer",
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": "integer",
"alertChartDescription": "string"
},
"url": "string",
"alertMinObj": {
"name": "string",
"id": "string"
}
}
],
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string",
"overview": "string",
"setup": "string",
"metricsDocs": "string",
"haveMetricDropdown": "boolean",
"setups": [
{
"type": "string",
"description": "string",
"title": "string",
"filePath": "string"
}
]
}
]
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": [
{
"integrations": [
"string"
],
"integrationObjs": [
{
"version": "string",
"hidden": "boolean",
"name": "string",
"id": "string",
"description": "string",
"icon": "string",
"metrics": {
"chartObjs": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
],
"display": [
"string"
],
"required": [
"string"
],
"charts": [
"string"
],
"prefixes": [
"string"
],
"ppsDimensions": [
"string"
]
},
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"aliasOf": "string",
"aliasIntegrations": [
{
"name": "string",
"id": "string",
"description": "string",
"icon": "string",
"baseUrl": "string"
}
],
"dashboards": [
{
"name": "string",
"description": "string",
"dashboardObj": {
"modifyAclAccess": "boolean",
"hidden": "boolean",
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"customer": "string",
"url": "string",
"eventFilterType": "string",
"forceV2UI": "boolean",
"sections": [
{
"name": "string",
"id": "string",
"rows": [
{
"heightFactor": "integer",
"charts": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
]
}
]
}
],
"disableRefreshInLiveMode": "boolean",
"hideChartWarning": "boolean",
"displayDescription": "boolean",
"displaySectionTableOfContents": "boolean",
"displayQueryParameters": "boolean",
"chartTitleScalar": "integer",
"eventQuery": "string",
"defaultTimeWindow": "string",
"defaultStartTime": "integer",
"defaultEndTime": "integer",
"chartTitleColor": "string",
"chartTitleBgColor": "string",
"viewsLastDay": "integer",
"viewsLastWeek": "integer",
"viewsLastMonth": "integer",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"includeObsoleteMetrics": "boolean",
"creatorId": "string",
"updaterId": "string",
"numCharts": "integer",
"numFavorites": "integer",
"favorite": "boolean"
},
"url": "string",
"dashboardMinObj": {
"name": "string",
"id": "string",
"description": "string"
}
}
],
"status": {
"contentStatus": "string",
"installStatus": "string"
},
"baseUrl": "string",
"alerts": [
{
"name": "string",
"description": "string",
"alertObj": {
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": "boolean",
"lastEventTime": "integer",
"hidden": "boolean",
"severity": "string",
"minutes": "integer",
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": "integer",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": "boolean",
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": "boolean",
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": "boolean",
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": "boolean",
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": "integer",
"snoozed": "integer",
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"querySyntaxError": "boolean",
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"notificants": [
"string"
],
"lastNotificationMillis": "integer",
"notificationResendFrequencyMinutes": "integer",
"alertsLastDay": "integer",
"alertsLastWeek": "integer",
"alertsLastMonth": "integer",
"numPointsInFailureFrame": "integer",
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"systemAlertVersion": "integer",
"alertType": "string",
"evaluateRealtimeData": "boolean",
"secureMetricDetails": "boolean",
"enablePDIncidentBySeries": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": "integer",
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": "integer",
"alertChartDescription": "string"
},
"url": "string",
"alertMinObj": {
"name": "string",
"id": "string"
}
}
],
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string",
"overview": "string",
"setup": "string",
"metricsDocs": "string",
"haveMetricDropdown": "boolean",
"setups": [
{
"type": "string",
"description": "string",
"title": "string",
"filePath": "string"
}
]
}
],
"title": "string",
"subtitle": "string"
}
]
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": [
{
"name": "string",
"method": "string",
"id": "string",
"content": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string",
"subject": "string"
}
]
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": [
{
"unitedRoles": [
"string"
],
"unitedPermissions": [
"string"
],
"tokens": [
{
"tokenID": "string",
"tokenName": "string",
"account": "string",
"accountType": "string",
"lastUsed": "integer",
"dateGenerated": "integer"
}
],
"userGroups": [
{
"id": "04e5fd3a-c916-45aa-923c-2fa02e9eddac",
"name": "string",
"customer": "string",
"users": [
"string"
],
"userCount": "integer",
"properties": {
"nameEditable": "boolean",
"usersEditable": "boolean",
"rolesEditable": "boolean"
},
"description": "string",
"roles": [
"RoleDTO Object"
]
}
],
"roles": [
{
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": "integer",
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": "integer",
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": "boolean",
"usersRemovable": "boolean",
"usersAddable": "boolean",
"permsEditable": "boolean",
"deletable": "boolean"
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string"
}
],
"active": "boolean",
"description": "string",
"identifier": "string",
"groups": [
"string"
],
"lastUsed": "integer"
}
]
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": [
"string"
]
}
response
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": [
{
"tokenID": "string",
"tokenName": "string",
"account": "string",
"accountType": "string",
"lastUsed": "integer",
"dateGenerated": "integer"
}
]
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": [
{
"identifier": "string",
"customer": "string",
"ssoId": "string",
"lastSuccessfulLogin": "integer",
"groups": [
"string"
],
"userGroups": [
{
"id": "04e5fd3a-c916-45aa-923c-2fa02e9eddac",
"name": "string",
"customer": "string",
"users": [
"string"
],
"userCount": "integer",
"properties": {
"nameEditable": "boolean",
"usersEditable": "boolean",
"rolesEditable": "boolean"
},
"description": "string",
"roles": [
"RoleDTO Object"
]
}
],
"roles": [
{
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": "integer",
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": "integer",
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": "boolean",
"usersRemovable": "boolean",
"usersAddable": "boolean",
"permsEditable": "boolean",
"deletable": "boolean"
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string"
}
]
}
]
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"id": "string",
"reason": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"title": "string",
"customerId": "string",
"creatorId": "string",
"updaterId": "string",
"startTimeInSeconds": "integer",
"endTimeInSeconds": "integer",
"relevantCustomerTags": [
"string"
],
"relevantHostNames": [
"string"
],
"relevantHostTags": [
"string"
],
"relevantCustomerTagsAnded": "boolean",
"relevantHostTagsAnded": "boolean",
"hostTagGroupHostNamesGroupAnded": "boolean",
"pointTagFilter": "string",
"pointTagFilterAnded": "boolean",
"eventName": "string",
"targets": [
"string"
],
"sortAttr": "integer",
"runningState": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
}
}
response
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
}
}
response
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
}
}
response
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"source": "string",
"severity": "string",
"id": "string",
"target": "string",
"content": "string",
"scope": "string",
"startEpochMillis": "integer",
"endEpochMillis": "integer",
"display": "string",
"title": "string",
"read": "boolean"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"policyRules": [
{
"accounts": [
{
"name": "string",
"id": "string",
"description": "string"
}
],
"userGroups": [
{
"name": "string",
"id": "string",
"description": "string"
}
],
"roles": [
{
"name": "string",
"id": "string",
"description": "string"
}
],
"name": "string",
"id": "string",
"description": "string",
"tagsAnded": "boolean",
"tags": [
{
"key": "string",
"value": "string"
}
],
"prefixes": [
"string"
],
"accessType": "string"
}
],
"updatedEpochMillis": "integer",
"customer": "string",
"updaterId": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"serviceCount": "integer",
"hidden": "boolean",
"application": "string",
"status": "string",
"lastReported": "integer",
"satisfiedLatencyMillis": "integer",
"created": "integer",
"updateUserId": "string",
"lastUpdated": "integer"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"serviceInstanceCount": "integer",
"hidden": "boolean",
"source": "string",
"component": "string",
"application": "string",
"service": "string",
"customDashboardLink": "string",
"status": "string",
"lastReported": "integer",
"satisfiedLatencyMillis": "integer",
"created": "integer",
"updateUserId": "string",
"lastUpdated": "integer"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"method": "string",
"id": "string",
"contentType": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"title": "string",
"customerId": "string",
"triggers": [
"string"
],
"template": "string",
"recipient": "string",
"emailSubject": "string",
"isHtmlContent": "boolean",
"routes": [
{
"method": "string",
"target": "string",
"filter": "string"
}
],
"creatorId": "string",
"updaterId": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"unitedRoles": [
"string"
],
"unitedPermissions": [
"string"
],
"identifier": "string",
"groups": [
"string"
],
"roles": [
"string"
],
"userGroups": [
"string"
]
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": "boolean",
"lastEventTime": "integer",
"hidden": "boolean",
"severity": "string",
"minutes": "integer",
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": "integer",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": "boolean",
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": "boolean",
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": "boolean",
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": "boolean",
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": "integer",
"snoozed": "integer",
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"querySyntaxError": "boolean",
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"notificants": [
"string"
],
"lastNotificationMillis": "integer",
"notificationResendFrequencyMinutes": "integer",
"alertsLastDay": "integer",
"alertsLastWeek": "integer",
"alertsLastMonth": "integer",
"numPointsInFailureFrame": "integer",
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"systemAlertVersion": "integer",
"alertType": "string",
"evaluateRealtimeData": "boolean",
"secureMetricDetails": "boolean",
"enablePDIncidentBySeries": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": "integer",
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": "integer",
"alertChartDescription": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": "boolean",
"lastEventTime": "integer",
"hidden": "boolean",
"severity": "string",
"minutes": "integer",
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": "integer",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": "boolean",
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": "boolean",
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": "boolean",
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": "boolean",
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": "integer",
"snoozed": "integer",
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"querySyntaxError": "boolean",
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"notificants": [
"string"
],
"lastNotificationMillis": "integer",
"notificationResendFrequencyMinutes": "integer",
"alertsLastDay": "integer",
"alertsLastWeek": "integer",
"alertsLastMonth": "integer",
"numPointsInFailureFrame": "integer",
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"systemAlertVersion": "integer",
"alertType": "string",
"evaluateRealtimeData": "boolean",
"secureMetricDetails": "boolean",
"enablePDIncidentBySeries": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": "integer",
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": "integer",
"alertChartDescription": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"accountType": "string",
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"dateGenerated": "integer",
"customer": "string",
"lastUsed": "integer",
"account": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"forceSave": "boolean",
"reuseExternalIdCredential": "string",
"name": "string",
"id": "string",
"service": "string",
"lastReceivedDataPointMs": "integer",
"lastMetricCount": "integer",
"cloudWatch": {
"namespaces": [
"string"
],
"metricFilterRegex": "^aws.(billing|instance|sqs|sns|reservedInstance|ebs|route53.health|ec2.status|elb).*$",
"baseCredentials": {
"roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
"externalId": "string"
},
"instanceSelectionTagsExpr": "string",
"volumeSelectionTagsExpr": "string",
"pointTagFilterRegex": "(region|name)",
"s3BucketNameFilterRegex": "^(test|demo).*$",
"threadDistributionInMins": "integer"
},
"cloudTrail": {
"region": "string",
"prefix": "string",
"bucketName": "string",
"baseCredentials": {
"roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
"externalId": "string"
},
"filterRule": "string"
},
"ec2": {
"metricFilterRegex": "^aws.(sqs|ebs).*$",
"baseCredentials": {
"roleArn": "arn:aws:iam::<accountid>:role/<rolename>",
"externalId": "string"
},
"hostNameTags": [
"string"
],
"instanceSelectionTagsExpr": "string",
"volumeSelectionTagsExpr": "string",
"pointTagFilterRegex": "(region|name)"
},
"gcp": {
"metricFilterRegex": "^gcp.(compute|container|pubsub).*$",
"projectId": "string",
"gcpJsonKey": "string",
"disableHistogramToMetricConversion": "boolean",
"disableDeltaCounts": "boolean",
"categoriesToFetch": [
"string"
],
"customMetricPrefix": [
"string"
]
},
"gcpBilling": {
"projectId": "string",
"gcpJsonKey": "string",
"gcpApiKey": "string"
},
"newRelic": {
"apiKey": "string",
"appFilterRegex": "^hostingservice-(prod|dev)*$",
"hostFilterRegex": "host[1-9].xyz.com",
"newRelicMetricFilters": [
{
"appName": "string",
"metricFilterRegex": "string"
}
]
},
"appDynamics": {
"userName": "user1@account1",
"controllerName": "string",
"encryptedPassword": "string",
"enableRollup": "boolean",
"enableErrorMetrics": "boolean",
"enableBusinessTrxMetrics": "boolean",
"enableBackendMetrics": "boolean",
"enableOverallPerfMetrics": "boolean",
"enableIndividualNodeMetrics": "boolean",
"enableAppInfraMetrics": "boolean",
"enableServiceEndpointMetrics": "boolean",
"appFilterRegex": [
"string"
]
},
"dynatrace": {
"metricFilterRegex": "^dynatrace.(builtin|dsfm).*$",
"environmentID": "example",
"dynatraceAPIToken": "string"
},
"azure": {
"metricFilterRegex": "^azure.(compute|network|dbforpostgresql).*$",
"baseCredentials": {
"clientId": "string",
"clientSecret": "string",
"tenant": "string"
},
"categoryFilter": [
"string"
],
"resourceGroupFilter": [
"string"
]
},
"azureActivityLog": {
"baseCredentials": {
"clientId": "string",
"clientSecret": "string",
"tenant": "string"
},
"categoryFilter": [
"string"
]
},
"lastErrorMs": "integer",
"lastProcessorId": "string",
"lastProcessingTimestamp": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"serviceRefreshRateInMins": "integer",
"vrops": {
"baseURL": "https://www.mgmt.cloud.vmware.com/vrops-cloud",
"metricFilterRegex": "^vrops.(vmware|cloudhealthadapter).(clustercomputeresource|datastore).*$",
"categoriesToFetch": [
"string"
],
"vropsAPIToken": "string",
"organizationID": "string"
},
"disabled": "boolean",
"lastError": "string",
"deleted": "boolean",
"inTrash": "boolean",
"lastErrorEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"creatorId": "string",
"updaterId": "string",
"snowflake": {
"userName": "string",
"password": "string",
"metricFilterRegex": "string",
"privateKey": "string",
"role": "string",
"accountID": "string",
"warehouse": "string"
}
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"unitedRoles": [
"string"
],
"unitedPermissions": [
"string"
],
"userGroups": [
"string"
],
"id": "string",
"identifier": "string",
"groups": [
"string"
],
"customer": "string",
"lastSuccessfulLogin": "integer",
"escapedIdentifier": "string",
"gravatarUrl": "string",
"self": "boolean"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"modifyAclAccess": "boolean",
"hidden": "boolean",
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"customer": "string",
"url": "string",
"eventFilterType": "string",
"forceV2UI": "boolean",
"sections": [
{
"name": "string",
"id": "string",
"rows": [
{
"heightFactor": "integer",
"charts": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
]
}
]
}
],
"disableRefreshInLiveMode": "boolean",
"hideChartWarning": "boolean",
"displayDescription": "boolean",
"displaySectionTableOfContents": "boolean",
"displayQueryParameters": "boolean",
"chartTitleScalar": "integer",
"eventQuery": "string",
"defaultTimeWindow": "string",
"defaultStartTime": "integer",
"defaultEndTime": "integer",
"chartTitleColor": "string",
"chartTitleBgColor": "string",
"viewsLastDay": "integer",
"viewsLastWeek": "integer",
"viewsLastMonth": "integer",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"includeObsoleteMetrics": "boolean",
"creatorId": "string",
"updaterId": "string",
"numCharts": "integer",
"numFavorites": "integer",
"favorite": "boolean"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"tagpaths": [
"string"
],
"minutes": "integer",
"name": "string",
"id": "string",
"query": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"deleted": "boolean",
"created": "integer",
"queryQBEnabled": "boolean",
"queryQBSerialization": "string",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"tagpaths": [
"string"
],
"minutes": "integer",
"name": "string",
"id": "string",
"query": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"deleted": "boolean",
"created": "integer",
"queryQBEnabled": "boolean",
"queryQBSerialization": "string",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"template": "string",
"metricFilterRegex": "string",
"sourceFilterRegex": "string",
"isLogIntegration": "boolean",
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"accounts": [
{
"name": "string",
"id": "string",
"description": "string"
}
],
"groups": [
{
"name": "string",
"id": "string",
"description": "string"
}
],
"metadata": {
"usageInBillingPeriod": "integer",
"customer": "string",
"ingestionPolicyId": "string"
},
"name": "string",
"id": "string",
"description": "string",
"scope": "string",
"alert": {
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": "boolean",
"lastEventTime": "integer",
"hidden": "boolean",
"severity": "string",
"minutes": "integer",
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": "integer",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": "boolean",
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": "boolean",
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": "boolean",
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": "boolean",
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": "integer",
"snoozed": "integer",
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"querySyntaxError": "boolean",
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"notificants": [
"string"
],
"lastNotificationMillis": "integer",
"notificationResendFrequencyMinutes": "integer",
"alertsLastDay": "integer",
"alertsLastWeek": "integer",
"alertsLastMonth": "integer",
"numPointsInFailureFrame": "integer",
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"systemAlertVersion": "integer",
"alertType": "string",
"evaluateRealtimeData": "boolean",
"secureMetricDetails": "boolean",
"enablePDIncidentBySeries": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": "integer",
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": "integer",
"alertChartDescription": "string"
},
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string",
"sources": [
"string"
],
"alertId": "string",
"isLimited": "boolean",
"limitPPS": "integer",
"namespaces": [
"string"
],
"pointTags": [
{
"key": "string",
"value": "string"
}
],
"tagsAnded": "boolean"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"version": "string",
"hidden": "boolean",
"name": "string",
"id": "string",
"description": "string",
"icon": "string",
"metrics": {
"chartObjs": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
],
"display": [
"string"
],
"required": [
"string"
],
"charts": [
"string"
],
"prefixes": [
"string"
],
"ppsDimensions": [
"string"
]
},
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"aliasOf": "string",
"aliasIntegrations": [
{
"name": "string",
"id": "string",
"description": "string",
"icon": "string",
"baseUrl": "string"
}
],
"dashboards": [
{
"name": "string",
"description": "string",
"dashboardObj": {
"modifyAclAccess": "boolean",
"hidden": "boolean",
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"customer": "string",
"url": "string",
"eventFilterType": "string",
"forceV2UI": "boolean",
"sections": [
{
"name": "string",
"id": "string",
"rows": [
{
"heightFactor": "integer",
"charts": [
{
"base": "integer",
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": "boolean",
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": "boolean",
"sourceColor": "string",
"secondaryAxis": "boolean",
"scatterPlotSource": "string"
}
],
"noDefaultEvents": "boolean",
"summarization": "string",
"includeObsoleteMetrics": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": "boolean",
"anomalyDetectionOn": "boolean",
"filterOutNonAnomalies": "boolean",
"displayConfidenceBounds": "boolean"
}
]
}
]
}
],
"disableRefreshInLiveMode": "boolean",
"hideChartWarning": "boolean",
"displayDescription": "boolean",
"displaySectionTableOfContents": "boolean",
"displayQueryParameters": "boolean",
"chartTitleScalar": "integer",
"eventQuery": "string",
"defaultTimeWindow": "string",
"defaultStartTime": "integer",
"defaultEndTime": "integer",
"chartTitleColor": "string",
"chartTitleBgColor": "string",
"viewsLastDay": "integer",
"viewsLastWeek": "integer",
"viewsLastMonth": "integer",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"includeObsoleteMetrics": "boolean",
"creatorId": "string",
"updaterId": "string",
"numCharts": "integer",
"numFavorites": "integer",
"favorite": "boolean"
},
"url": "string",
"dashboardMinObj": {
"name": "string",
"id": "string",
"description": "string"
}
}
],
"status": {
"contentStatus": "string",
"installStatus": "string"
},
"baseUrl": "string",
"alerts": [
{
"name": "string",
"description": "string",
"alertObj": {
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": "boolean",
"lastEventTime": "integer",
"hidden": "boolean",
"severity": "string",
"minutes": "integer",
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": "boolean",
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"orphan": "boolean",
"deleted": "boolean",
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": "integer",
"processRateMinutes": "integer",
"createUserId": "string",
"updated": "integer",
"updateUserId": "string",
"queryFailing": "boolean",
"lastFailedTime": "integer",
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": "boolean",
"lastProcessedMillis": "integer",
"pointsScannedAtLastQuery": "integer",
"includeObsoleteMetrics": "boolean",
"lastQueryTime": "integer",
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": "boolean",
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": "boolean",
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": "boolean",
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": "boolean",
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": "integer",
"snoozed": "integer",
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"querySyntaxError": "boolean",
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"notificants": [
"string"
],
"lastNotificationMillis": "integer",
"notificationResendFrequencyMinutes": "integer",
"alertsLastDay": "integer",
"alertsLastWeek": "integer",
"alertsLastMonth": "integer",
"numPointsInFailureFrame": "integer",
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"systemAlertVersion": "integer",
"alertType": "string",
"evaluateRealtimeData": "boolean",
"secureMetricDetails": "boolean",
"enablePDIncidentBySeries": "boolean",
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": "integer",
"fixedLegendEnabled": "boolean",
"fixedLegendUseRawStats": "boolean",
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": "integer",
"showHosts": "boolean",
"showLabels": "boolean",
"showRawValues": "boolean",
"showValueColumn": "boolean",
"autoColumnTags": "boolean",
"columnTags": "string",
"tagMode": "string",
"numTags": "integer",
"groupBySource": "boolean",
"sortValuesDescending": "boolean",
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": "boolean",
"y1ScaleSIBy1024": "boolean",
"y0UnitAutoscaling": "boolean",
"y1UnitAutoscaling": "boolean",
"invertDynamicLegendHoverControl": "boolean",
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": "boolean",
"fixedLegendShowMetricName": "boolean",
"fixedLegendFilterLimit": "integer",
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": "boolean",
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": "boolean",
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
"integer"
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": "integer",
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": "integer",
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": "integer",
"alertChartDescription": "string"
},
"url": "string",
"alertMinObj": {
"name": "string",
"id": "string"
}
}
],
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string",
"overview": "string",
"setup": "string",
"metricsDocs": "string",
"haveMetricDropdown": "boolean",
"setups": [
{
"type": "string",
"description": "string",
"title": "string",
"filePath": "string"
}
]
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"id": "string",
"reason": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"title": "string",
"customerId": "string",
"creatorId": "string",
"updaterId": "string",
"startTimeInSeconds": "integer",
"endTimeInSeconds": "integer",
"relevantCustomerTags": [
"string"
],
"relevantHostNames": [
"string"
],
"relevantHostTags": [
"string"
],
"relevantCustomerTagsAnded": "boolean",
"relevantHostTagsAnded": "boolean",
"hostTagGroupHostNamesGroupAnded": "boolean",
"pointTagFilter": "string",
"pointTagFilterAnded": "boolean",
"eventName": "string",
"targets": [
"string"
],
"sortAttr": "integer",
"runningState": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"source": "string",
"severity": "string",
"id": "string",
"target": "string",
"content": "string",
"scope": "string",
"startEpochMillis": "integer",
"endEpochMillis": "integer",
"display": "string",
"title": "string",
"read": "boolean"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"serviceCount": "integer",
"hidden": "boolean",
"application": "string",
"status": "string",
"lastReported": "integer",
"satisfiedLatencyMillis": "integer",
"created": "integer",
"updateUserId": "string",
"lastUpdated": "integer"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"serviceInstanceCount": "integer",
"hidden": "boolean",
"source": "string",
"component": "string",
"application": "string",
"service": "string",
"customDashboardLink": "string",
"status": "string",
"lastReported": "integer",
"satisfiedLatencyMillis": "integer",
"created": "integer",
"updateUserId": "string",
"lastUpdated": "integer"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"method": "string",
"id": "string",
"contentType": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"title": "string",
"customerId": "string",
"triggers": [
"string"
],
"template": "string",
"recipient": "string",
"emailSubject": "string",
"isHtmlContent": "boolean",
"routes": [
{
"method": "string",
"target": "string",
"filter": "string"
}
],
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"version": "string",
"name": "string",
"id": "string",
"status": "string",
"customerId": "string",
"deleted": "boolean",
"lastCheckInTime": "integer",
"inTrash": "boolean",
"hostname": "string",
"proxyname": "string",
"lastKnownError": "string",
"lastErrorTime": "integer",
"lastErrorEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"timeDrift": "integer",
"bytesLeftForBuffer": "integer",
"bytesPerMinuteForBuffer": "integer",
"localQueueSize": "integer",
"sshAgent": "boolean",
"ephemeral": "boolean",
"shutdown": "boolean",
"truncate": "boolean",
"collectorSetsRateLimit": "boolean",
"collectorRateLimit": "integer",
"histogramRateLimit": "integer",
"sourceTagsRateLimit": "number",
"eventsRateLimit": "number",
"spanRateLimit": "integer",
"spanLogsRateLimit": "integer",
"preprocessorRules": "string",
"userId": "string",
"histoDisabled": "boolean",
"traceDisabled": "boolean",
"spanLogsDisabled": "boolean",
"logsDisabled": "boolean",
"statusCause": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"relatedData": {
"relatedId": "string",
"summary": "string",
"alertDescription": "string",
"anomalyChartLink": "string",
"commonSources": [
"string"
],
"commonMetrics": [
"string"
],
"commonDimensions": [
"string"
],
"enhancedScore": "number"
},
"similarityScore": "number",
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"relatedEventDTO": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"relatedData": {
"relatedId": "string",
"summary": "string",
"alertDescription": "string",
"anomalyChartLink": "string",
"commonSources": [
"string"
],
"commonMetrics": [
"string"
],
"commonDimensions": [
"string"
],
"enhancedScore": "number"
},
"similarityScore": "number",
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"relatedAnomalyDTO": {
"relatedData": {
"relatedId": "string",
"summary": "string",
"alertDescription": "string",
"anomalyChartLink": "string",
"commonSources": [
"string"
],
"commonMetrics": [
"string"
],
"commonDimensions": [
"string"
],
"enhancedScore": "number"
},
"id": "string",
"model": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"row": "integer",
"dashboardId": "string",
"endMs": "integer",
"queryHash": "string",
"imageLink": "string",
"chartHash": "string",
"paramHash": "string",
"startMs": "integer",
"section": "integer",
"col": "integer",
"chartLink": "string",
"originalStripes": [
{
"model": "string",
"endMs": "integer",
"imageLink": "string",
"startMs": "integer"
}
],
"updatedMs": "integer",
"deleted": "boolean",
"customer": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"creatorId": "string",
"updaterId": "string"
},
"similarityScore": "number"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": "integer",
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": "integer",
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": "boolean",
"usersRemovable": "boolean",
"usersAddable": "boolean",
"permsEditable": "boolean",
"deletable": "boolean"
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": [
"string"
],
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"entityType": "string",
"userId": "string",
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": [
"string"
],
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"unitedRoles": [
"string"
],
"unitedPermissions": [
"string"
],
"tokens": [
{
"tokenID": "string",
"tokenName": "string",
"account": "string",
"accountType": "string",
"lastUsed": "integer",
"dateGenerated": "integer"
}
],
"userGroups": [
{
"id": "04e5fd3a-c916-45aa-923c-2fa02e9eddac",
"name": "string",
"customer": "string",
"users": [
"string"
],
"userCount": "integer",
"properties": {
"nameEditable": "boolean",
"usersEditable": "boolean",
"rolesEditable": "boolean"
},
"description": "string",
"roles": [
"RoleDTO Object"
]
}
],
"roles": [
{
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": "integer",
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": "integer",
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": "boolean",
"usersRemovable": "boolean",
"usersAddable": "boolean",
"permsEditable": "boolean",
"deletable": "boolean"
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string"
}
],
"active": "boolean",
"description": "string",
"identifier": "string",
"groups": [
"string"
],
"lastUsed": "integer"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"hidden": "boolean",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"markedNewEpochMillis": "integer",
"creatorId": "string",
"updaterId": "string",
"sourceName": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"name": "string",
"id": "string",
"active": "boolean",
"description": "string",
"expression": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"samplingPercent": "integer",
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
{
"users": [
"string"
],
"userCount": "integer",
"properties": {
"nameEditable": "boolean",
"usersEditable": "boolean",
"rolesEditable": "boolean"
},
"roles": [
{
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": "integer",
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": "integer",
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": "boolean",
"usersRemovable": "boolean",
"usersAddable": "boolean",
"permsEditable": "boolean",
"deletable": "boolean"
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string"
}
],
"roleCount": "integer",
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"customer": "string"
}
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"version": "string",
"name": "string",
"id": "string",
"status": "string",
"customerId": "string",
"deleted": "boolean",
"lastCheckInTime": "integer",
"inTrash": "boolean",
"hostname": "string",
"proxyname": "string",
"lastKnownError": "string",
"lastErrorTime": "integer",
"lastErrorEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": "integer",
"endTime": "integer",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": "integer",
"hosts": [
"string"
],
"summarizedEvents": "integer",
"alertTags": [
"string"
],
"isUserEvent": "boolean",
"isEphemeral": "boolean",
"creatorId": "string",
"updaterId": "string",
"updatedAt": "integer",
"runningState": "string",
"canDelete": "boolean",
"canClose": "boolean",
"creatorType": [
"string"
]
},
"timeDrift": "integer",
"bytesLeftForBuffer": "integer",
"bytesPerMinuteForBuffer": "integer",
"localQueueSize": "integer",
"sshAgent": "boolean",
"ephemeral": "boolean",
"shutdown": "boolean",
"truncate": "boolean",
"collectorSetsRateLimit": "boolean",
"collectorRateLimit": "integer",
"histogramRateLimit": "integer",
"sourceTagsRateLimit": "number",
"eventsRateLimit": "number",
"spanRateLimit": "integer",
"spanLogsRateLimit": "integer",
"preprocessorRules": "string",
"userId": "string",
"histoDisabled": "boolean",
"traceDisabled": "boolean",
"spanLogsDisabled": "boolean",
"logsDisabled": "boolean",
"statusCause": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"inputQuery": "string",
"translatedInput": "string",
"queryType": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"creatorId": "string",
"updaterId": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"creatorId": "string",
"updaterId": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": "integer",
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": "integer",
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": "boolean",
"usersRemovable": "boolean",
"usersAddable": "boolean",
"permsEditable": "boolean",
"deletable": "boolean"
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": [
"string"
],
"creatorId": "string",
"updaterId": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"entityType": "string",
"userId": "string",
"creatorId": "string",
"updaterId": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": [
"string"
],
"creatorId": "string",
"updaterId": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"unitedRoles": [
"string"
],
"unitedPermissions": [
"string"
],
"tokens": [
{
"tokenID": "string",
"tokenName": "string",
"account": "string",
"accountType": "string",
"lastUsed": "integer",
"dateGenerated": "integer"
}
],
"userGroups": [
{
"id": "04e5fd3a-c916-45aa-923c-2fa02e9eddac",
"name": "string",
"customer": "string",
"users": [
"string"
],
"userCount": "integer",
"properties": {
"nameEditable": "boolean",
"usersEditable": "boolean",
"rolesEditable": "boolean"
},
"description": "string",
"roles": [
"RoleDTO Object"
]
}
],
"roles": [
{
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": "integer",
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": "integer",
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": "boolean",
"usersRemovable": "boolean",
"usersAddable": "boolean",
"permsEditable": "boolean",
"deletable": "boolean"
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string"
}
],
"active": "boolean",
"description": "string",
"identifier": "string",
"groups": [
"string"
],
"lastUsed": "integer"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": [
"string"
]
}
response
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": [
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
]
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"hidden": "boolean",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"markedNewEpochMillis": "integer",
"creatorId": "string",
"updaterId": "string",
"sourceName": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"name": "string",
"id": "string",
"active": "boolean",
"description": "string",
"expression": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"samplingPercent": "integer",
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": "string"
}
response
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"items": [
"string"
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"tokenID": "string",
"tokenName": "string",
"account": "string",
"accountType": "string",
"lastUsed": "integer",
"dateGenerated": "integer"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"users": [
"string"
],
"userCount": "integer",
"properties": {
"nameEditable": "boolean",
"usersEditable": "boolean",
"rolesEditable": "boolean"
},
"roles": [
{
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": "integer",
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": "integer",
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": "boolean",
"usersRemovable": "boolean",
"usersAddable": "boolean",
"permsEditable": "boolean",
"deletable": "boolean"
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string"
}
],
"roleCount": "integer",
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"customer": "string"
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
},
"response": {
"validUsers": [
{
"identifier": "string",
"customer": "string",
"ssoId": "string",
"lastSuccessfulLogin": "integer",
"groups": [
"string"
],
"userGroups": [
{
"id": "04e5fd3a-c916-45aa-923c-2fa02e9eddac",
"name": "string",
"customer": "string",
"users": [
"string"
],
"userCount": "integer",
"properties": {
"nameEditable": "boolean",
"usersEditable": "boolean",
"rolesEditable": "boolean"
},
"description": "string",
"roles": [
"RoleDTO Object"
]
}
],
"roles": [
{
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": "integer",
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": "integer",
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": "boolean",
"usersRemovable": "boolean",
"usersAddable": "boolean",
"permsEditable": "boolean",
"deletable": "boolean"
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string"
}
]
}
],
"invalidIdentifiers": [
"string"
]
}
}
JSON container for the HTTP response along with status
{
"status": {
"result": "string",
"message": "string",
"code": "integer"
}
}
{
"result": "string",
"message": "string",
"code": "integer"
}
result
Descriptive message of the status of this response
HTTP Response code corresponding to this response
{
"permissions": [
"string"
],
"name": "string",
"description": "string"
}
List of permissions the role has been granted access to
The name of the role
The description of the role
{
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": "integer",
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": "integer",
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": "boolean",
"usersRemovable": "boolean",
"usersAddable": "boolean",
"permsEditable": "boolean",
"deletable": "boolean"
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string"
}
A sample of the groups assigned to this role. Please use the Role facet of the Group Search API to get the full list of groups for this role
Total number of groups that are linked to the role
A sample of the accounts assigned to this role. Please use the Role facet of the Account Search API to get the full list of accounts for this role
Total number of accounts that are linked to the role
The list of permissions that are restricted with the role. Currently only CSP roles have restrictions.
List of permissions the role has been granted access to
The name of the role
The unique identifier of the role
The description of the role
createdEpochMillis
The last time when the role is updated, in epoch milliseconds
The account that updated this role last time
The id of the customer to which the role belongs
{
"nameEditable": "boolean",
"usersRemovable": "boolean",
"usersAddable": "boolean",
"permsEditable": "boolean",
"deletable": "boolean"
}
nameEditable
usersRemovable
usersAddable
permsEditable
deletable
{
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string"
}
List of permissions the role has been granted access to
The name of the role
The unique identifier of the role
The description of the role
Saved search queries for Application Status
{
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string"
}
Name of the search
id
createdEpochMillis
updatedEpochMillis
deleted
creatorId
updaterId
Saved search groups for Application Status
{
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": [
"string"
],
"creatorId": "string",
"updaterId": "string"
}
Name of the search group
id
createdEpochMillis
updatedEpochMillis
searchFilters
creatorId
updaterId
Saved queries for searches over Wavefront entities
{
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"entityType": "string",
"userId": "string",
"creatorId": "string",
"updaterId": "string"
}
id
The map corresponding to the search query. The key is the name of the query, and the value is a JSON representation of the query
createdEpochMillis
updatedEpochMillis
The Wavefront entity type over which to search
The user for whom this search is saved
creatorId
updaterId
Saved search queries for Traces
{
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": {
"filters": [
{
"filterType": "string",
"values": {
"stringValue": "string",
"arrayValue": [
"string"
],
"logicalValue": [
[
{}
]
]
}
}
],
"query": "string"
},
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string"
}
Name of the search
id
createdEpochMillis
updatedEpochMillis
deleted
creatorId
updaterId
Saved search groups for Traces
{
"name": "string",
"id": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"searchFilters": [
"string"
],
"creatorId": "string",
"updaterId": "string"
}
Name of the search group
id
createdEpochMillis
updatedEpochMillis
searchFilters
creatorId
updaterId
{
"logicalType": {
"name": "string"
},
"error": "boolean",
"elementType": "Schema Object",
"fullName": "string",
"fields": [
{}
],
"name": "string",
"valueType": "Schema Object",
"namespace": "string",
"enumDefault": "string",
"doc": "string",
"aliases": [
"string"
],
"union": "boolean",
"enumSymbols": [
"string"
],
"fixedSize": "integer",
"types": [
"Schema Object"
]
}
type
error
fullName
name
namespace
enumDefault
doc
aliases
union
enumSymbols
fixedSize
objectProps
{
"key": "string",
"value": "string",
"values": [
"string"
],
"matchingMethod": "string",
"negated": "boolean",
"start": "integer",
"end": "integer"
}
The entity facet (key) by which to search. Valid keys are any property keys returned by the JSON representation of the entity. Examples are 'creatorId', 'name', etc. The following special key keywords are also valid: 'tags' performs a search on entity tags, 'tagpath' performs a hierarchical search on tags, with periods (.) as path level separators. 'freetext' performs a free text search across many fields of the entity
The entity facet value for which to search. Either value or values field is required. If both are set, values takes precedence.
The entity facet values for which to search based on OR operation. Either value or values field is required. If both are set, values takes precedence.
The method by which search matching is performed. Default: CONTAINS
The flag to create a NOT operation. Default: false
The start point of the range. At least one of start or end points should be available for range search.
The end point of the range. At least one of start or end points should be available for range search.
Wavefront service account entity.
{
"unitedRoles": [
"string"
],
"unitedPermissions": [
"string"
],
"tokens": [
{
"tokenID": "string",
"tokenName": "string",
"account": "string",
"accountType": "string",
"lastUsed": "integer",
"dateGenerated": "integer"
}
],
"userGroups": [
{
"id": "04e5fd3a-c916-45aa-923c-2fa02e9eddac",
"name": "string",
"customer": "string",
"users": [
"string"
],
"userCount": "integer",
"properties": {
"nameEditable": "boolean",
"usersEditable": "boolean",
"rolesEditable": "boolean"
},
"description": "string",
"roles": [
"RoleDTO Object"
]
}
],
"roles": [
{
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": "integer",
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": "integer",
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": "boolean",
"usersRemovable": "boolean",
"usersAddable": "boolean",
"permsEditable": "boolean",
"deletable": "boolean"
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string"
}
],
"active": "boolean",
"description": "string",
"identifier": "string",
"groups": [
"string"
],
"lastUsed": "integer"
}
The list of account's roles assigned directly or through user groups assigned to it
The list of account's permissions assigned directly or through united roles assigned to it
The state of the service account.
The description of the service account.
The unique identifier of a service account.
The list of service account's permissions.
The last time when a token of the service account was used.
Wavefront service account entity for write requests.
{
"identifier": "string",
"active": "boolean",
"description": "string",
"tokens": [
"string"
],
"userGroups": [
"string"
],
"groups": [
"string"
],
"roles": [
"string"
]
}
The unique identifier for a service account.
The current state of the service account.
The description of the service account to be created.
The service account's API tokens.
The list of user group ids, the service account will be added to.
The list of permissions, the service account will be granted.
The list of role ids, the service account will be added to."
Configurations specific to the Snowflake Platform integration. Only applicable when the containing Credential has service=SNOWFLAKE
{
"userName": "string",
"password": "string",
"metricFilterRegex": "string",
"privateKey": "string",
"role": "string",
"accountID": "string",
"warehouse": "string"
}
Snowflake Username
Snowflake Password
A regular expression that a metric name must match (case-insensitively) in order to be ingested
Snowflake Private Key
Role to be used while querying snowflake database
Snowflake AccountID
Warehouse to be used while querying snowflake database
{
"limit": "integer",
"offset": "integer",
"query": [
{
"key": "string",
"value": "string",
"values": [
"string"
],
"matchingMethod": "string",
"negated": "boolean",
"start": "integer",
"end": "integer"
}
],
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
The number of results to return. Default: 100, Maximum allowed: 1000
The number of results to skip before returning values. Default: 0
A list of queries by which to limit the search results. Entities that match ALL queries in the list are returned
Specifies how returned items should be sorted
{
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
Whether to sort ascending. If undefined, sorting is not guaranteed
The facet by which to sort
Whether this sort requests the default ranking order. Ascending/descending does not matter if this attribute is true.
A source (sometimes called host) of time series data from telemetry ingestion
{
"hidden": "boolean",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"markedNewEpochMillis": "integer",
"creatorId": "string",
"updaterId": "string",
"sourceName": "string"
}
A derived field denoting whether this source has been hidden (e.g. excluding it from query autocomplete among other things)
id of this source, must be exactly equivalent to 'sourceName'
Description of this source
createdEpochMillis
updatedEpochMillis
A Map (String -> boolean) Representing the source tags associated with this source. To create a tag, set it as a KEY in this map, with associated value equal to true
Epoch Millis when this source was marked as ~status.new
creatorId
updaterId
The name of the source, usually set by ingested telemetry
Convenience wrapper for the identifier of a unique series, which consists of a source (host) and a metric or aggregation (label)
{
"severity": "string",
"host": "string",
"startTime": "integer",
"label": "string",
"observed": "integer",
"firing": "integer"
}
severity
Source (or host). "Source" and "host" are synonyms in current versions of wavefront, but the host terminology is deprecated
Start time of this failing HLP, in epoch millis.
label
observed
firing
tags
{
"cursor": "string",
"limit": 100,
"query": [
{
"key": "string",
"value": "string",
"values": [
"string"
],
"matchingMethod": "string",
"negated": "boolean",
"start": "integer",
"end": "integer"
}
],
"sortSourcesAscending": "boolean",
"includeObsolete": "boolean"
}
The id (exclusive) from which search results resume returning. Users should supply an entity 'id' to this property. Its main purpose is to resume where a previous search left off because of the 'limit' parameter. If a user supplies the last id in a set of results to cursor, while keeping the query the same, the system will return the next page of results
The number of results to return. Default: 100
Whether to sort source results ascending lexigraphically by id/sourceName. Default: true
Whether to fetch obsolete sources. Default: false
{
"name": "string",
"annotations": [
{}
],
"host": "string",
"startMs": "integer",
"spanId": "string",
"traceId": "string",
"durationMs": "integer"
}
Span name
Annotations (key-value pairs) of this span
Source/Host of this span
Span start time (in milliseconds)
Span ID
Trace ID
Span duration (in milliseconds)
Span Sampling Policy
{
"name": "string",
"id": "string",
"active": "boolean",
"description": "string",
"expression": "string",
"createdEpochMillis": "integer",
"updatedEpochMillis": "integer",
"samplingPercent": "integer",
"deleted": "boolean",
"creatorId": "string",
"updaterId": "string"
}
Span sampling policy name
Unique identifier of the span sampling policy
Whether span sampling policy is active
Span sampling policy description
Span sampling policy expression
Created time of the span sampling policy
Last updated time of the span sampling policy
Sampling percent of policy, 100 means keeping all the spans that matches the policy
Whether span sampling policy is soft-deleted, can be modified with delete/undelete api
Creator user of the span sampling policy
Updater user of the span sampling policy
{
"keys": "integer",
"points": "integer",
"metrics": "integer",
"edges": "integer",
"spans": "integer",
"distributions": "integer",
"summaries": "integer",
"queries": "integer",
"buffer_keys": "integer",
"compacted_keys": "integer",
"skipped_compacted_keys": "integer",
"compacted_points": "integer",
"cached_compacted_keys": "integer",
"latency": "integer",
"s3_keys": "integer",
"cpu_ns": "integer",
"metrics_used": "integer",
"hosts_used": "integer",
"query_tasks": "integer"
}
keys
points
metrics
edges
spans
distributions
summaries
queries
buffer_keys
compacted_keys
skipped_compacted_keys
compacted_points
cached_compacted_keys
latency
s3_keys
cpu_ns
metrics_used
hosts_used
query_tasks
DTO for wavefront stripe(under anomaly package)
{
"model": "string",
"endMs": "integer",
"imageLink": "string",
"startMs": "integer"
}
model for this stripe
endMs for this stripe
image link for this stripe
startMs for this stripe
{
"items": [
"string"
],
"offset": "integer",
"limit": "integer",
"cursor": "string",
"totalItems": "integer",
"moreItems": "boolean",
"sort": {
"ascending": "boolean",
"field": "string",
"default": "boolean"
}
}
List of requested items
offset
limit
The id at which the current (limited) search can be continued to obtain more matching items
An estimate (lower-bound) of the total number of items available for return. May not be a tight estimate for facet queries
Whether more items are available for return by increment offset or cursor
Alert target display information that includes type, id, and the name of the alert target.
{
"method": "string",
"id": "string",
"name": "string"
}
Notification method of the alert target
ID of the alert target
Name of the alert target
{
"label": "string",
"host": "string",
"data": [
[
{}
]
]
}
Label of this timeseries
Source/Host of this timeseries
Tags (key-value annotations) of this timeseries
Data returned by this time series. This is returned as a list of points, where each point is represented as a two-element list with 1st element being the timestamp in epoch SECONDS and the 2nd element being the numeric value of the series at the timestamp
{
"end_ms": "integer",
"spans": [
{
"name": "string",
"annotations": [
{}
],
"host": "string",
"startMs": "integer",
"spanId": "string",
"traceId": "string",
"durationMs": "integer"
}
],
"start_ms": "integer",
"traceId": "string",
"total_duration_ms": "integer"
}
Trace end time (in milliseconds)
Trace start time (in milliseconds)
Trace ID
Trace total duration (in milliseconds)
{
"dashboardId": "string",
"description": "string"
}
dashboardId
parameters
description
The dimension tuple results computed based on the query keys used to run the query.
{
"key": [
"string"
],
"valueList": [
{
"count": "integer",
"value": [
"string"
]
}
]
}
The keys used to surface the dimensions.
All the possible value combination satisfying the provided keys and their respective counts from the query keys.
{
"count": "integer",
"value": [
"string"
]
}
The count of the values appearing in the query keys.
The possible values for a given key list.
Wavefront user api token entity for update requests
{
"tokenID": "string",
"tokenName": "string",
"account": "string",
"accountType": "string",
"lastUsed": "integer",
"dateGenerated": "integer"
}
The identifier of the user API token
The name of the user API token
The account who generated this token.
The user or service account generated this token.
The last time this token was used
The generation date of the token.
{
"identifier": "string",
"customer": "string",
"ssoId": "string",
"lastSuccessfulLogin": "integer",
"groups": [
"string"
],
"userGroups": [
{
"id": "04e5fd3a-c916-45aa-923c-2fa02e9eddac",
"name": "string",
"customer": "string",
"users": [
"string"
],
"userCount": "integer",
"properties": {
"nameEditable": "boolean",
"usersEditable": "boolean",
"rolesEditable": "boolean"
},
"description": "string",
"roles": [
"RoleDTO Object"
]
}
],
"roles": [
{
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": "integer",
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": "integer",
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": "boolean",
"usersRemovable": "boolean",
"usersAddable": "boolean",
"permsEditable": "boolean",
"deletable": "boolean"
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string"
}
]
}
identifier
customer
ssoId
lastSuccessfulLogin
groups
Api model for user group
{
"id": "04e5fd3a-c916-45aa-923c-2fa02e9eddac",
"name": "string",
"customer": "string",
"users": [
"string"
],
"userCount": "integer",
"properties": {
"nameEditable": "boolean",
"usersEditable": "boolean",
"rolesEditable": "boolean"
},
"description": "string",
"roles": [
"RoleDTO Object"
]
}
Unique ID for the user group
Name of the user group
ID of the customer to which the user group belongs
List of Users that are members of the user group. Maybe incomplete.
Total number of users that are members of the user group
The description of the user group
Wavefront user group entity
{
"users": [
"string"
],
"userCount": "integer",
"properties": {
"nameEditable": "boolean",
"usersEditable": "boolean",
"rolesEditable": "boolean"
},
"roles": [
{
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": "integer",
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": "integer",
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": "boolean",
"usersRemovable": "boolean",
"usersAddable": "boolean",
"permsEditable": "boolean",
"deletable": "boolean"
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string"
}
],
"roleCount": "integer",
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"customer": "string"
}
List(may be incomplete) of users that are members of the user group.
Total number of users that are members of the user group
Total number of roles that are linked the the user group
The name of the user group
The unique identifier of the user group
The description of the user group
createdEpochMillis
The id of the customer to which the user group belongs
{
"nameEditable": "boolean",
"usersEditable": "boolean",
"rolesEditable": "boolean"
}
nameEditable
usersEditable
rolesEditable
Wavefront user group entity for write requests
{
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"customer": "string",
"roleIDs": [
"string"
]
}
The name of the user group
The unique identifier of the user group
The description of the user group
createdEpochMillis
The id of the customer to which the user group belongs
List of role IDs the user group has been linked to.
Model for an user object
{
"identifier": "string",
"customer": "string",
"ssoId": "string",
"lastSuccessfulLogin": "integer",
"groups": [
"string"
],
"userGroups": [
{
"id": "04e5fd3a-c916-45aa-923c-2fa02e9eddac",
"name": "string",
"customer": "string",
"users": [
"string"
],
"userCount": "integer",
"properties": {
"nameEditable": "boolean",
"usersEditable": "boolean",
"rolesEditable": "boolean"
},
"description": "string",
"roles": [
"RoleDTO Object"
]
}
],
"roles": [
{
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": "integer",
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": "integer",
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": "boolean",
"usersRemovable": "boolean",
"usersAddable": "boolean",
"permsEditable": "boolean",
"deletable": "boolean"
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string"
}
]
}
The unique identifier of this user, which must be their valid email address
The id of the customer to which this user belongs
ssoId
lastSuccessfulLogin
The permissions granted to this user
{
"identifier": "string",
"ssoId": "string",
"customer": "string",
"groups": [
"string"
],
"userGroups": [
"string"
],
"credential": "string",
"roles": [
"string"
]
}
identifier
ssoId
customer
groups
userGroups
credential
roles
{
"emailAddress": "string",
"groups": [
"string"
],
"userGroups": [
"string"
],
"roles": [
"string"
]
}
The (unique) identifier of the user to create. Must be a valid email address
List of permission groups to grant to this user. Please note that 'host_tag_management' is the equivalent of the 'Source Tag Management' permission. Possible values are log_management, dashboard_management, events_management, alerts_management, derived_metrics_management, host_tag_management, agent_management, token_management, ingestion, user_management, embedded_charts, metrics_management, external_links_management, application_management, batch_query_priority, saml_sso_management, monitored_application_service_management
List of user groups to this user.
The list of role ids, the user will be added to.
{
"validUsers": [
{
"identifier": "string",
"customer": "string",
"ssoId": "string",
"lastSuccessfulLogin": "integer",
"groups": [
"string"
],
"userGroups": [
{
"id": "04e5fd3a-c916-45aa-923c-2fa02e9eddac",
"name": "string",
"customer": "string",
"users": [
"string"
],
"userCount": "integer",
"properties": {
"nameEditable": "boolean",
"usersEditable": "boolean",
"rolesEditable": "boolean"
},
"description": "string",
"roles": [
"RoleDTO Object"
]
}
],
"roles": [
{
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": "integer",
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": "integer",
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": "boolean",
"usersRemovable": "boolean",
"usersAddable": "boolean",
"permsEditable": "boolean",
"deletable": "boolean"
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": "integer",
"lastUpdatedMs": "integer",
"lastUpdatedAccountId": "string",
"customer": "string"
}
]
}
],
"invalidIdentifiers": [
"string"
]
}
invalidIdentifiers
Configurations specific to the vRops CloudPlatform integration. Only applicable when the containing Credential has service=VROPS
{
"baseURL": "https://www.mgmt.cloud.vmware.com/vrops-cloud",
"metricFilterRegex": "^vrops.(vmware|cloudhealthadapter).(clustercomputeresource|datastore).*$",
"categoriesToFetch": [
"string"
],
"vropsAPIToken": "string",
"organizationID": "string"
}
The base url for vrops api, Default : https://www.mgmt.cloud.vmware.com/vrops-cloud
A regular expression that a metric name must match (case-insensitively) in order to be ingested
A list of vRops Adpater and Resource kind to fetch metrics. Allowable values are VMWARE_DATASTORE, VMWARE_DATASTORE)
The vRops API Token
OrganizationID will be derived from api token
Adapter names: Metrics will be fetched of only these adapter if given
{
"customerTags": [
"string"
]
}
Customer-wide tags. Can be on various wavefront entities such alerts or dashboards.
A setup definition belonging to a particular integration
{
"type": "string",
"description": "string",
"title": "string",
"filePath": "string"
}
Setup Type
Setup description
Setup title
Relative file path to the setup.md file