Get admin overview
curl --request GET \
--url https://api.example.com/v1/admin/overviewimport requests
url = "https://api.example.com/v1/admin/overview"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/admin/overview', 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.example.com/v1/admin/overview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/v1/admin/overview"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/v1/admin/overview")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/admin/overview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"viewer": {
"id": "<string>",
"email": "<string>",
"name": "<string>"
},
"admins": [
{}
],
"summary": {
"totalUsers": 123,
"totalOrganizations": 123,
"verifiedUsers": 123,
"recentUsers7d": 123,
"recentUsers30d": 123,
"totalWorkers": 123,
"cloudWorkers": 123,
"localWorkers": 123,
"usersWithWorkers": 123,
"usersWithoutWorkers": 123,
"paidUsers": 123,
"unpaidUsers": 123,
"billingUnavailableUsers": 123,
"adminCount": 123,
"billingLoaded": true,
"activeUsers1d": 123,
"activeUsers7d": 123,
"activeUsers30d": 123,
"realActiveUsers1d": 123,
"realActiveUsers7d": 123,
"realActiveUsers30d": 123,
"recurringUsers": 123,
"inviters": 123,
"medianHoursToFirstInvite": 123,
"activitySeries": [
{
"day": "<string>",
"activeUsers": 123,
"realActiveUsers": 123,
"signups": 123
}
]
},
"users": [
{}
],
"organizations": [
{}
],
"userPage": {
"total": 123,
"limit": 123,
"offset": 123,
"returned": 123,
"hasMore": true,
"search": "<string>",
"durationMs": 123
},
"organizationPage": {
"total": 123,
"limit": 123,
"offset": 123,
"returned": 123,
"hasMore": true,
"search": "<string>",
"durationMs": 123
},
"generatedAt": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}{
"error": "<string>"
}{
"reason": "<string>",
"message": "<string>"
}Admin
Get admin overview
Returns the initial admin overview with bounded user data, global totals, and required pagination metadata. Expensive analytics are loaded separately from /v1/admin/metrics.
GET
/
v1
/
admin
/
overview
Get admin overview
curl --request GET \
--url https://api.example.com/v1/admin/overviewimport requests
url = "https://api.example.com/v1/admin/overview"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/admin/overview', 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.example.com/v1/admin/overview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/v1/admin/overview"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/v1/admin/overview")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/admin/overview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"viewer": {
"id": "<string>",
"email": "<string>",
"name": "<string>"
},
"admins": [
{}
],
"summary": {
"totalUsers": 123,
"totalOrganizations": 123,
"verifiedUsers": 123,
"recentUsers7d": 123,
"recentUsers30d": 123,
"totalWorkers": 123,
"cloudWorkers": 123,
"localWorkers": 123,
"usersWithWorkers": 123,
"usersWithoutWorkers": 123,
"paidUsers": 123,
"unpaidUsers": 123,
"billingUnavailableUsers": 123,
"adminCount": 123,
"billingLoaded": true,
"activeUsers1d": 123,
"activeUsers7d": 123,
"activeUsers30d": 123,
"realActiveUsers1d": 123,
"realActiveUsers7d": 123,
"realActiveUsers30d": 123,
"recurringUsers": 123,
"inviters": 123,
"medianHoursToFirstInvite": 123,
"activitySeries": [
{
"day": "<string>",
"activeUsers": 123,
"realActiveUsers": 123,
"signups": 123
}
]
},
"users": [
{}
],
"organizations": [
{}
],
"userPage": {
"total": 123,
"limit": 123,
"offset": 123,
"returned": 123,
"hasMore": true,
"search": "<string>",
"durationMs": 123
},
"organizationPage": {
"total": 123,
"limit": 123,
"offset": 123,
"returned": 123,
"hasMore": true,
"search": "<string>",
"durationMs": 123
},
"generatedAt": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}{
"error": "<string>"
}{
"reason": "<string>",
"message": "<string>"
}Response
Administrative overview returned successfully.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Was this page helpful?
⌘I