List web vitals
curl --request GET \
--url https://api.atatus.com/v2/projects/{projectId}/webvitals \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.atatus.com/v2/projects/{projectId}/webvitals"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.atatus.com/v2/projects/{projectId}/webvitals', 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.atatus.com/v2/projects/{projectId}/webvitals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$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.atatus.com/v2/projects/{projectId}/webvitals"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.atatus.com/v2/projects/{projectId}/webvitals")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.atatus.com/v2/projects/{projectId}/webvitals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"name": "fcp",
"metrics": [
{
"name": "Good",
"count": 12,
"percentage": 100
},
{
"name": "Needs Improvement",
"count": 0,
"percentage": 0
},
{
"name": "Poor",
"count": 0,
"percentage": 0
}
],
"avg": 230.6679,
"affectedUser": 0
},
{
"name": "lcp",
"metrics": [
{
"name": "Good",
"count": 5,
"percentage": 41.66
},
{
"name": "Needs Improvement",
"count": 5,
"percentage": 41.67
},
{
"name": "Poor",
"count": 2,
"percentage": 16.67
}
],
"avg": 2891.8383,
"affectedUser": 1
},
{
"name": "fid",
"metrics": [
{
"name": "Good",
"count": 8,
"percentage": 100
},
{
"name": "Needs Improvement",
"count": 0,
"percentage": 0
},
{
"name": "Poor",
"count": 0,
"percentage": 0
}
],
"avg": 3.5963,
"affectedUser": 0
},
{
"name": "cls",
"metrics": [
{
"name": "Good",
"count": 6,
"percentage": 50
},
{
"name": "Needs Improvement",
"count": 3,
"percentage": 25
},
{
"name": "Poor",
"count": 3,
"percentage": 25
}
],
"avg": 0.1888,
"affectedUser": 1
},
{
"name": "ttfb",
"metrics": [
{
"name": "Good",
"count": 13,
"percentage": 100
},
{
"name": "Needs Improvement",
"count": 0,
"percentage": 0
},
{
"name": "Poor",
"count": 0,
"percentage": 0
}
],
"avg": 31.3077,
"affectedUser": 0
}
]
}{
"Message": "API key is invalid!"
}{
"Message": "Too many requests"
}{
"Message": "Internal server error"
}Web Vitals
List web vitals
Returns the web vitals metrics for the pages of a browser project. Pass search to get the web vitals of a specific page.
GET
/
projects
/
{projectId}
/
webvitals
List web vitals
curl --request GET \
--url https://api.atatus.com/v2/projects/{projectId}/webvitals \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.atatus.com/v2/projects/{projectId}/webvitals"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.atatus.com/v2/projects/{projectId}/webvitals', 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.atatus.com/v2/projects/{projectId}/webvitals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$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.atatus.com/v2/projects/{projectId}/webvitals"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.atatus.com/v2/projects/{projectId}/webvitals")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.atatus.com/v2/projects/{projectId}/webvitals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"name": "fcp",
"metrics": [
{
"name": "Good",
"count": 12,
"percentage": 100
},
{
"name": "Needs Improvement",
"count": 0,
"percentage": 0
},
{
"name": "Poor",
"count": 0,
"percentage": 0
}
],
"avg": 230.6679,
"affectedUser": 0
},
{
"name": "lcp",
"metrics": [
{
"name": "Good",
"count": 5,
"percentage": 41.66
},
{
"name": "Needs Improvement",
"count": 5,
"percentage": 41.67
},
{
"name": "Poor",
"count": 2,
"percentage": 16.67
}
],
"avg": 2891.8383,
"affectedUser": 1
},
{
"name": "fid",
"metrics": [
{
"name": "Good",
"count": 8,
"percentage": 100
},
{
"name": "Needs Improvement",
"count": 0,
"percentage": 0
},
{
"name": "Poor",
"count": 0,
"percentage": 0
}
],
"avg": 3.5963,
"affectedUser": 0
},
{
"name": "cls",
"metrics": [
{
"name": "Good",
"count": 6,
"percentage": 50
},
{
"name": "Needs Improvement",
"count": 3,
"percentage": 25
},
{
"name": "Poor",
"count": 3,
"percentage": 25
}
],
"avg": 0.1888,
"affectedUser": 1
},
{
"name": "ttfb",
"metrics": [
{
"name": "Good",
"count": 13,
"percentage": 100
},
{
"name": "Needs Improvement",
"count": 0,
"percentage": 0
},
{
"name": "Poor",
"count": 0,
"percentage": 0
}
],
"avg": 31.3077,
"affectedUser": 0
}
]
}{
"Message": "API key is invalid!"
}{
"Message": "Too many requests"
}{
"Message": "Internal server error"
}Authorizations
Your Atatus API key. You can also send it as the api_key query parameter or, for POST/PUT requests, in the request body.
Path Parameters
Query Parameters
The time duration. Example: 30m, 60m, 6h, 12h, 1d, 2d, 3d, 7d, 14d, 1M
Instead of timeDur, you can give custom timeStart and timeEnd. Format: YYYY-MM-DD+HH:mm Eg: timeStart=2020-03-01+00:00&timeEnd=2020-03-06+00:00
Instead of timeDur, you can give custom timeStart and timeEnd. Format: YYYY-MM-DD+HH:mm Eg: timeStart=2020-03-01+00:00&timeEnd=2020-03-06+00:00
Keyword for search pages
Response
Success
Show child attributes
Show child attributes