google/api/http.proto (version not set)

Download OpenAPI specification:Download

ApiKeysService

ApiKeysService_CreateApiKey

Request Body schema: application/json
required

This data structure is used to create an API key.

name required	string
required	object (v3Owner)
required	object (Key Permissions) This data structure allows to specify loose permissions and permission presets for an API key. Find out more about api keys
hashed required	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "my_api_key",
"owner": {"userId": "string",
"teamId": 0,
"organisationId": "string"
},
"keyPermissions": {"presets": ["my_preset"
],
"permissions": ["read_logs"
]
},
"hashed": true
}

Response samples

200
default

Content type

application/json

{"keyId": "my_key_id",
"name": "my_api_key",
"value": "my_api_key_value"
}

ApiKeysService_GetSendDataApiKeys

Responses

Response samples

200
default

Content type

application/json

{"keys": [{"name": "my_api_key",
"owner": {"userId": "string",
"teamId": 0,
"organisationId": "string"
},
"active": true,
"hashed": true,
"keyPermissions": {"presets": [{"name": "my_preset",
"permissions": ["read_logs"
]
}
],
"permissions": ["string"
]
},
"value": "string",
"id": "string"
}
]
}

ApiKeysService_GetApiKey

path Parameters

keyId

required

string

Responses

Response samples

200
default

Content type

application/json

{"keyInfo": {"name": "my_api_key",
"owner": {"userId": "string",
"teamId": 0,
"organisationId": "string"
},
"active": true,
"hashed": true,
"keyPermissions": {"presets": [{"name": "my_preset",
"permissions": ["read_logs"
]
}
],
"permissions": ["string"
]
},
"value": "string",
"id": "string"
}
}

ApiKeysService_DeleteApiKey

path Parameters

keyId

required

string

Responses

Response samples

200
default

Content type

application/json

{ }

ApiKeysService_UpdateApiKey

path Parameters

keyId

required

string

Request Body schema: application/json
required

newName	string
isActive	boolean
	object (Presets) This data structure represents a set of permissions presets on an API key. Find out more about api keys
	object (Permissions) This data structure represents a set of permissions on an API key. Find out more about api keys

Responses

Request samples

Payload

Content type

application/json

{"newName": "my_new_name",
"isActive": true,
"presets": {"presets": ["string"
]
},
"permissions": {"permissions": ["string"
]
}
}

Response samples

200
default

Content type

application/json

{ }

SamlConfigurationService

SamlConfigurationService_SetActive

Request Body schema: application/json
required

This data structure is used to activate or deactivate a SAML identity provider

teamId required	integer <int64>
isActive required	boolean

Responses

Request samples

Payload

Content type

application/json

{"teamId": 0,
"isActive": true
}

Response samples

200
default

Content type

application/json

{ }

SamlConfigurationService_GetConfiguration

query Parameters

teamId

required

integer <int64>

Responses

Response samples

200
default

Content type

application/json

{"teamId": 0,
"spParameters": {"metadataUrl": "https://<...>.okta.com/app/<...>/sso/saml/metadata",
"signingCertPem": "certificate",
"nameIdFormat": "name_id",
"assertionConsumerServiceUrl": "assertion",
"binding": "binding"
},
"idpParameters": {"active": true,
"metadataUrl": "https://<...>.okta.com/app/<...>/sso/saml/metadata",
"metadataContent": "<?xml version= ...",
"teamEntityId": 1234567,
"groupNames": ["group1"
]
}
}

SamlConfigurationService_SetIDPParameters

Request Body schema: application/json
required

This data structure is used to set the parameters of a SAML identity provider

teamId required	integer <int64>
required	object (IDP Parameters) This data structure represents a set of SAML identity provider parameters Find out more about enrichments

Responses

Request samples

Payload

Content type

application/json

{"teamId": 0,
"params": {"active": true,
"metadataUrl": "https://<...>.okta.com/app/<...>/sso/saml/metadata",
"metadataContent": "<?xml version= ...",
"teamEntityId": 1234567,
"groupNames": ["group1"
]
}
}

Response samples

200
default

Content type

application/json

{ }

SamlConfigurationService_GetSPParameters

query Parameters

teamId

required

integer <int64>

Responses

Response samples

200
default

Content type

application/json

{"params": {"metadataUrl": "https://<...>.okta.com/app/<...>/sso/saml/metadata",
"signingCertPem": "certificate",
"nameIdFormat": "name_id",
"assertionConsumerServiceUrl": "assertion",
"binding": "binding"
}
}

LogsDataSourceService

LogsDataSourceService_SearchLogsAnnotationEvents

query Parameters

timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
dataprimeQuery.serialized.data	string <byte>
dataprimeQuery.raw.text	string
strategy.instant.timestampField.keypath	Array of strings
strategy.instant.timestampField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
strategy.range.startTimestampField.keypath	Array of strings
strategy.range.startTimestampField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
strategy.range.endTimestampField.keypath	Array of strings
strategy.range.endTimestampField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
strategy.duration.startTimestampField.keypath	Array of strings
strategy.duration.startTimestampField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
strategy.duration.durationField.keypath	Array of strings
strategy.duration.durationField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
limit	integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"annotationEvents": [{"instant": {"timestamp": "2019-08-24T14:15:22Z",
"labels": {"property1": "string",
"property2": "string"
},
"payload": { }
},
"range": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"labels": {"property1": "string",
"property2": "string"
},
"payload": { }
}
}
]
}

LogsDataSourceService_SearchLogsEventGroups

query Parameters

timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
luceneQuery	string
groupBy	Array of strings
pagination.offset	integer <int32>
pagination.limit	integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"groups": [{"fields": [{"name": "string",
"value": "string"
}
],
"values": [0.1
]
}
]
}

LogsDataSourceService_SearchLogsEvents

query Parameters

timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
luceneQuery	string
pagination.offset	integer <int32>
pagination.limit	integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"total": "string",
"events": [{"logId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"text": "string",
"json": { },
"logsMetadata": {"applicationName": "string",
"subsystemName": "string",
"severity": "LOG_SEVERITY_LEVEL_UNSPECIFIED"
}
}
]
}

LogsDataSourceService_SearchGroupedLogsSeries

query Parameters

timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
groupByFields	Array of strings
aggregation.countDistinct.field	string
aggregation.countDistinct.observationField.keypath	Array of strings
aggregation.countDistinct.observationField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
aggregation.sum.field	string
aggregation.sum.observationField.keypath	Array of strings
aggregation.sum.observationField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
aggregation.average.field	string
aggregation.average.observationField.keypath	Array of strings
aggregation.average.observationField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
aggregation.min.field	string
aggregation.min.observationField.keypath	Array of strings
aggregation.min.observationField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
aggregation.max.field	string
aggregation.max.observationField.keypath	Array of strings
aggregation.max.observationField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
aggregation.percentile.field	string
aggregation.percentile.percent	number <double> Value in range (0, 100]
aggregation.percentile.observationField.keypath	Array of strings
aggregation.percentile.observationField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
luceneQuery	string

Responses

Response samples

200
default

Content type

application/json

{"series": [{"groups": [{"field": {"name": "string",
"value": "string"
},
"value": 0.1,
"groups": [{ }
]
}
]
}
]
}

LogsDataSourceService_SearchLogsGroupedTimeSeries

query Parameters

timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
interval	string
aggregation.countDistinct.field	string
aggregation.countDistinct.observationField.keypath	Array of strings
aggregation.countDistinct.observationField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
aggregation.sum.field	string
aggregation.sum.observationField.keypath	Array of strings
aggregation.sum.observationField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
aggregation.average.field	string
aggregation.average.observationField.keypath	Array of strings
aggregation.average.observationField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
aggregation.min.field	string
aggregation.min.observationField.keypath	Array of strings
aggregation.min.observationField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
aggregation.max.field	string
aggregation.max.observationField.keypath	Array of strings
aggregation.max.observationField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
aggregation.percentile.field	string
aggregation.percentile.percent	number <double> Value in range (0, 100]
aggregation.percentile.observationField.keypath	Array of strings
aggregation.percentile.observationField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
luceneQuery	string

Responses

Response samples

200
default

Content type

application/json

{"series": [{"groups": [{"field": {"name": "string",
"value": "string"
},
"value": 0.1,
"groups": [{ }
]
}
]
}
]
}

LogsDataSourceService_SearchLogsGroupedValues

query Parameters

timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
luceneQuery	string
groupBy	Array of strings
aggregation.countDistinct.field	string
aggregation.countDistinct.observationField.keypath	Array of strings
aggregation.countDistinct.observationField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
aggregation.sum.field	string
aggregation.sum.observationField.keypath	Array of strings
aggregation.sum.observationField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
aggregation.average.field	string
aggregation.average.observationField.keypath	Array of strings
aggregation.average.observationField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
aggregation.min.field	string
aggregation.min.observationField.keypath	Array of strings
aggregation.min.observationField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
aggregation.max.field	string
aggregation.max.observationField.keypath	Array of strings
aggregation.max.observationField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
aggregation.percentile.field	string
aggregation.percentile.percent	number <double> Value in range (0, 100]
aggregation.percentile.observationField.keypath	Array of strings
aggregation.percentile.observationField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
limit	integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"groups": [{"field": {"name": "string",
"value": "string"
},
"value": 0.1,
"groups": [{ }
]
}
],
"isLimitExceeded": true,
"total": "string"
}

LogsDataSourceService_SearchLogsTimeSeries

query Parameters

timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
interval	string
groupBy	Array of strings
limit	integer <int32>
luceneQuery	string

Responses

Response samples

200
default

Content type

application/json

{"timeSeries": [{"name": "string",
"values": [{"timestamp": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"labels": {"property1": "string",
"property2": "string"
}
}
],
"total": "string"
}

DashboardsService

DashboardsService_CreateDashboard

Request Body schema: application/json
required

requestId	string
	object (astDashboard) Dashboard represents the structure and configuration of a Coralogix Custom Dashboard.

Responses

Request samples

Payload

Content type

application/json

{"requestId": "string",
"dashboard": {"id": "string",
"name": "string",
"description": "string",
"layout": {"sections": [{"id": {"value": "string"
},
"rows": [{"id": {"value": "string"
},
"appearance": {"height": 0
},
"widgets": [{"id": {"value": null
},
"title": "string",
"description": "string",
"definition": {"lineChart": null,
"dataTable": null,
"gauge": null,
"pieChart": null,
"barChart": null,
"horizontalBarChart": null,
"markdown": null,
"hexagon": null
},
"appearance": {"width": null
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
],
"options": {"internal": { },
"custom": {"name": "string",
"description": "string",
"collapsed": true,
"color": {"predefined": "SECTION_PREDEFINED_COLOR_UNSPECIFIED"
}
}
}
}
]
},
"variables": [{"name": "string",
"definition": {"constant": {"value": "string"
},
"multiSelect": {"selected": ["string"
],
"source": {"logsPath": {"value": "string",
"observationField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
},
"metricLabel": {"metricName": "string",
"label": "string"
},
"constantList": {"values": ["string"
]
},
"spanField": {"value": {"metadataField": "METADATA_FIELD_UNSPECIFIED",
"tagField": "string",
"processTagField": "string"
}
},
"query": {"query": {"logsQuery": {"type": null
},
"metricsQuery": {"type": null
},
"spansQuery": {"type": null
}
},
"refreshStrategy": "REFRESH_STRATEGY_UNSPECIFIED",
"valueDisplayOptions": {"valueRegex": "string",
"labelRegex": "string"
}
}
},
"selection": {"all": { },
"list": {"values": ["string"
],
"labels": ["string"
]
}
},
"valuesOrderDirection": "ORDER_DIRECTION_UNSPECIFIED",
"selectionOptions": {"selectionType": "SELECTION_TYPE_UNSPECIFIED"
}
}
},
"displayName": "string",
"description": "string",
"displayType": "VARIABLE_DISPLAY_TYPE_UNSPECIFIED"
}
],
"filters": [{"source": {"logs": {"field": "string",
"operator": {"equals": {"selection": {"all": { },
"list": {"values": [ ]
}
}
},
"notEquals": {"selection": {"list": {"values": [ ]
}
}
}
},
"observationField": {"keypath": ["string"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
},
"spans": {"field": {"metadataField": "METADATA_FIELD_UNSPECIFIED",
"tagField": "string",
"processTagField": "string"
},
"operator": {"equals": {"selection": {"all": { },
"list": {"values": [ ]
}
}
},
"notEquals": {"selection": {"list": {"values": [ ]
}
}
}
}
},
"metrics": {"metric": "string",
"label": "string",
"operator": {"equals": {"selection": {"all": { },
"list": {"values": [ ]
}
}
},
"notEquals": {"selection": {"list": {"values": [ ]
}
}
}
}
}
},
"enabled": true,
"collapsed": true
}
],
"absoluteTimeFrame": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
},
"relativeTimeFrame": "string",
"folderId": {"value": "string"
},
"folderPath": {"segments": ["string"
]
},
"annotations": [{"id": "string",
"name": "string",
"enabled": true,
"source": {"metrics": {"promqlQuery": {"value": "string"
},
"strategy": {"startTimeMetric": { }
},
"messageTemplate": "string",
"labels": ["string"
]
},
"logs": {"luceneQuery": {"value": "string"
},
"strategy": {"instant": {"timestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
},
"range": {"startTimestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"endTimestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
},
"duration": {"startTimestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"durationField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
},
"messageTemplate": "string",
"labelFields": [{"keypath": ["string"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
]
},
"spans": {"luceneQuery": {"value": "string"
},
"strategy": {"instant": {"timestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
},
"range": {"startTimestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"endTimestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
},
"duration": {"startTimestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"durationField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
},
"messageTemplate": "string",
"labelFields": [{"keypath": ["string"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
]
}
}
}
],
"off": { },
"twoMinutes": { },
"fiveMinutes": { }
}
}

Response samples

200
default

Content type

application/json

{"dashboardId": "string"
}

DashboardsService_ReplaceDashboard

Request Body schema: application/json
required

requestId	string
	object (astDashboard) Dashboard represents the structure and configuration of a Coralogix Custom Dashboard.

Responses

Request samples

Payload

Content type

application/json

{"requestId": "string",
"dashboard": {"id": "string",
"name": "string",
"description": "string",
"layout": {"sections": [{"id": {"value": "string"
},
"rows": [{"id": {"value": "string"
},
"appearance": {"height": 0
},
"widgets": [{"id": {"value": null
},
"title": "string",
"description": "string",
"definition": {"lineChart": null,
"dataTable": null,
"gauge": null,
"pieChart": null,
"barChart": null,
"horizontalBarChart": null,
"markdown": null,
"hexagon": null
},
"appearance": {"width": null
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
],
"options": {"internal": { },
"custom": {"name": "string",
"description": "string",
"collapsed": true,
"color": {"predefined": "SECTION_PREDEFINED_COLOR_UNSPECIFIED"
}
}
}
}
]
},
"variables": [{"name": "string",
"definition": {"constant": {"value": "string"
},
"multiSelect": {"selected": ["string"
],
"source": {"logsPath": {"value": "string",
"observationField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
},
"metricLabel": {"metricName": "string",
"label": "string"
},
"constantList": {"values": ["string"
]
},
"spanField": {"value": {"metadataField": "METADATA_FIELD_UNSPECIFIED",
"tagField": "string",
"processTagField": "string"
}
},
"query": {"query": {"logsQuery": {"type": null
},
"metricsQuery": {"type": null
},
"spansQuery": {"type": null
}
},
"refreshStrategy": "REFRESH_STRATEGY_UNSPECIFIED",
"valueDisplayOptions": {"valueRegex": "string",
"labelRegex": "string"
}
}
},
"selection": {"all": { },
"list": {"values": ["string"
],
"labels": ["string"
]
}
},
"valuesOrderDirection": "ORDER_DIRECTION_UNSPECIFIED",
"selectionOptions": {"selectionType": "SELECTION_TYPE_UNSPECIFIED"
}
}
},
"displayName": "string",
"description": "string",
"displayType": "VARIABLE_DISPLAY_TYPE_UNSPECIFIED"
}
],
"filters": [{"source": {"logs": {"field": "string",
"operator": {"equals": {"selection": {"all": { },
"list": {"values": [ ]
}
}
},
"notEquals": {"selection": {"list": {"values": [ ]
}
}
}
},
"observationField": {"keypath": ["string"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
},
"spans": {"field": {"metadataField": "METADATA_FIELD_UNSPECIFIED",
"tagField": "string",
"processTagField": "string"
},
"operator": {"equals": {"selection": {"all": { },
"list": {"values": [ ]
}
}
},
"notEquals": {"selection": {"list": {"values": [ ]
}
}
}
}
},
"metrics": {"metric": "string",
"label": "string",
"operator": {"equals": {"selection": {"all": { },
"list": {"values": [ ]
}
}
},
"notEquals": {"selection": {"list": {"values": [ ]
}
}
}
}
}
},
"enabled": true,
"collapsed": true
}
],
"absoluteTimeFrame": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
},
"relativeTimeFrame": "string",
"folderId": {"value": "string"
},
"folderPath": {"segments": ["string"
]
},
"annotations": [{"id": "string",
"name": "string",
"enabled": true,
"source": {"metrics": {"promqlQuery": {"value": "string"
},
"strategy": {"startTimeMetric": { }
},
"messageTemplate": "string",
"labels": ["string"
]
},
"logs": {"luceneQuery": {"value": "string"
},
"strategy": {"instant": {"timestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
},
"range": {"startTimestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"endTimestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
},
"duration": {"startTimestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"durationField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
},
"messageTemplate": "string",
"labelFields": [{"keypath": ["string"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
]
},
"spans": {"luceneQuery": {"value": "string"
},
"strategy": {"instant": {"timestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
},
"range": {"startTimestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"endTimestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
},
"duration": {"startTimestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"durationField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
},
"messageTemplate": "string",
"labelFields": [{"keypath": ["string"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
]
}
}
}
],
"off": { },
"twoMinutes": { },
"fiveMinutes": { }
}
}

Response samples

200
default

Content type

application/json

{ }

DashboardsService_GetDashboard

path Parameters

dashboardId

required

string

Responses

Response samples

200
default

Content type

application/json

{"dashboard": {"id": "string",
"name": "string",
"description": "string",
"layout": {"sections": [{"id": {"value": "string"
},
"rows": [{"id": {"value": "string"
},
"appearance": {"height": 0
},
"widgets": [{"id": {"value": null
},
"title": "string",
"description": "string",
"definition": {"lineChart": null,
"dataTable": null,
"gauge": null,
"pieChart": null,
"barChart": null,
"horizontalBarChart": null,
"markdown": null,
"hexagon": null
},
"appearance": {"width": null
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
],
"options": {"internal": { },
"custom": {"name": "string",
"description": "string",
"collapsed": true,
"color": {"predefined": "SECTION_PREDEFINED_COLOR_UNSPECIFIED"
}
}
}
}
]
},
"variables": [{"name": "string",
"definition": {"constant": {"value": "string"
},
"multiSelect": {"selected": ["string"
],
"source": {"logsPath": {"value": "string",
"observationField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
},
"metricLabel": {"metricName": "string",
"label": "string"
},
"constantList": {"values": ["string"
]
},
"spanField": {"value": {"metadataField": "METADATA_FIELD_UNSPECIFIED",
"tagField": "string",
"processTagField": "string"
}
},
"query": {"query": {"logsQuery": {"type": null
},
"metricsQuery": {"type": null
},
"spansQuery": {"type": null
}
},
"refreshStrategy": "REFRESH_STRATEGY_UNSPECIFIED",
"valueDisplayOptions": {"valueRegex": "string",
"labelRegex": "string"
}
}
},
"selection": {"all": { },
"list": {"values": ["string"
],
"labels": ["string"
]
}
},
"valuesOrderDirection": "ORDER_DIRECTION_UNSPECIFIED",
"selectionOptions": {"selectionType": "SELECTION_TYPE_UNSPECIFIED"
}
}
},
"displayName": "string",
"description": "string",
"displayType": "VARIABLE_DISPLAY_TYPE_UNSPECIFIED"
}
],
"filters": [{"source": {"logs": {"field": "string",
"operator": {"equals": {"selection": {"all": { },
"list": {"values": [ ]
}
}
},
"notEquals": {"selection": {"list": {"values": [ ]
}
}
}
},
"observationField": {"keypath": ["string"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
},
"spans": {"field": {"metadataField": "METADATA_FIELD_UNSPECIFIED",
"tagField": "string",
"processTagField": "string"
},
"operator": {"equals": {"selection": {"all": { },
"list": {"values": [ ]
}
}
},
"notEquals": {"selection": {"list": {"values": [ ]
}
}
}
}
},
"metrics": {"metric": "string",
"label": "string",
"operator": {"equals": {"selection": {"all": { },
"list": {"values": [ ]
}
}
},
"notEquals": {"selection": {"list": {"values": [ ]
}
}
}
}
}
},
"enabled": true,
"collapsed": true
}
],
"absoluteTimeFrame": {"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z"
},
"relativeTimeFrame": "string",
"folderId": {"value": "string"
},
"folderPath": {"segments": ["string"
]
},
"annotations": [{"id": "string",
"name": "string",
"enabled": true,
"source": {"metrics": {"promqlQuery": {"value": "string"
},
"strategy": {"startTimeMetric": { }
},
"messageTemplate": "string",
"labels": ["string"
]
},
"logs": {"luceneQuery": {"value": "string"
},
"strategy": {"instant": {"timestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
},
"range": {"startTimestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"endTimestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
},
"duration": {"startTimestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"durationField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
},
"messageTemplate": "string",
"labelFields": [{"keypath": ["string"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
]
},
"spans": {"luceneQuery": {"value": "string"
},
"strategy": {"instant": {"timestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
},
"range": {"startTimestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"endTimestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
},
"duration": {"startTimestampField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
},
"durationField": {"keypath": [null
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
}
},
"messageTemplate": "string",
"labelFields": [{"keypath": ["string"
],
"scope": "DATASET_SCOPE_UNSPECIFIED"
}
]
}
}
}
],
"off": { },
"twoMinutes": { },
"fiveMinutes": { }
},
"updatedAt": "2019-08-24T14:15:22Z"
}

DashboardsService_DeleteDashboard

path Parameters

dashboardId

required

string

query Parameters

requestId

string

Responses

Response samples

200
default

Content type

application/json

{ }

DashboardsService_ReplaceDefaultDashboard

path Parameters

dashboardId

required

string

Request Body schema: application/json
required

requestId

string

Responses

Request samples

Payload

Content type

application/json

{"requestId": "string"
}

Response samples

200
default

Content type

application/json

{ }

DashboardsService_AssignDashboardFolder

path Parameters

dashboardId

required

string

Request Body schema: application/json
required

requestId	string
folderId	string (could be null to assign the dashboard to root)

Responses

Request samples

Payload

Content type

application/json

{"requestId": "string",
"folderId": "string"
}

Response samples

200
default

Content type

application/json

{ }

DashboardsService_PinDashboard

path Parameters

dashboardId

required

string

Request Body schema: application/json
required

requestId

string

Responses

Request samples

Payload

Content type

application/json

{"requestId": "string"
}

Response samples

200
default

Content type

application/json

{ }

DashboardsService_UnpinDashboard

path Parameters

dashboardId

required

string

Request Body schema: application/json
required

requestId

string

Responses

Request samples

Payload

Content type

application/json

{"requestId": "string"
}

Response samples

200
default

Content type

application/json

{ }

MetricsDataSourceService

MetricsDataSourceService_SearchMetricsAnnotationEvents

query Parameters

timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
interval	string
promqlQuery	string
limit	integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"annotationEvents": [{"instant": {"timestamp": "2019-08-24T14:15:22Z",
"labels": {"property1": "string",
"property2": "string"
},
"payload": { }
},
"range": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"labels": {"property1": "string",
"property2": "string"
},
"payload": { }
}
}
]
}

MetricsDataSourceService_SearchMetricsEvents

query Parameters

timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
timeSeriesInterval	string
promqlQuery	string
pagination.offset	integer <int32>
pagination.limit	integer <int32>
orderBy.direction	string Default: "ORDER_DIRECTION_UNSPECIFIED" Enum: "ORDER_DIRECTION_UNSPECIFIED" "ORDER_DIRECTION_ASC" "ORDER_DIRECTION_DESC"
orderBy.label	string
orderBy.aggType	string Default: "AGGREGATION_TYPE_UNSPECIFIED" Enum: "AGGREGATION_TYPE_UNSPECIFIED" "AGGREGATION_TYPE_LAST" "AGGREGATION_TYPE_MIN" "AGGREGATION_TYPE_MAX" "AGGREGATION_TYPE_AVG" "AGGREGATION_TYPE_SUM"

Responses

Response samples

200
default

Content type

application/json

{"labels": ["string"
],
"metricsEvents": [{"aggregations": [{"aggregationType": "AGGREGATION_TYPE_UNSPECIFIED",
"value": 0.1
}
],
"timeSeries": {"name": "string",
"values": [{"timestamp": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"labels": {"property1": "string",
"property2": "string"
}
}
}
],
"total": "string"
}

MetricsDataSourceService_SearchMetricsGroupedSeries

query Parameters

timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
promqlQuery	string
groupBy	Array of strings

Responses

Response samples

200
default

Content type

application/json

{"series": [{"groups": [{"field": {"name": "string",
"value": "string"
},
"value": 0.1,
"groups": [{ }
]
}
]
}
]
}

MetricsDataSourceService_SearchMetricsGroupedTimeSeries

query Parameters

timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
interval	string
promqlQuery	string

Responses

Response samples

200
default

Content type

application/json

{"series": [{"groups": [{"field": {"name": "string",
"value": "string"
},
"value": 0.1,
"groups": [{ }
]
}
]
}
]
}

MetricsDataSourceService_SearchMetricsGroupedValues

query Parameters

timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
promqlQuery	string
groupBy	Array of strings
limit	integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"groups": [{"field": {"name": "string",
"value": "string"
},
"value": 0.1,
"groups": [{ }
]
}
],
"isLimitExceeded": true,
"total": "string"
}

MetricsDataSourceService_SearchMetricsTimeSeries

query Parameters

timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
interval	string
promqlQuery	string
limit	integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"timeSeries": [{"name": "string",
"values": [{"timestamp": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"labels": {"property1": "string",
"property2": "string"
}
}
],
"total": "string"
}

MetricsDataSourceService_SearchMetricsTimeValues

query Parameters

timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
promqlQuery	string
limit	integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"values": [{"name": "string",
"labels": {"property1": "string",
"property2": "string"
},
"value": 0.1
}
],
"isLimitExceeded": true,
"total": "string"
}

ArchiveLogsDataSourceService

ArchiveLogsDataSourceService_SearchArchiveLogsEventGroups

query Parameters

widgetId	string
timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
requestParamsHash	string
query.data	string <byte>
queryRaw.text	string
groupByKeys	Array of strings
aggregationKeys	Array of strings
pagination.offset	integer <int32>
pagination.limit	integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"groups": [{"fields": [{"name": "string",
"value": "string"
}
],
"values": [0.1
]
}
]
}

ArchiveLogsDataSourceService_SearchArchiveLogsEvents

query Parameters

widgetId	string
timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
pagination.offset	integer <int32>
pagination.limit	integer <int32>
requestParamsHash	string
query.data	string <byte>
queryRaw.text	string

Responses

Response samples

200
default

Content type

application/json

{"events": [{"timestamp": "2019-08-24T14:15:22Z",
"metadata": {"property1": "string",
"property2": "string"
},
"labels": {"property1": "string",
"property2": "string"
},
"userData": { }
}
],
"totalFetched": 0
}

ArchiveLogsDataSourceService_SearchArchiveLogsEventsCount

query Parameters

widgetId	string
timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
requestParamsHash	string
query.data	string <byte>
queryRaw.text	string

Responses

Response samples

200
default

Content type

application/json

{"count": "string"
}

ArchiveLogsDataSourceService_SearchArchiveGroupedLogsSeries

query Parameters

widgetId	string
timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
requestParamsHash	string
query.data	string <byte>
queryRaw.text	string
groupByKeys	Array of strings Have to be ordered for correctly structured results.
aggregationKey	string

Responses

Response samples

200
default

Content type

application/json

{"series": [{"groups": [{"field": {"name": "string",
"value": "string"
},
"value": 0.1,
"groups": [{ }
]
}
]
}
],
"meta": {"property1": "string",
"property2": "string"
}
}

ArchiveLogsDataSourceService_SearchArchiveGroupedLogsTimeSeries

query Parameters

widgetId	string
timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
requestParamsHash	string
query.data	string <byte>
queryRaw.text	string
groupByKeys	Array of strings Expects up to 1 element for now, without `timestamp`.
aggregationKey	string

Responses

Response samples

200
default

Content type

application/json

{"series": {"groups": [{"field": {"name": "string",
"value": "string"
},
"value": 0.1,
"groups": [{ }
]
}
]
},
"meta": {"property1": "string",
"property2": "string"
}
}

ArchiveLogsDataSourceService_SearchArchiveLogsGroupedValues

query Parameters

widgetId	string
timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
requestParamsHash	string
query.data	string <byte>
queryRaw.text	string
groupByKeys	Array of strings
aggregationKey	string
limit	integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"groups": [{"field": {"name": "string",
"value": "string"
},
"value": 0.1,
"groups": [{ }
]
}
],
"isLimitExceeded": true,
"total": "string",
"meta": {"property1": "string",
"property2": "string"
}
}

ArchiveLogsDataSourceService_SearchArchiveLogsTimeSeries

query Parameters

widgetId	string
timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
limit	integer <int32>
requestParamsHash	string
query.data	string <byte>
queryRaw.text	string
aggregationKeys	Array of strings

Responses

Response samples

200
default

Content type

application/json

{"timeSeries": [{"name": "string",
"values": [{"timestamp": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"labels": {"property1": "string",
"property2": "string"
}
}
],
"total": "string"
}

DashboardCatalogService

DashboardCatalogService_GetDashboardCatalog

Responses

Response samples

200
default

Content type

application/json

{"items": [{"id": "string",
"name": "string",
"description": "string",
"isDefault": true,
"isPinned": true,
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"folder": {"id": "string",
"name": "string",
"parentId": "string"
}
}
]
}

ArchiveSpansDataSourceService

ArchiveSpansDataSourceService_SearchArchiveSpansEventGroups

query Parameters

widgetId	string
timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
requestParamsHash	string
query.data	string <byte>
queryRaw.text	string
groupByKeys	Array of strings
aggregationKeys	Array of strings
pagination.offset	integer <int32>
pagination.limit	integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"groups": [{"fields": [{"name": "string",
"value": "string"
}
],
"values": [0.1
]
}
]
}

ArchiveSpansDataSourceService_SearchArchiveSpansEvents

query Parameters

widgetId	string
timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
pagination.offset	integer <int32>
pagination.limit	integer <int32>
requestParamsHash	string
query.data	string <byte>
queryRaw.text	string

Responses

Response samples

200
default

Content type

application/json

{"events": [{"spanId": "string",
"traceId": "string",
"parentSpanId": "string",
"metadata": {"applicationName": "string",
"subsystemName": "string",
"serviceName": "string",
"operationName": "string"
},
"startTime": "2019-08-24T14:15:22Z",
"duration": "string",
"tags": [{"key": "string",
"value": "string"
}
],
"processTags": [{"key": "string",
"value": "string"
}
],
"logs": [{"timestamp": "2019-08-24T14:15:22Z",
"fields": {"property1": "string",
"property2": "string"
}
}
]
}
],
"totalFetched": 0
}

ArchiveSpansDataSourceService_SearchArchiveSpansEventsCount

query Parameters

widgetId	string
timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
requestParamsHash	string
query.data	string <byte>
queryRaw.text	string

Responses

Response samples

200
default

Content type

application/json

{"count": "string"
}

ArchiveSpansDataSourceService_SearchArchiveGroupedSpansSeries

query Parameters

widgetId	string
timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
requestParamsHash	string
query.data	string <byte>
queryRaw.text	string
groupByKeys	Array of strings Have to be ordered for correctly structured results.
aggregationKey	string

Responses

Response samples

200
default

Content type

application/json

{"series": [{"groups": [{"field": {"name": "string",
"value": "string"
},
"value": 0.1,
"groups": [{ }
]
}
]
}
],
"meta": {"property1": "string",
"property2": "string"
}
}

ArchiveSpansDataSourceService_SearchArchiveGroupedSpansTimeSeries

query Parameters

widgetId	string
timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
requestParamsHash	string
query.data	string <byte>
queryRaw.text	string
groupByKeys	Array of strings Expects up to 1 element for now, without `timestamp`.
aggregationKey	string

Responses

Response samples

200
default

Content type

application/json

{"series": {"groups": [{"field": {"name": "string",
"value": "string"
},
"value": 0.1,
"groups": [{ }
]
}
]
},
"meta": {"property1": "string",
"property2": "string"
}
}

ArchiveSpansDataSourceService_SearchArchiveSpansGroupedValues

query Parameters

widgetId	string
timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
requestParamsHash	string
query.data	string <byte>
queryRaw.text	string
groupByKeys	Array of strings
aggregationKeys	string
limit	integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"groups": [{"field": {"name": "string",
"value": "string"
},
"value": 0.1,
"groups": [{ }
]
}
],
"isLimitExceeded": true,
"total": "string",
"meta": {"property1": "string",
"property2": "string"
}
}

ArchiveSpansDataSourceService_SearchArchiveSpansTimeSeries

query Parameters

widgetId	string
timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
limit	integer <int32>
requestParamsHash	string
query.data	string <byte>
queryRaw.text	string
aggregationKeys	Array of strings

Responses

Response samples

200
default

Content type

application/json

{"timeSeries": [{"name": "string",
"values": [{"timestamp": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"labels": {"property1": "string",
"property2": "string"
}
}
],
"total": "string"
}

DataprimeDataSourceService

DataprimeDataSourceService_SearchDataprime

query Parameters

dataprimeQuery.data	string <byte>
dataprimeQueryRaw.text	string
timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
limit	integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"results": [{"metadata": [{"key": "string",
"value": "string"
}
],
"labels": [{"key": "string",
"value": "string"
}
],
"userData": "string"
}
]
}

DataprimeDataSourceService_SearchDataprimeArchive

query Parameters

dataprimeQuery.data	string <byte>
dataprimeQueryRaw.text	string
timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
limit	integer <int32>
widgetId	string

Responses

Response samples

200
default

Content type

application/json

{"results": [{"metadata": [{"key": "string",
"value": "string"
}
],
"labels": [{"key": "string",
"value": "string"
}
],
"userData": "string"
}
],
"meta": {"property1": "string",
"property2": "string"
}
}

DashboardFoldersService

DashboardFoldersService_ListDashboardFolders

Responses

Response samples

200
default

Content type

application/json

{"folder": [{"id": "string",
"name": "string",
"parentId": "string"
}
]
}

DashboardFoldersService_CreateDashboardFolder

Request Body schema: application/json
required

requestId	string
	object (commonDashboardFolder)

Responses

Request samples

Payload

Content type

application/json

{"requestId": "string",
"folder": {"id": "string",
"name": "string",
"parentId": "string"
}
}

Response samples

200
default

Content type

application/json

{ }

DashboardFoldersService_ReplaceDashboardFolder

Request Body schema: application/json
required

requestId	string
	object (commonDashboardFolder)

Responses

Request samples

Payload

Content type

application/json

{"requestId": "string",
"folder": {"id": "string",
"name": "string",
"parentId": "string"
}
}

Response samples

200
default

Content type

application/json

{ }

DashboardFoldersService_GetDashboardFolder

path Parameters

folderId

required

string

query Parameters

requestId

string

Responses

Response samples

200
default

Content type

application/json

{"folder": {"id": "string",
"name": "string",
"parentId": "string"
}
}

DashboardFoldersService_DeleteDashboardFolder

path Parameters

folderId

required

string

query Parameters

requestId

string

Responses

Response samples

200
default

Content type

application/json

{ }

SpansDataSourceService

SpansDataSourceService_SearchSpansAnnotationEvents

query Parameters

timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
luceneQuery	string
strategy.instant.timestampField.keypath	Array of strings
strategy.instant.timestampField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
strategy.range.startTimestampField.keypath	Array of strings
strategy.range.startTimestampField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
strategy.range.endTimestampField.keypath	Array of strings
strategy.range.endTimestampField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
strategy.duration.startTimestampField.keypath	Array of strings
strategy.duration.startTimestampField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
strategy.duration.durationField.keypath	Array of strings
strategy.duration.durationField.scope	string Default: "DATASET_SCOPE_UNSPECIFIED" Enum: "DATASET_SCOPE_UNSPECIFIED" "DATASET_SCOPE_USER_DATA" "DATASET_SCOPE_LABEL" "DATASET_SCOPE_METADATA"
limit	integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"annotationEvents": [{"instant": {"timestamp": "2019-08-24T14:15:22Z",
"labels": {"property1": "string",
"property2": "string"
},
"payload": { }
},
"range": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"labels": {"property1": "string",
"property2": "string"
},
"payload": { }
}
}
]
}

SpansDataSourceService_SearchSpansEventGroups

query Parameters

timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
luceneQuery	string
pagination.offset	integer <int32>
pagination.limit	integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"groups": [{"fields": [{"name": "string",
"value": "string"
}
],
"values": [0.1
]
}
]
}

SpansDataSourceService_SearchSpansEvents

query Parameters

timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
luceneQuery	string
pagination.offset	integer <int32>
pagination.limit	integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"total": "string",
"spansEvents": [{"spanId": "string",
"traceId": "string",
"parentSpanId": "string",
"metadata": {"applicationName": "string",
"subsystemName": "string",
"serviceName": "string",
"operationName": "string"
},
"startTime": "2019-08-24T14:15:22Z",
"duration": "string",
"tags": [{"key": "string",
"value": "string"
}
],
"processTags": [{"key": "string",
"value": "string"
}
],
"logs": [{"timestamp": "2019-08-24T14:15:22Z",
"fields": {"property1": "string",
"property2": "string"
}
}
]
}
]
}

SpansDataSourceService_SearchGroupedSpansSeries

query Parameters

timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
aggregation.metricAggregation.metricField	string Default: "METRIC_FIELD_UNSPECIFIED" Enum: "METRIC_FIELD_UNSPECIFIED" "METRIC_FIELD_DURATION"
aggregation.metricAggregation.aggregationType	string Default: "METRIC_AGGREGATION_TYPE_UNSPECIFIED" Enum: "METRIC_AGGREGATION_TYPE_UNSPECIFIED" "METRIC_AGGREGATION_TYPE_MIN" "METRIC_AGGREGATION_TYPE_MAX" "METRIC_AGGREGATION_TYPE_AVERAGE" "METRIC_AGGREGATION_TYPE_SUM" "METRIC_AGGREGATION_TYPE_PERCENTILE_99" "METRIC_AGGREGATION_TYPE_PERCENTILE_95" "METRIC_AGGREGATION_TYPE_PERCENTILE_50"
aggregation.dimensionAggregation.dimensionField	string Default: "DIMENSION_FIELD_UNSPECIFIED" Enum: "DIMENSION_FIELD_UNSPECIFIED" "DIMENSION_FIELD_TRACE_ID"
aggregation.dimensionAggregation.aggregationType	string Default: "DIMENSION_AGGREGATION_TYPE_UNSPECIFIED" Enum: "DIMENSION_AGGREGATION_TYPE_UNSPECIFIED" "DIMENSION_AGGREGATION_TYPE_UNIQUE_COUNT" "DIMENSION_AGGREGATION_TYPE_ERROR_COUNT"
luceneQuery	string

Responses

Response samples

200
default

Content type

application/json

{"series": [{"groups": [{"field": {"name": "string",
"value": "string"
},
"value": 0.1,
"groups": [{ }
]
}
]
}
]
}

SpansDataSourceService_SearchSpansGroupedTimeSeries

query Parameters

timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
interval	string
aggregation.metricAggregation.metricField	string Default: "METRIC_FIELD_UNSPECIFIED" Enum: "METRIC_FIELD_UNSPECIFIED" "METRIC_FIELD_DURATION"
aggregation.metricAggregation.aggregationType	string Default: "METRIC_AGGREGATION_TYPE_UNSPECIFIED" Enum: "METRIC_AGGREGATION_TYPE_UNSPECIFIED" "METRIC_AGGREGATION_TYPE_MIN" "METRIC_AGGREGATION_TYPE_MAX" "METRIC_AGGREGATION_TYPE_AVERAGE" "METRIC_AGGREGATION_TYPE_SUM" "METRIC_AGGREGATION_TYPE_PERCENTILE_99" "METRIC_AGGREGATION_TYPE_PERCENTILE_95" "METRIC_AGGREGATION_TYPE_PERCENTILE_50"
aggregation.dimensionAggregation.dimensionField	string Default: "DIMENSION_FIELD_UNSPECIFIED" Enum: "DIMENSION_FIELD_UNSPECIFIED" "DIMENSION_FIELD_TRACE_ID"
aggregation.dimensionAggregation.aggregationType	string Default: "DIMENSION_AGGREGATION_TYPE_UNSPECIFIED" Enum: "DIMENSION_AGGREGATION_TYPE_UNSPECIFIED" "DIMENSION_AGGREGATION_TYPE_UNIQUE_COUNT" "DIMENSION_AGGREGATION_TYPE_ERROR_COUNT"
luceneQuery	string

Responses

Response samples

200
default

Content type

application/json

{"series": [{"groups": [{"field": {"name": "string",
"value": "string"
},
"value": 0.1,
"groups": [{ }
]
}
]
}
]
}

SpansDataSourceService_SearchSpansGroupedValues

query Parameters

timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
luceneQuery	string
aggregation.metricAggregation.metricField	string Default: "METRIC_FIELD_UNSPECIFIED" Enum: "METRIC_FIELD_UNSPECIFIED" "METRIC_FIELD_DURATION"
aggregation.metricAggregation.aggregationType	string Default: "METRIC_AGGREGATION_TYPE_UNSPECIFIED" Enum: "METRIC_AGGREGATION_TYPE_UNSPECIFIED" "METRIC_AGGREGATION_TYPE_MIN" "METRIC_AGGREGATION_TYPE_MAX" "METRIC_AGGREGATION_TYPE_AVERAGE" "METRIC_AGGREGATION_TYPE_SUM" "METRIC_AGGREGATION_TYPE_PERCENTILE_99" "METRIC_AGGREGATION_TYPE_PERCENTILE_95" "METRIC_AGGREGATION_TYPE_PERCENTILE_50"
aggregation.dimensionAggregation.dimensionField	string Default: "DIMENSION_FIELD_UNSPECIFIED" Enum: "DIMENSION_FIELD_UNSPECIFIED" "DIMENSION_FIELD_TRACE_ID"
aggregation.dimensionAggregation.aggregationType	string Default: "DIMENSION_AGGREGATION_TYPE_UNSPECIFIED" Enum: "DIMENSION_AGGREGATION_TYPE_UNSPECIFIED" "DIMENSION_AGGREGATION_TYPE_UNIQUE_COUNT" "DIMENSION_AGGREGATION_TYPE_ERROR_COUNT"
limit	integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"groups": [{"field": {"name": "string",
"value": "string"
},
"value": 0.1,
"groups": [{ }
]
}
],
"isLimitExceeded": true,
"total": "string"
}

SpansDataSourceService_SearchSpansTimeSeries

query Parameters

timeFrame.from	string <date-time>
timeFrame.to	string <date-time>
interval	string
luceneQuery	string
limit	integer <int32>

Responses

Response samples

200
default

Content type

application/json

{"timeSeries": [{"name": "string",
"values": [{"timestamp": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"labels": {"property1": "string",
"property2": "string"
}
}
],
"total": "string"
}

TeamSettingsService

TeamSettingsService_GetTeamSettings

query Parameters

requestId

string

Responses

Response samples

200
default

Content type

application/json

{"maxGroupByLogs": 0,
"maxGroupByMetrics": 0,
"maxGroupBySpans": 0,
"maxGroupByArchive": 0
}

ActionsService

ActionsService_ListActions

Responses

Response samples

200
default

Content type

application/json

{"actions": [{"id": "string",
"name": "string",
"url": "string",
"isHidden": true,
"isPrivate": true,
"sourceType": "SOURCE_TYPE_UNSPECIFIED",
"applicationNames": ["string"
],
"subsystemNames": ["string"
],
"createdBy": "string"
}
]
}

ActionsService_CreateAction

Request Body schema: application/json
required

name	string
url	string
isPrivate	boolean
sourceType	string (v2SourceType) Default: "SOURCE_TYPE_UNSPECIFIED" Enum: "SOURCE_TYPE_UNSPECIFIED" "SOURCE_TYPE_LOG" "SOURCE_TYPE_DATA_MAP"
applicationNames	Array of strings
subsystemNames	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"url": "string",
"isPrivate": true,
"sourceType": "SOURCE_TYPE_UNSPECIFIED",
"applicationNames": ["string"
],
"subsystemNames": ["string"
]
}

Response samples

200
default

Content type

application/json

{"action": {"id": "string",
"name": "string",
"url": "string",
"isHidden": true,
"isPrivate": true,
"sourceType": "SOURCE_TYPE_UNSPECIFIED",
"applicationNames": ["string"
],
"subsystemNames": ["string"
],
"createdBy": "string"
}
}

ActionsService_ReplaceAction

Request Body schema: application/json
required

object (actionsv2Action)

Responses

Request samples

Payload

Content type

application/json

{"action": {"id": "string",
"name": "string",
"url": "string",
"isHidden": true,
"isPrivate": true,
"sourceType": "SOURCE_TYPE_UNSPECIFIED",
"applicationNames": ["string"
],
"subsystemNames": ["string"
],
"createdBy": "string"
}
}

Response samples

200
default

Content type

application/json

{"action": {"id": "string",
"name": "string",
"url": "string",
"isHidden": true,
"isPrivate": true,
"sourceType": "SOURCE_TYPE_UNSPECIFIED",
"applicationNames": ["string"
],
"subsystemNames": ["string"
],
"createdBy": "string"
}
}

ActionsService_AtomicBatchExecuteActions

Request Body schema: application/json
required

Array of objects (v2ActionExecutionRequest)

Responses

Request samples

Payload

Content type

application/json

{"requests": [{"create": {"name": "string",
"url": "string",
"isPrivate": true,
"sourceType": "SOURCE_TYPE_UNSPECIFIED",
"applicationNames": ["string"
],
"subsystemNames": ["string"
]
},
"replace": {"action": {"id": "string",
"name": "string",
"url": "string",
"isHidden": true,
"isPrivate": true,
"sourceType": "SOURCE_TYPE_UNSPECIFIED",
"applicationNames": ["string"
],
"subsystemNames": ["string"
],
"createdBy": "string"
}
},
"delete": {"id": "string"
}
}
]
}

Response samples

200
default

Content type

application/json

{"matchingResponses": [{"create": {"action": {"id": "string",
"name": "string",
"url": "string",
"isHidden": true,
"isPrivate": true,
"sourceType": "SOURCE_TYPE_UNSPECIFIED",
"applicationNames": ["string"
],
"subsystemNames": ["string"
],
"createdBy": "string"
}
},
"replace": {"action": {"id": "string",
"name": "string",
"url": "string",
"isHidden": true,
"isPrivate": true,
"sourceType": "SOURCE_TYPE_UNSPECIFIED",
"applicationNames": ["string"
],
"subsystemNames": ["string"
],
"createdBy": "string"
}
},
"delete": { }
}
]
}

ActionsService_OrderActions

Request Body schema: application/json
required

	object
	object

Responses

Request samples

Payload

Content type

application/json

{"privateActionsOrder": {"property1": 0,
"property2": 0
},
"sharedActionsOrder": {"property1": 0,
"property2": 0
}
}

Response samples

200
default

Content type

application/json

{ }

ActionsService_GetAction

path Parameters

id

required

string

Responses

Response samples

200
default

Content type

application/json

{"action": {"id": "string",
"name": "string",
"url": "string",
"isHidden": true,
"isPrivate": true,
"sourceType": "SOURCE_TYPE_UNSPECIFIED",
"applicationNames": ["string"
],
"subsystemNames": ["string"
],
"createdBy": "string"
}
}

ActionsService_DeleteAction

path Parameters

id

required

string

Responses

Response samples

200
default

Content type

application/json

{ }

Folders for views

Create and manage view folders.

ViewsFoldersService_ListViewFolders

List view's folders

Responses

Response samples

200
default

Content type

application/json

{"view_folders": [{"id": "0cd4ed54-9b59-4eef-b329-151a167e2304",
"name": "My Folder"
}
]
}

ViewsFoldersService_CreateViewFolder

Create view folder

Request Body schema: application/json
required

Create view folder.

name	string (View folder name) non-empty Folder name

Responses

Request samples

Payload

Content type

application/json

{"name": "My Folder"
}

Response samples

200
default

Content type

application/json

{"id": "0cd4ed54-9b59-4eef-b329-151a167e2304",
"name": "My Folder"
}

ViewsFoldersService_ReplaceViewFolder

Replaces an existing view folder

path Parameters

folder.id

required

string <uuid>

Unique identifier for folders

Request Body schema: application/json
required

View folder

name

required

string non-empty

Folder name

Responses

Request samples

Payload

Content type

application/json

{"name": "My Folder"
}

Response samples

200
default

Content type

application/json

{"id": "0cd4ed54-9b59-4eef-b329-151a167e2304",
"name": "My Folder"
}

ViewsFoldersService_GetViewFolder

Create view folder

path Parameters

id

required

string <uuid>

Unique identifier for folders

Responses

Response samples

200
default

Content type

application/json

{"id": "0cd4ed54-9b59-4eef-b329-151a167e2304",
"name": "My Folder"
}

ViewsFoldersService_DeleteViewFolder

Deletes a view folder by ID

path Parameters

id

required

string <uuid>

Unique identifier for folders

Responses

Response samples

200
default

Content type

application/json

{ }

Views

Create and manage views.

ViewsService_ListViews

Lists all company public views

Responses

Response samples

200
default

Content type

application/json

{"views": [{"id": 52,
"name": "Logs view",
"search_query": {"query": "logs"
},
"time_selection": {"custom_selection": {"from_time": "2024-01-25T11:31:43.152Z",
"to_time": "2024-01-25T11:37:13.238Z"
}
},
"filters": {"filters": [{"name": "applicationName",
"selected_values": {"demo": true
}
},
{"name": "subsystemName",
"selected_values": {"demo": true
}
},
{"name": "operationName",
"selected_values": {"demo": true
}
},
{"name": "serviceName",
"selected_values": {"demo": true
}
},
{"name": "severity",
"selected_values": {"demo": true
}
}
]
}
}
]
}

ViewsService_CreateView

Creates a new view

Request Body schema: application/json
required

View folder.

name required	string non-empty View name
	object (SearchQuery)
required	object (Time selection)
	object (Selected filters)
folderId	string <uuid> = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... Unique identifier for folders

Responses

Request samples

Payload

Content type

application/json

{"name": "Logs view",
"searchQuery": {"query": "s"
},
"timeSelection": {"quickSelection": {"caption": "Last Hour",
"seconds": 3600
},
"customSelection": {"fromTime": "2024-01-25T11:31:43.152Z",
"toTime": "2024-01-25T11:35:43.152Z"
}
},
"filters": {"filters": [{"name": "applicationName",
"selectedValues": {"demo": true,
"cs-rest-test1": true
}
}
]
},
"folderId": "3dc02998-0b50-4ea8-b68a-4779d716fa1f"
}

Response samples

200
default

Content type

application/json

{"name": "Logs view",
"search_query": {"query": "logs"
},
"time_selection": {"custom_selection": {"from_time": "2024-01-25T11:31:43.152Z",
"to_time": "2024-01-25T11:37:13.238Z"
}
},
"filters": {"filters": [{"name": "applicationName",
"selected_values": {"demo": true
}
},
{"name": "subsystemName",
"selected_values": {"demo": true
}
},
{"name": "operationName",
"selected_values": {"demo": true
}
},
{"name": "serviceName",
"selected_values": {"demo": true
}
},
{"name": "severity",
"selected_values": {"demo": true
}
}
]
}
}

ViewsService_GetView

Gets a view by ID

path Parameters

id

required

integer <int32>

id

Responses

Response samples

200
default

Content type

application/json

{"id": 52,
"name": "Logs view",
"search_query": {"query": "logs"
},
"time_selection": {"custom_selection": {"from_time": "2024-01-25T11:31:43.152Z",
"to_time": "2024-01-25T11:37:13.238Z"
}
},
"filters": {"filters": [{"name": "applicationName",
"selected_values": {"demo": true
}
},
{"name": "subsystemName",
"selected_values": {"demo": true
}
},
{"name": "operationName",
"selected_values": {"demo": true
}
},
{"name": "serviceName",
"selected_values": {"demo": true
}
},
{"name": "severity",
"selected_values": {"demo": true
}
}
]
}
}

ViewsService_DeleteView

Deletes a view by ID

path Parameters

id

required

integer <int32>

id

Responses

Response samples

200
default

Content type

application/json

{ }

ViewsService_ReplaceView

Replaces an existing view

path Parameters

view.id

required

integer <int32>

id

Request Body schema: application/json
required

View

name required	string (View name) non-empty View name
	object (SearchQuery)
required	object (Time selection)
	object (Selected filters)
folderId	string <uuid> (View folder id) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... Unique identifier for folders

Responses

Request samples

Payload

Content type

application/json

{"name": "Logs view",
"searchQuery": {"query": "s"
},
"timeSelection": {"quickSelection": {"caption": "Last Hour",
"seconds": 3600
},
"customSelection": {"fromTime": "2024-01-25T11:31:43.152Z",
"toTime": "2024-01-25T11:35:43.152Z"
}
},
"filters": {"filters": [{"name": "applicationName",
"selectedValues": {"demo": true,
"cs-rest-test1": true
}
}
]
},
"folderId": "3dc02998-0b50-4ea8-b68a-4779d716fa1f"
}

Response samples

200
default

Content type

application/json

{"name": "Logs view",
"search_query": {"query": "logs new"
},
"time_selection": {"custom_selection": {"from_time": "2024-01-25T11:31:43.152Z",
"to_time": "2024-01-25T11:37:13.238Z"
}
},
"filters": {"filters": [{"name": "applicationName",
"selected_values": {"demo": true
}
},
{"name": "subsystemName",
"selected_values": {"demo": true
}
},
{"name": "operationName",
"selected_values": {"demo": true
}
},
{"name": "serviceName",
"selected_values": {"demo": true
}
},
{"name": "severity",
"selected_values": {"demo": true
}
}
]
}
}

MetricsTcoService

MetricsTcoService_Get

Responses

Response samples

200
default

Content type

application/json

{"rules": 1
}

MetricsTcoService_Add

Request Body schema: application/json
required

This data structure is used to add a metrics tco rule.

label required	string
regex required	string

Responses

Request samples

Payload

Content type

application/json

{"label": "rule1",
"regex": ".*"
}

Response samples

200
default

Content type

application/json

{ }

MetricsTcoService_Delete

Request Body schema: application/json
required

ruleId

string <uint64>

Responses

Request samples

Payload

Content type

application/json

{"ruleId": 1
}

Response samples

200
default

Content type

application/json

{ }

MetricsConfiguratorPublicService

MetricsConfiguratorPublicService_GetTenantConfig

Responses

Response samples

200
default

Content type

application/json

{"tenantConfig": {"tenantId": 0,
"retentionPolicy": {"rawResolution": 1,
"fiveMinutesResolution": 2,
"oneHourResolution": 3
},
"ibm": {"endpoint": "s3.us-south.cloud-object-storage.appdomain.cloud",
"crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/1234567890abcdef1234567890abcdef:12345678-1234-1234-1234-1234567890ab::",
"serviceCrn": "crn:v1:bluemix:public:cloud-object-storage:global:a/1234567890abcdef1234567890abcdef:12345678-1234-1234-1234-1234567890ab::"
},
"s3": {"bucket": "string",
"region": "string"
},
"prefix": "string",
"disabled": true
}
}

MetricsConfiguratorPublicService_ConfigureTenant

Request Body schema: application/json
required

This data structure is used to configure a tenant.

required	object (Retenion Policy Request) This data structure is used to set the retention policy for a tenant. Find out more about metrics cost optimization
	object (IBM Bucket Configuration) This data structure is used to configure an IBM bucket. Find out more about metrics cost optimization
	object (S3 Configuration) This data structure represents the S3 configuration for a tenant. Find out more about metrics cost optimization

Responses

Request samples

Payload

Content type

application/json

{"retentionPolicy": {"rawResolution": 1,
"fiveMinutesResolution": 2,
"oneHourResolution": 3
},
"ibm": {"endpoint": "s3.us-south.cloud-object-storage.appdomain.cloud",
"crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/1234567890abcdef1234567890abcdef:12345678-1234-1234-1234-1234567890ab::",
"serviceCrn": "crn:v1:bluemix:public:cloud-object-storage:global:a/1234567890abcdef1234567890abcdef:12345678-1234-1234-1234-1234567890ab::"
},
"s3": {"bucket": "string",
"region": "string"
}
}

Response samples

200
default

Content type

application/json

{ }

MetricsConfiguratorPublicService_Update

Request Body schema: application/json
required

This data structure is used to update the configuration of a tenant.

retentionDays required	integer <int64>
	object (IBM Bucket Configuration) This data structure is used to configure an IBM bucket. Find out more about metrics cost optimization
	object (S3 Configuration) This data structure represents the S3 configuration for a tenant. Find out more about metrics cost optimization

Responses

Request samples

Payload

Content type

application/json

{"retentionDays": 0,
"ibm": {"endpoint": "s3.us-south.cloud-object-storage.appdomain.cloud",
"crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/1234567890abcdef1234567890abcdef:12345678-1234-1234-1234-1234567890ab::",
"serviceCrn": "crn:v1:bluemix:public:cloud-object-storage:global:a/1234567890abcdef1234567890abcdef:12345678-1234-1234-1234-1234567890ab::"
},
"s3": {"bucket": "string",
"region": "string"
}
}

Response samples

200
default

Content type

application/json

{ }

MetricsConfiguratorPublicService_DisableArchive

Responses

Response samples

200
default

Content type

application/json

{ }

MetricsConfiguratorPublicService_EnableArchive

Responses

Response samples

200
default

Content type

application/json

{ }

MetricsConfiguratorPublicService_ValidateBucket

Request Body schema: application/json
required

This data structure is used to validate a bucket.

	object (IBM Bucket Configuration) This data structure is used to configure an IBM bucket. Find out more about metrics cost optimization
	object (S3 Configuration) This data structure represents the S3 configuration for a tenant. Find out more about metrics cost optimization

Responses

Request samples

Payload

Content type

application/json

{"ibm": {"endpoint": "s3.us-south.cloud-object-storage.appdomain.cloud",
"crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/1234567890abcdef1234567890abcdef:12345678-1234-1234-1234-1234567890ab::",
"serviceCrn": "crn:v1:bluemix:public:cloud-object-storage:global:a/1234567890abcdef1234567890abcdef:12345678-1234-1234-1234-1234567890ab::"
},
"s3": {"bucket": "string",
"region": "string"
}
}

Response samples

200
default

Content type

application/json

{ }

MetricsConfiguratorService

RetentionsService

TargetService

TargetService_GetTarget

Responses

Response samples

200
default

Content type

application/json

{"target": {"s3": {"bucket": "bucket",
"region": "us-west-2"
},
"ibmCos": {"bucketCrn": "bucket_crn",
"endpoint": "http://some.endpoint.com:8081",
"serviceCrn": "service_crn",
"bucketType": "IBM_BUCKET_TYPE_UNSPECIFIED"
},
"archiveSpec": {"archivingFormatId": "json_id",
"isActive": true,
"enableTags": true
}
}
}

TargetService_SetTarget

Request Body schema: application/json
required

This data structure is used to set a storage target for logs.

isActive required	boolean
	object (S3 Target Spec) This data structure represents an S3 target. Find out more about archives
	object (IBM COS Target Spec) This data structure represents an IBM COS target. Find out more about archives

Responses

Request samples

Payload

Content type

application/json

{"isActive": true,
"s3": {"bucket": "bucket",
"region": "us-west-2"
},
"ibmCos": {"bucketCrn": "bucket_crn",
"endpoint": "http://some.endpoint.com:8081",
"serviceCrn": "service_crn",
"bucketType": "IBM_BUCKET_TYPE_UNSPECIFIED"
}
}

Response samples

200
default

Content type

application/json

{"target": {"s3": {"bucket": "bucket",
"region": "us-west-2"
},
"ibmCos": {"bucketCrn": "bucket_crn",
"endpoint": "http://some.endpoint.com:8081",
"serviceCrn": "service_crn",
"bucketType": "IBM_BUCKET_TYPE_UNSPECIFIED"
},
"archiveSpec": {"archivingFormatId": "json_id",
"isActive": true,
"enableTags": true
}
}
}

TargetService_ValidateTarget

Request Body schema: application/json
required

This data structure is used to validate a storage target for logs.

isActive required	boolean
	object (S3 Target Spec) This data structure represents an S3 target. Find out more about archives
	object (IBM COS Target Spec) This data structure represents an IBM COS target. Find out more about archives

Responses

Request samples

Payload

Content type

application/json

{"isActive": true,
"s3": {"bucket": "bucket",
"region": "us-west-2"
},
"ibmCos": {"bucketCrn": "bucket_crn",
"endpoint": "http://some.endpoint.com:8081",
"serviceCrn": "service_crn",
"bucketType": "IBM_BUCKET_TYPE_UNSPECIFIED"
}
}

Response samples

200
default

Content type

application/json

{"isValid": true
}

InternalTargetService

DatasetLocationsService

InternalDatasetLocationsService

InternalDatasetManagementService

KafkaOutTargetService

TeamPermissionsMgmtService

EnrichmentService

EnrichmentService_GetEnrichments

Responses

Response samples

200
default

Content type

application/json

{"enrichments": [{"id": 1,
"fieldName": 1,
"enrichmentType": {"geoIp": { },
"suspiciousIp": { },
"aws": {"resourceType": "ec2"
},
"customEnrichment": {"id": 1
}
},
"enrichedFieldName": 1
}
]
}

EnrichmentService_RemoveEnrichments

query Parameters

enrichmentIds

required

Array of integers <int64> [ items <int64 > ]

Responses

Response samples

200
default

Content type

application/json

{"remainingEnrichments": [{"id": 1,
"fieldName": 1,
"enrichmentType": {"geoIp": { },
"suspiciousIp": { },
"aws": {"resourceType": "ec2"
},
"customEnrichment": {"id": 1
}
},
"enrichedFieldName": 1
}
]
}

EnrichmentService_AddEnrichments

Request Body schema: application/json
required

This response data structure represents a collection of enrichments

required

Array of objects (Enrichment Prototype)

Responses

Request samples

Payload

Content type

application/json

{"requestEnrichments": [{"fieldName": "sourceIPs",
"enrichmentType": {"geoIp": { },
"suspiciousIp": { },
"aws": {"resourceType": "ec2"
},
"customEnrichment": {"id": 1
}
},
"enrichedFieldName": "string"
}
]
}

Response samples

200
default

Content type

application/json

{"enrichments": [{"id": 1,
"fieldName": 1,
"enrichmentType": {"geoIp": { },
"suspiciousIp": { },
"aws": {"resourceType": "ec2"
},
"customEnrichment": {"id": 1
}
},
"enrichedFieldName": 1
}
]
}

EnrichmentService_GetEnrichmentLimit

Responses

Response samples

200
default

Content type

application/json

{"limit": 10,
"used": 5
}

EnrichmentService_GetCompanyEnrichmentSettings

Responses

Response samples

200
default

Content type

application/json

{"enrichmentSettings": {"enrichmentAmountLimit": 0,
"enrichmentsInUse": 0,
"sizeLimitBytes": "string",
"rowLimit": 0,
"queryOnlySizeLimitBytes": "string",
"queryOnlyRowLimit": 0
}
}

EnrichmentService_AtomicOverwriteEnrichments

Request Body schema: application/json
required

	object (v1EnrichmentType)
	Array of objects (v1EnrichmentFieldDefinition)

Responses

Request samples

Payload

Content type

application/json

{"enrichmentType": {"geoIp": { },
"suspiciousIp": { },
"aws": {"resourceType": "ec2"
},
"customEnrichment": {"id": 1
}
},
"enrichmentFields": [{"fieldName": "string",
"enrichedFieldName": "string"
}
]
}

Response samples

200
default

Content type

application/json

{"enrichments": [{"id": 1,
"fieldName": 1,
"enrichmentType": {"geoIp": { },
"suspiciousIp": { },
"aws": {"resourceType": "ec2"
},
"customEnrichment": {"id": 1
}
},
"enrichedFieldName": 1
}
]
}

google/api/http.proto (version not set)

ApiKeysService

ApiKeysService_CreateApiKey

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

ApiKeysService_GetSendDataApiKeys

Responses

Response samples

ApiKeysService_GetApiKey

path Parameters

Responses

Response samples

ApiKeysService_DeleteApiKey

path Parameters

Responses

Response samples

ApiKeysService_UpdateApiKey

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

SamlConfigurationService

SamlConfigurationService_SetActive

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

SamlConfigurationService_GetConfiguration

query Parameters

Responses

Response samples

SamlConfigurationService_SetIDPParameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

SamlConfigurationService_GetSPParameters

query Parameters

Responses

Response samples

LogsDataSourceService

LogsDataSourceService_SearchLogsAnnotationEvents

query Parameters

Responses

Response samples

LogsDataSourceService_SearchLogsEventGroups

query Parameters

Responses

Response samples

LogsDataSourceService_SearchLogsEvents

query Parameters

Responses

Response samples

LogsDataSourceService_SearchGroupedLogsSeries

query Parameters

Responses

Response samples

LogsDataSourceService_SearchLogsGroupedTimeSeries

query Parameters

Responses

Response samples

LogsDataSourceService_SearchLogsGroupedValues

query Parameters

Responses

Response samples

LogsDataSourceService_SearchLogsTimeSeries

query Parameters

Responses

Response samples

DashboardsService

DashboardsService_CreateDashboard

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

DashboardsService_ReplaceDashboard

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required