Get organization usage and a bounded member page
curl --request GET \
--url https://api.openworklabs.com/v1/admin/organizations/{organizationId}/usage \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/admin/organizations/{organizationId}/usage"
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/organizations/{organizationId}/usage', 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/organizations/{organizationId}/usage",
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/organizations/{organizationId}/usage"
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/organizations/{organizationId}/usage")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/admin/organizations/{organizationId}/usage")
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{
"organization": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"planTier": "<string>",
"seatLimit": 4503599627370495,
"memberCount": 4503599627370495
},
"members": [
{
"id": "<string>",
"userId": "<string>",
"name": "<string>",
"email": "<string>",
"role": "<string>",
"joinedAt": "2023-11-07T05:31:56Z"
}
],
"page": {
"limit": 4503599627370495,
"offset": 4503599627370495,
"search": "<string>",
"total": 4503599627370495,
"returned": 4503599627370495,
"hasMore": true,
"durationMs": 4503599627370495
},
"generatedAt": "2023-11-07T05:31:56Z",
"usage": {
"from": "<string>",
"to": "<string>",
"totals": {
"requests": 4503599627370495,
"tokens": 4503599627370495,
"costMicroUsd": 4503599627370495,
"unreportedRequests": 4503599627370495,
"unpricedRequests": 4503599627370495
},
"members": [
{
"requests": 4503599627370495,
"tokens": 4503599627370495,
"costMicroUsd": 4503599627370495,
"unreportedRequests": 4503599627370495,
"unpricedRequests": 4503599627370495,
"memberId": "<string>"
}
]
}
}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
],
"message": "<string>",
"capability": "<string>"
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Admin
Get organization usage and a bounded member page
Returns the organization’s last 30 UTC days of gateway usage, with requests, reported tokens, recorded cost and accounting coverage. Member usage is bounded to the requested member page; organization totals include all members, including removed members. Raw and retained usage use the same accounting as the organization dashboard.
GET
/
v1
/
admin
/
organizations
/
{organizationId}
/
usage
Get organization usage and a bounded member page
curl --request GET \
--url https://api.openworklabs.com/v1/admin/organizations/{organizationId}/usage \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/admin/organizations/{organizationId}/usage"
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/organizations/{organizationId}/usage', 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/organizations/{organizationId}/usage",
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/organizations/{organizationId}/usage"
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/organizations/{organizationId}/usage")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/admin/organizations/{organizationId}/usage")
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{
"organization": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"planTier": "<string>",
"seatLimit": 4503599627370495,
"memberCount": 4503599627370495
},
"members": [
{
"id": "<string>",
"userId": "<string>",
"name": "<string>",
"email": "<string>",
"role": "<string>",
"joinedAt": "2023-11-07T05:31:56Z"
}
],
"page": {
"limit": 4503599627370495,
"offset": 4503599627370495,
"search": "<string>",
"total": 4503599627370495,
"returned": 4503599627370495,
"hasMore": true,
"durationMs": 4503599627370495
},
"generatedAt": "2023-11-07T05:31:56Z",
"usage": {
"from": "<string>",
"to": "<string>",
"totals": {
"requests": 4503599627370495,
"tokens": 4503599627370495,
"costMicroUsd": 4503599627370495,
"unreportedRequests": 4503599627370495,
"unpricedRequests": 4503599627370495
},
"members": [
{
"requests": 4503599627370495,
"tokens": 4503599627370495,
"costMicroUsd": 4503599627370495,
"unreportedRequests": 4503599627370495,
"unpricedRequests": 4503599627370495,
"memberId": "<string>"
}
]
}
}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
],
"message": "<string>",
"capability": "<string>"
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}{
"error": "<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.
Path Parameters
Response
Organization detail returned.
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))$Show child attributes
Show child attributes
Was this page helpful?