Metrics endpoints
List aggregated metrics
POST
/
api
/
v2
/
metrics
/
list
List aggregated metrics
curl --request POST \
--url https://appsignal.com/api/v2/metrics/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"site_id": "abc123",
"from": "2024-01-01T00:00:00Z",
"to": "2024-01-01T01:00:00Z",
"select": [
{
"id": "cpu",
"name": "cpu",
"field": "GAUGE",
"tags": {
"hostname": "*"
}
}
],
"group_by": [
{
"Tag": "hostname"
}
]
}
'import requests
url = "https://appsignal.com/api/v2/metrics/list"
payload = {
"site_id": "abc123",
"from": "2024-01-01T00:00:00Z",
"to": "2024-01-01T01:00:00Z",
"select": [
{
"id": "cpu",
"name": "cpu",
"field": "GAUGE",
"tags": { "hostname": "*" }
}
],
"group_by": [{ "Tag": "hostname" }]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
site_id: 'abc123',
from: '2024-01-01T00:00:00Z',
to: '2024-01-01T01:00:00Z',
select: [{id: 'cpu', name: 'cpu', field: 'GAUGE', tags: {hostname: '*'}}],
group_by: [{Tag: 'hostname'}]
})
};
fetch('https://appsignal.com/api/v2/metrics/list', 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://appsignal.com/api/v2/metrics/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'site_id' => 'abc123',
'from' => '2024-01-01T00:00:00Z',
'to' => '2024-01-01T01:00:00Z',
'select' => [
[
'id' => 'cpu',
'name' => 'cpu',
'field' => 'GAUGE',
'tags' => [
'hostname' => '*'
]
]
],
'group_by' => [
[
'Tag' => 'hostname'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://appsignal.com/api/v2/metrics/list"
payload := strings.NewReader("{\n \"site_id\": \"abc123\",\n \"from\": \"2024-01-01T00:00:00Z\",\n \"to\": \"2024-01-01T01:00:00Z\",\n \"select\": [\n {\n \"id\": \"cpu\",\n \"name\": \"cpu\",\n \"field\": \"GAUGE\",\n \"tags\": {\n \"hostname\": \"*\"\n }\n }\n ],\n \"group_by\": [\n {\n \"Tag\": \"hostname\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://appsignal.com/api/v2/metrics/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"site_id\": \"abc123\",\n \"from\": \"2024-01-01T00:00:00Z\",\n \"to\": \"2024-01-01T01:00:00Z\",\n \"select\": [\n {\n \"id\": \"cpu\",\n \"name\": \"cpu\",\n \"field\": \"GAUGE\",\n \"tags\": {\n \"hostname\": \"*\"\n }\n }\n ],\n \"group_by\": [\n {\n \"Tag\": \"hostname\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://appsignal.com/api/v2/metrics/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"site_id\": \"abc123\",\n \"from\": \"2024-01-01T00:00:00Z\",\n \"to\": \"2024-01-01T01:00:00Z\",\n \"select\": [\n {\n \"id\": \"cpu\",\n \"name\": \"cpu\",\n \"field\": \"GAUGE\",\n \"tags\": {\n \"hostname\": \"*\"\n }\n }\n ],\n \"group_by\": [\n {\n \"Tag\": \"hostname\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"resolution": "HOURLY",
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z",
"rows": [
{
"id": "<string>",
"group": {},
"data": {}
}
]
}{
"error": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>",
"suggestion": "<string>"
}{
"error": "<string>"
}For grouping, paging, and series limits, see Querying metrics.
Authorizations
bearer_authtoken_query
Authorization: Bearer <token>
Body
application/json
Query for fetching aggregated metric data in tabular form, used to populate list views.
Unlike [TimeseriesQuery], which returns data points over time, a ListQuery returns
one Row [blocked] per unique combination of group-by values, with each row
containing aggregated metric values.
Start of the time range to query (inclusive).
End of the time range to query (inclusive).
The site to fetch metrics for.
Selectors that define which metrics and fields to fetch. Each selector contributes
a key-value entry in the resulting Row::data [blocked] map.
Show child attributes
Show child attributes
How to group metrics into rows. Each unique combination of group-by values produces
one Row [blocked], whose id is derived from the grouped values.
Specifies how rows in a List [blocked] are grouped.
Show child attributes
Show child attributes
The desired interval for aggregation. When None, a resolution is
automatically chosen based on the time range.
Available options:
HOURLY, MINUTELY, DAILY Maximum number of rows to return. When None, no limit is applied.
Id-cursor paging (per_page 1 to 1000, rows ordered by id); takes precedence over
limit. A page shorter than per_page is the last.
Show child attributes
Show child attributes
Response
One row per unique combination of group-by values.
A tabular collection of [Row]s, returned for list-view queries.
Each row represents an aggregated metric value grouped by tags, used for displaying metric data in table format in the frontend.
The time interval used for aggregation (e.g. one minute, one hour).
Available options:
HOURLY, MINUTELY, DAILY Start of the queried time range (inclusive).
End of the queried time range (inclusive).
The rows of aggregated metric data.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
List aggregated metrics
curl --request POST \
--url https://appsignal.com/api/v2/metrics/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"site_id": "abc123",
"from": "2024-01-01T00:00:00Z",
"to": "2024-01-01T01:00:00Z",
"select": [
{
"id": "cpu",
"name": "cpu",
"field": "GAUGE",
"tags": {
"hostname": "*"
}
}
],
"group_by": [
{
"Tag": "hostname"
}
]
}
'import requests
url = "https://appsignal.com/api/v2/metrics/list"
payload = {
"site_id": "abc123",
"from": "2024-01-01T00:00:00Z",
"to": "2024-01-01T01:00:00Z",
"select": [
{
"id": "cpu",
"name": "cpu",
"field": "GAUGE",
"tags": { "hostname": "*" }
}
],
"group_by": [{ "Tag": "hostname" }]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
site_id: 'abc123',
from: '2024-01-01T00:00:00Z',
to: '2024-01-01T01:00:00Z',
select: [{id: 'cpu', name: 'cpu', field: 'GAUGE', tags: {hostname: '*'}}],
group_by: [{Tag: 'hostname'}]
})
};
fetch('https://appsignal.com/api/v2/metrics/list', 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://appsignal.com/api/v2/metrics/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'site_id' => 'abc123',
'from' => '2024-01-01T00:00:00Z',
'to' => '2024-01-01T01:00:00Z',
'select' => [
[
'id' => 'cpu',
'name' => 'cpu',
'field' => 'GAUGE',
'tags' => [
'hostname' => '*'
]
]
],
'group_by' => [
[
'Tag' => 'hostname'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://appsignal.com/api/v2/metrics/list"
payload := strings.NewReader("{\n \"site_id\": \"abc123\",\n \"from\": \"2024-01-01T00:00:00Z\",\n \"to\": \"2024-01-01T01:00:00Z\",\n \"select\": [\n {\n \"id\": \"cpu\",\n \"name\": \"cpu\",\n \"field\": \"GAUGE\",\n \"tags\": {\n \"hostname\": \"*\"\n }\n }\n ],\n \"group_by\": [\n {\n \"Tag\": \"hostname\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://appsignal.com/api/v2/metrics/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"site_id\": \"abc123\",\n \"from\": \"2024-01-01T00:00:00Z\",\n \"to\": \"2024-01-01T01:00:00Z\",\n \"select\": [\n {\n \"id\": \"cpu\",\n \"name\": \"cpu\",\n \"field\": \"GAUGE\",\n \"tags\": {\n \"hostname\": \"*\"\n }\n }\n ],\n \"group_by\": [\n {\n \"Tag\": \"hostname\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://appsignal.com/api/v2/metrics/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"site_id\": \"abc123\",\n \"from\": \"2024-01-01T00:00:00Z\",\n \"to\": \"2024-01-01T01:00:00Z\",\n \"select\": [\n {\n \"id\": \"cpu\",\n \"name\": \"cpu\",\n \"field\": \"GAUGE\",\n \"tags\": {\n \"hostname\": \"*\"\n }\n }\n ],\n \"group_by\": [\n {\n \"Tag\": \"hostname\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"resolution": "HOURLY",
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z",
"rows": [
{
"id": "<string>",
"group": {},
"data": {}
}
]
}{
"error": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>",
"suggestion": "<string>"
}{
"error": "<string>"
}