/metric/{metric_name}/bundle

Developing

GET/metric/{metric_name}/bundle

Last modified: 2 months ago

Returns a 'bundle' of metric API responses in a single call. This is intended to reduce the number of methods a client building a graph with all this information would need to make.
Currently this method returns a combination of responses from:

/metric/x/anomalysummary
/metric/x/anomalies
/metric/x/timeseries.

Request

Path Params

metric_name

string

required

Query Params

from

string

required

Timestamp. Example: 1588603852.

until

string

optional

Timestamp. Example: 1588690252.

resolution

string

optional

Resolution of results in seconds. Should be a multiple of 600. Defaults to 600 if not supplied. Used for "timeseries" response only. Example: 600.

max_graph_width

string

optional

Automatically determines the best resolution for the specified graph width. This parameter takes precedence over any value specified as "resolution". Used for "timeseries" response only. Example: 1000.

Request samples

Responses

An example Response(200)

An example Response

HTTP Code: 200

Content Type : JSONapplication/json

object {0}

{
	"status": {
		"created_timestamp": 1657045289,
		"created_string": "Tue 05 Jul 2022 @ 18:21 (UTC)",
		"duration": 0.839,
		"language": "en-gb",
		"timezone": {
			"timezone_type": 3,
			"timezone": "UTC"
		},
		"code": 200,
		"oldest_cached_component_age": 8989414,
		"session_id": "9574317bd9284de6d6d21f1cc6d128ce",
		"org_onboarding_status_id": 300,
		"api_host": "api-stage.anomify.ai",
		"user_onboarding_flags": {
			"main_intro": false,
			"alerts_intro": false,
			"alerts_from_search": false,
			"training_intro": false,
			"alert_created": true,
			"test_alert_sent": true,
			"two_alerts_sent": true,
			"pattern_trained": true
		}
	},
	"data": {
		"metric": {
			"id": 730,
			"metric": "graphite-labs_wikimedia_org.clouddb-services.clouddb1004.memory.Active",
			"total_anomalies": 157,
			"total_patterns": 29,
			"total_pattern_matches": 193,
			"created_timestamp": 1584628009,
			"created_timestamp_string": "March 19th 2020",
			"trainable": true
		},
		"anomalysummary": { ... },
		"anomalies": [ ... ],
		"timeseries": { ... }
	}
}

Last modified: 2 months ago