Get CloudWatch metric data

curl --request GET \
  --url https://api.ravion.com/aws/cloudwatch/metric \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.ravion.com/aws/cloudwatch/metric', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ravion.com/aws/cloudwatch/metric",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ravion.com/aws/cloudwatch/metric"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ravion.com/aws/cloudwatch/metric")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "datapoints": [
    {
      "timestamp": "<string>",
      "value": 123,
      "max": 123,
      "min": 123
    }
  ],
  "unit": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

GET

aws

cloudwatch

metric

Get CloudWatch metric data

curl --request GET \
  --url https://api.ravion.com/aws/cloudwatch/metric \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.ravion.com/aws/cloudwatch/metric', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ravion.com/aws/cloudwatch/metric",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ravion.com/aws/cloudwatch/metric"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ravion.com/aws/cloudwatch/metric")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "datapoints": [
    {
      "timestamp": "<string>",
      "value": 123,
      "max": 123,
      "min": 123
    }
  ],
  "unit": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "action": {
    "label": "<string>",
    "url": "<string>"
  },
  "description": "<string>",
  "details": [
    {
      "render": "<string>",
      "title": "<string>",
      "items": [
        "<string>"
      ],
      "object": {}
    }
  ],
  "isInternal": true,
  "metadata": {},
  "requestId": "<string>"
}

Query Parameters

awsAccountId

string

required

AWS account database ID used to resolve credentials.

region

string

required

AWS region the metric lives in.

metricNamespace

string

required

CloudWatch namespace (e.g. AWS/ECS)

metricName

string

required

CloudWatch metric name (e.g. CPUUtilization)

statistic

string

required

CloudWatch statistic to apply (Average, Sum, Maximum, ...)

period

integer<int32>

required

Aggregation period in seconds (e.g. 300). Must obey CloudWatch's per-window granularity floor (60s ≤ 15d, 300s ≤ 63d, 3600s ≤ 455d).

startTime

string

required

Inclusive start of the query window (ISO 8601). Must be earlier than endTime and within CloudWatch's 455-day retention.

endTime

string

required

Inclusive end of the query window (ISO 8601). Must be after startTime and not in the future.

dimensions

string[] | null

Repeated dimensionName=dimensionValue pairs scoping the metric

Response

The request has succeeded.

Response payload for a CloudWatch metric query

datapoints

object[]

required

Time-series datapoints, ordered by timestamp ascending

Show child attributes

unit

string

required

Display unit suffix for the metric, inferred server-side from the namespace + metric name (e.g. %, ``, B). Empty when unknown.

Get started

API reference

Get CloudWatch metric data

Query Parameters

Response