الحصول على تفصيل استخدام API حسب المفتاح والنقطة الطرفية
curl --request POST \
--url https://api.pubrio.com/api_keys/usage/breakdown \
--header 'Content-Type: application/json' \
--header 'pubrio-api-key: <api-key>' \
--data '
{
"start_date": "2026-05-01",
"end_date": "2026-05-14",
"keys": [
"<string>"
],
"log_type_slugs": [
"<string>"
]
}
'import requests
url = "https://api.pubrio.com/api_keys/usage/breakdown"
payload = {
"start_date": "2026-05-01",
"end_date": "2026-05-14",
"keys": ["<string>"],
"log_type_slugs": ["<string>"]
}
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({
start_date: '2026-05-01',
end_date: '2026-05-14',
keys: ['<string>'],
log_type_slugs: ['<string>']
})
};
fetch('https://api.pubrio.com/api_keys/usage/breakdown', 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/api_keys/usage/breakdown",
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([
'start_date' => '2026-05-01',
'end_date' => '2026-05-14',
'keys' => [
'<string>'
],
'log_type_slugs' => [
'<string>'
]
]),
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/api_keys/usage/breakdown"
payload := strings.NewReader("{\n \"start_date\": \"2026-05-01\",\n \"end_date\": \"2026-05-14\",\n \"keys\": [\n \"<string>\"\n ],\n \"log_type_slugs\": [\n \"<string>\"\n ]\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/api_keys/usage/breakdown")
.header("pubrio-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"start_date\": \"2026-05-01\",\n \"end_date\": \"2026-05-14\",\n \"keys\": [\n \"<string>\"\n ],\n \"log_type_slugs\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pubrio.com/api_keys/usage/breakdown")
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 \"start_date\": \"2026-05-01\",\n \"end_date\": \"2026-05-14\",\n \"keys\": [\n \"<string>\"\n ],\n \"log_type_slugs\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"metadata": {
"filters": {
"start_date": "2026-04-01",
"end_date": "2026-05-14"
}
},
"data": {
"by_key": [
{
"name": "2••••••••••••••••a37",
"requests": 929,
"credits": 42766,
"last_used": "2026-05-05 11:09:42.508",
"percent_of_requests": 17.892,
"percent_of_credits": 99.425
},
{
"name": "0••••••••••••••••f39",
"requests": 175,
"credits": 187,
"last_used": "2026-05-14 12:04:21.651",
"percent_of_requests": 3.37,
"percent_of_credits": 0.434
}
],
"by_endpoint": [
{
"slug": "people_redeem",
"name": "Redeem People",
"requests": 4088,
"credits": 41215,
"cost_per_call": 10.08,
"percent_of_requests": 78.73,
"percent_of_credits": 95.82
},
{
"slug": "people_search",
"name": "People Search",
"requests": 368,
"credits": 1101,
"cost_per_call": 2.99,
"percent_of_requests": 7.08,
"percent_of_credits": 2.55
}
],
"totals": {
"credits": 43013,
"requests": 5192
}
}
}{
"code": 40001,
"message": "Errors and codes will vary depending on the scenario, please see the documentation for information.",
"details": {}
}{
"error": "Request rate limit exceeded. Please wait and try again later."
}{
"error": "An unexpected error occurred on the server."
}مفاتيح API
تفصيل استخدام API
استرجع تفصيلًا لطلبات API والأرصدة المستهلَكة ضمن نطاق تاريخ، مجمَّعًا حسب مفتاح API الفردي (by_key) وحسب النقطة الطرفية (by_endpoint) على حد سواء. مفيد لتحديد المفاتيح الأعلى حركة مرور والنقاط الطرفية الأكثر استهلاكًا للأرصدة عبر مساحة العمل.
POST
/
api_keys
/
usage
/
breakdown
الحصول على تفصيل استخدام API حسب المفتاح والنقطة الطرفية
curl --request POST \
--url https://api.pubrio.com/api_keys/usage/breakdown \
--header 'Content-Type: application/json' \
--header 'pubrio-api-key: <api-key>' \
--data '
{
"start_date": "2026-05-01",
"end_date": "2026-05-14",
"keys": [
"<string>"
],
"log_type_slugs": [
"<string>"
]
}
'import requests
url = "https://api.pubrio.com/api_keys/usage/breakdown"
payload = {
"start_date": "2026-05-01",
"end_date": "2026-05-14",
"keys": ["<string>"],
"log_type_slugs": ["<string>"]
}
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({
start_date: '2026-05-01',
end_date: '2026-05-14',
keys: ['<string>'],
log_type_slugs: ['<string>']
})
};
fetch('https://api.pubrio.com/api_keys/usage/breakdown', 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/api_keys/usage/breakdown",
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([
'start_date' => '2026-05-01',
'end_date' => '2026-05-14',
'keys' => [
'<string>'
],
'log_type_slugs' => [
'<string>'
]
]),
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/api_keys/usage/breakdown"
payload := strings.NewReader("{\n \"start_date\": \"2026-05-01\",\n \"end_date\": \"2026-05-14\",\n \"keys\": [\n \"<string>\"\n ],\n \"log_type_slugs\": [\n \"<string>\"\n ]\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/api_keys/usage/breakdown")
.header("pubrio-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"start_date\": \"2026-05-01\",\n \"end_date\": \"2026-05-14\",\n \"keys\": [\n \"<string>\"\n ],\n \"log_type_slugs\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pubrio.com/api_keys/usage/breakdown")
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 \"start_date\": \"2026-05-01\",\n \"end_date\": \"2026-05-14\",\n \"keys\": [\n \"<string>\"\n ],\n \"log_type_slugs\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"metadata": {
"filters": {
"start_date": "2026-04-01",
"end_date": "2026-05-14"
}
},
"data": {
"by_key": [
{
"name": "2••••••••••••••••a37",
"requests": 929,
"credits": 42766,
"last_used": "2026-05-05 11:09:42.508",
"percent_of_requests": 17.892,
"percent_of_credits": 99.425
},
{
"name": "0••••••••••••••••f39",
"requests": 175,
"credits": 187,
"last_used": "2026-05-14 12:04:21.651",
"percent_of_requests": 3.37,
"percent_of_credits": 0.434
}
],
"by_endpoint": [
{
"slug": "people_redeem",
"name": "Redeem People",
"requests": 4088,
"credits": 41215,
"cost_per_call": 10.08,
"percent_of_requests": 78.73,
"percent_of_credits": 95.82
},
{
"slug": "people_search",
"name": "People Search",
"requests": 368,
"credits": 1101,
"cost_per_call": 2.99,
"percent_of_requests": 7.08,
"percent_of_credits": 2.55
}
],
"totals": {
"credits": 43013,
"requests": 5192
}
}
}{
"code": 40001,
"message": "Errors and codes will vary depending on the scenario, please see the documentation for information.",
"details": {}
}{
"error": "Request rate limit exceeded. Please wait and try again later."
}{
"error": "An unexpected error occurred on the server."
}التفويضات
الجسم
application/json
بداية نطاق التاريخ بصيغة YYYY-MM-DD (مفسَّرة بتوقيت منطقة عمل مساحة العمل).
مثال:
"2026-05-01"
نهاية نطاق التاريخ بصيغة YYYY-MM-DD (مفسَّرة بتوقيت منطقة عمل مساحة العمل).
مثال:
"2026-05-14"
قائمة اختيارية من معرّفات مفتاح API المُخفاة (مثل 0••••••••••••••••f39) لتقييد النتائج بمفاتيح محددة. استخدم القيم المُخفاة التي تُعيدها /api_keys أو حقل masked_authentication في إدخال سجل.
قائمة اختيارية من الأسماء القياسية لنوع السجل (مثل people_search، company_search، people_redeem) لتقييد النتائج بنقاط طرفية محددة.

