Integration
Integration
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
JSON Example
{
"version": "string",
"hidden": false,
"name": "string",
"id": "string",
"description": "string",
"icon": "string",
"metrics": {
"chartObjs": [
{
"base": 0,
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": false,
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": false,
"sourceColor": "string",
"secondaryAxis": false,
"scatterPlotSource": "string"
}
],
"noDefaultEvents": false,
"summarization": "string",
"includeObsoleteMetrics": false,
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": 0,
"fixedLegendEnabled": false,
"fixedLegendUseRawStats": false,
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": 0,
"showHosts": false,
"showLabels": false,
"showRawValues": false,
"showValueColumn": false,
"autoColumnTags": false,
"columnTags": "string",
"tagMode": "string",
"numTags": 0,
"groupBySource": false,
"sortValuesDescending": false,
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": false,
"y1ScaleSIBy1024": false,
"y0UnitAutoscaling": false,
"y1UnitAutoscaling": false,
"invertDynamicLegendHoverControl": false,
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": false,
"fixedLegendShowMetricName": false,
"fixedLegendFilterLimit": 0,
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": false,
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": false,
"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": [
0
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": 0,
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": false,
"anomalyDetectionOn": false,
"filterOutNonAnomalies": false,
"displayConfidenceBounds": false
}
],
"display": [
"string"
],
"required": [
"string"
],
"charts": [
"string"
],
"prefixes": [
"string"
],
"ppsDimensions": [
"string"
]
},
"createdEpochMillis": 0,
"updatedEpochMillis": 0,
"aliasOf": "string",
"aliasIntegrations": [
{
"name": "string",
"id": "string",
"description": "string",
"icon": "string",
"baseUrl": "string"
}
],
"dashboards": [
{
"name": "string",
"description": "string",
"dashboardObj": {
"modifyAclAccess": false,
"hidden": false,
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": 0,
"updatedEpochMillis": 0,
"systemOwned": false,
"tags": {
"customerTags": [
"string"
]
},
"orphan": false,
"deleted": false,
"customer": "string",
"url": "string",
"eventFilterType": "string",
"forceV2UI": false,
"sections": [
{
"name": "string",
"id": "string",
"rows": [
{
"heightFactor": 0,
"charts": [
{
"base": 0,
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": false,
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": false,
"sourceColor": "string",
"secondaryAxis": false,
"scatterPlotSource": "string"
}
],
"noDefaultEvents": false,
"summarization": "string",
"includeObsoleteMetrics": false,
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": 0,
"fixedLegendEnabled": false,
"fixedLegendUseRawStats": false,
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": 0,
"showHosts": false,
"showLabels": false,
"showRawValues": false,
"showValueColumn": false,
"autoColumnTags": false,
"columnTags": "string",
"tagMode": "string",
"numTags": 0,
"groupBySource": false,
"sortValuesDescending": false,
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": false,
"y1ScaleSIBy1024": false,
"y0UnitAutoscaling": false,
"y1UnitAutoscaling": false,
"invertDynamicLegendHoverControl": false,
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": false,
"fixedLegendShowMetricName": false,
"fixedLegendFilterLimit": 0,
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": false,
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": false,
"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": [
0
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": 0,
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": false,
"anomalyDetectionOn": false,
"filterOutNonAnomalies": false,
"displayConfidenceBounds": false
}
]
}
]
}
],
"disableRefreshInLiveMode": false,
"hideChartWarning": false,
"displayDescription": false,
"displaySectionTableOfContents": false,
"displayQueryParameters": false,
"chartTitleScalar": 0,
"eventQuery": "string",
"defaultTimeWindow": "string",
"defaultStartTime": 0,
"defaultEndTime": 0,
"chartTitleColor": "string",
"chartTitleBgColor": "string",
"viewsLastDay": 0,
"viewsLastWeek": 0,
"viewsLastMonth": 0,
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"includeObsoleteMetrics": false,
"creatorId": "string",
"updaterId": "string",
"numCharts": 0,
"numFavorites": 0,
"favorite": false
},
"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": false,
"lastEventTime": 0,
"hidden": false,
"severity": "string",
"minutes": 0,
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": 0,
"updatedEpochMillis": 0,
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": false,
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": 0,
"endTime": 0,
"createdEpochMillis": 0,
"updatedEpochMillis": 0,
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": 0,
"hosts": [
"string"
],
"summarizedEvents": 0,
"alertTags": [
"string"
],
"isUserEvent": false,
"isEphemeral": false,
"creatorId": "string",
"updaterId": "string",
"updatedAt": 0,
"runningState": "string",
"canDelete": false,
"canClose": false,
"creatorType": [
"string"
]
},
"orphan": false,
"deleted": false,
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": 0,
"processRateMinutes": 0,
"createUserId": "string",
"updated": 0,
"updateUserId": "string",
"queryFailing": false,
"lastFailedTime": 0,
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": false,
"lastProcessedMillis": 0,
"pointsScannedAtLastQuery": 0,
"includeObsoleteMetrics": false,
"lastQueryTime": 0,
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": false,
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": false,
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": false,
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": false,
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": 0,
"snoozed": 0,
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"querySyntaxError": false,
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"notificants": [
"string"
],
"lastNotificationMillis": 0,
"notificationResendFrequencyMinutes": 0,
"alertsLastDay": 0,
"alertsLastWeek": 0,
"alertsLastMonth": 0,
"numPointsInFailureFrame": 0,
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": 0,
"endTime": 0,
"createdEpochMillis": 0,
"updatedEpochMillis": 0,
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": 0,
"hosts": [
"string"
],
"summarizedEvents": 0,
"alertTags": [
"string"
],
"isUserEvent": false,
"isEphemeral": false,
"creatorId": "string",
"updaterId": "string",
"updatedAt": 0,
"runningState": "string",
"canDelete": false,
"canClose": false,
"creatorType": [
"string"
]
},
"systemAlertVersion": 0,
"alertType": "string",
"evaluateRealtimeData": false,
"secureMetricDetails": false,
"enablePDIncidentBySeries": false,
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": 0,
"fixedLegendEnabled": false,
"fixedLegendUseRawStats": false,
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": 0,
"showHosts": false,
"showLabels": false,
"showRawValues": false,
"showValueColumn": false,
"autoColumnTags": false,
"columnTags": "string",
"tagMode": "string",
"numTags": 0,
"groupBySource": false,
"sortValuesDescending": false,
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": false,
"y1ScaleSIBy1024": false,
"y0UnitAutoscaling": false,
"y1UnitAutoscaling": false,
"invertDynamicLegendHoverControl": false,
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": false,
"fixedLegendShowMetricName": false,
"fixedLegendFilterLimit": 0,
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": false,
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": false,
"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": [
0
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": 0,
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": 0,
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": 0,
"alertChartDescription": "string"
},
"url": "string",
"alertMinObj": {
"name": "string",
"id": "string"
}
}
],
"deleted": false,
"creatorId": "string",
"updaterId": "string",
"overview": "string",
"setup": "string",
"metricsDocs": "string",
"haveMetricDropdown": false,
"setups": [
{
"type": "string",
"description": "string",
"title": "string",
"filePath": "string"
}
]
}string
version
Required
Integration version string
boolean
hidden
Required
Integration is hidden or not
string
name
Required
Integration name
string
id
Optional
id
string
description
Required
Integration description
string
icon
Required
URI path to the integration icon
integer As int64 As int64
createdEpochMillis
Optional
createdEpochMillis
integer As int64 As int64
updatedEpochMillis
Optional
updatedEpochMillis
string
aliasOf
Optional
If set, designates this integration as an alias integration, of the integration whose id is specified.
array of IntegrationAlias
aliasIntegrations
Optional
If set, a list of objects describing integrations that alias this one.
array of IntegrationDashboard
dashboards
Optional
A list of dashboards belonging to this integration
string
baseUrl
Optional
Base URL for this integration's assets
boolean
deleted
Optional
deleted
string
creatorId
Optional
creatorId
string
updaterId
Optional
updaterId
string
overview
Optional
Descriptive text giving an overview of integration functionality
string
setup
Optional
How the integration will be set-up
string
metricsDocs
Optional
Metric Preview File Name
boolean
haveMetricDropdown
Required
Integration have metric dropdown or not