ワークスペース使用統計の取得
curl --request POST \
--url https://api.pubrio.com/profile/usage \
--header 'Content-Type: application/json' \
--header 'pubrio-api-key: <api-key>' \
--data '
{
"profile_id": 123
}
'import requests
url = "https://api.pubrio.com/profile/usage"
payload = { "profile_id": 123 }
headers = {
"pubrio-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'pubrio-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({profile_id: 123})
};
fetch('https://api.pubrio.com/profile/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.pubrio.com/profile/usage",
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([
'profile_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"pubrio-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.pubrio.com/profile/usage"
payload := strings.NewReader("{\n \"profile_id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("pubrio-api-key", "<api-key>")
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://api.pubrio.com/profile/usage")
.header("pubrio-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"profile_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pubrio.com/profile/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["pubrio-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"profile_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"api_monthly_usage": 0,
"api_daily_usage": 0,
"api_hourly_usage": 0,
"api_last_refreshed": "2024-11-13T10:01:13.051Z",
"portal_monthly_usage": 848,
"portal_daily_usage": 163,
"portal_hourly_usage": 4,
"portal_last_refreshed": "2024-11-13T10:01:13.051Z",
"max_api_monthly_query": 0,
"max_api_daily_query": 0,
"max_api_hourly_query": 0,
"max_portal_monthly_query": 60000,
"max_portal_daily_query": 2000,
"max_portal_hourly_query": 1000,
"total_max_api_monthly_query": 0,
"total_max_api_daily_query": 0,
"total_max_api_hourly_query": 0,
"total_max_portal_monthly_query": 2040000,
"total_max_portal_daily_query": 68000,
"total_max_portal_hourly_query": 34000,
"is_api_access_available": false,
"is_quota_sharing_enabled": true,
"is_quota_sharing_available": true
}
}{
"code": 40001,
"message": "エラーの背景やフィールド単位の情報などを含む追加データオブジェクトです。",
"details": {}
}{
"error": "クライアントはしばらく待ってから再試行することが推奨されます。"
}{
"error": "レスポンスボディには `error` フィールドが含まれ、問題の概要がメッセージとして記載されます。"
}チーム(ワークスペース)
チーム利用状況
現在のワークスペースプロフィールのクレジット使用量と割り当て統計を取得します。
POST
/
profile
/
usage
ワークスペース使用統計の取得
curl --request POST \
--url https://api.pubrio.com/profile/usage \
--header 'Content-Type: application/json' \
--header 'pubrio-api-key: <api-key>' \
--data '
{
"profile_id": 123
}
'import requests
url = "https://api.pubrio.com/profile/usage"
payload = { "profile_id": 123 }
headers = {
"pubrio-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'pubrio-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({profile_id: 123})
};
fetch('https://api.pubrio.com/profile/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.pubrio.com/profile/usage",
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([
'profile_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"pubrio-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.pubrio.com/profile/usage"
payload := strings.NewReader("{\n \"profile_id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("pubrio-api-key", "<api-key>")
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://api.pubrio.com/profile/usage")
.header("pubrio-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"profile_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pubrio.com/profile/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["pubrio-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"profile_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"api_monthly_usage": 0,
"api_daily_usage": 0,
"api_hourly_usage": 0,
"api_last_refreshed": "2024-11-13T10:01:13.051Z",
"portal_monthly_usage": 848,
"portal_daily_usage": 163,
"portal_hourly_usage": 4,
"portal_last_refreshed": "2024-11-13T10:01:13.051Z",
"max_api_monthly_query": 0,
"max_api_daily_query": 0,
"max_api_hourly_query": 0,
"max_portal_monthly_query": 60000,
"max_portal_daily_query": 2000,
"max_portal_hourly_query": 1000,
"total_max_api_monthly_query": 0,
"total_max_api_daily_query": 0,
"total_max_api_hourly_query": 0,
"total_max_portal_monthly_query": 2040000,
"total_max_portal_daily_query": 68000,
"total_max_portal_hourly_query": 34000,
"is_api_access_available": false,
"is_quota_sharing_enabled": true,
"is_quota_sharing_available": true
}
}{
"code": 40001,
"message": "エラーの背景やフィールド単位の情報などを含む追加データオブジェクトです。",
"details": {}
}{
"error": "クライアントはしばらく待ってから再試行することが推奨されます。"
}{
"error": "レスポンスボディには `error` フィールドが含まれ、問題の概要がメッセージとして記載されます。"
}承認
ボディ
application/json
オプション。リクエストを送信するチームを表す識別子です。API キーにワークスペース情報が既に含まれているため、このパラメータは必須ではなくなりました。指定した場合、検索結果が特定のチーム(ワークスペース)に紐づけられ、データ取得およびクレジット利用状況の追跡が可能になります。詳しくは、チーム関連の「ユーザー詳細」エンドポイントを参照してください。
レスポンス
関連する詳細情報を含む成功レスポンスです。
エンドポイント固有のレスポンスをオブジェクト形式で格納する汎用コンテナです。
⌘I

