Get bounded platform activity and AI usage
curl --request GET \
--url https://api.openworklabs.com/v1/admin/dashboard \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/admin/dashboard"
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.openworklabs.com/v1/admin/dashboard', 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.openworklabs.com/v1/admin/dashboard",
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.openworklabs.com/v1/admin/dashboard"
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.openworklabs.com/v1/admin/dashboard")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/admin/dashboard")
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{
"from": "<string>",
"to": "<string>",
"generatedAt": "2023-11-07T05:31:56Z",
"activeUsers": {
"today": 4503599627370495,
"days7": 4503599627370495,
"days30": 4503599627370495
},
"activeOrganizations": 4503599627370495,
"totals": {
"requests": 4503599627370495,
"tokens": 4503599627370495,
"costMicroUsd": 4503599627370495,
"unreportedRequests": 4503599627370495,
"unpricedRequests": 4503599627370495
},
"daily": [
{
"requests": 4503599627370495,
"tokens": 4503599627370495,
"costMicroUsd": 4503599627370495,
"unreportedRequests": 4503599627370495,
"unpricedRequests": 4503599627370495,
"date": "<string>"
}
],
"organizations": [
{
"requests": 4503599627370495,
"tokens": 4503599627370495,
"costMicroUsd": 4503599627370495,
"unreportedRequests": 4503599627370495,
"unpricedRequests": 4503599627370495,
"id": "<string>",
"name": "<string>"
}
]
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}Admin
Get bounded platform activity and AI usage
Returns 30 UTC calendar days of completed gateway usage across organizations, using the same raw and retained accounting as organization reports. Includes accounting coverage, 30 daily totals, at most eight organizations ranked by requests, and distinct users with sign-in or telemetry activity. Does not hydrate features, billing or members.
GET
/
v1
/
admin
/
dashboard
Get bounded platform activity and AI usage
curl --request GET \
--url https://api.openworklabs.com/v1/admin/dashboard \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/admin/dashboard"
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.openworklabs.com/v1/admin/dashboard', 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.openworklabs.com/v1/admin/dashboard",
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.openworklabs.com/v1/admin/dashboard"
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.openworklabs.com/v1/admin/dashboard")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/admin/dashboard")
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{
"from": "<string>",
"to": "<string>",
"generatedAt": "2023-11-07T05:31:56Z",
"activeUsers": {
"today": 4503599627370495,
"days7": 4503599627370495,
"days30": 4503599627370495
},
"activeOrganizations": 4503599627370495,
"totals": {
"requests": 4503599627370495,
"tokens": 4503599627370495,
"costMicroUsd": 4503599627370495,
"unreportedRequests": 4503599627370495,
"unpricedRequests": 4503599627370495
},
"daily": [
{
"requests": 4503599627370495,
"tokens": 4503599627370495,
"costMicroUsd": 4503599627370495,
"unreportedRequests": 4503599627370495,
"unpricedRequests": 4503599627370495,
"date": "<string>"
}
],
"organizations": [
{
"requests": 4503599627370495,
"tokens": 4503599627370495,
"costMicroUsd": 4503599627370495,
"unreportedRequests": 4503599627370495,
"unpricedRequests": 4503599627370495,
"id": "<string>",
"name": "<string>"
}
]
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}Authorizations
denApiKeybearerAuth
Organization API key passed as the x-api-key header. The raw key is the header value; do not prefix it with Bearer.
Response
Platform dashboard returned.
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))$Show child attributes
Show child attributes
Required range:
0 <= x <= 9007199254740991Show child attributes
Show child attributes
Maximum array length:
30Show child attributes
Show child attributes
Maximum array length:
8Show child attributes
Show child attributes
Was this page helpful?