メインコンテンツへスキップ
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",
  "profile_id": 123,
  "keys": [
    "<string>"
  ],
  "log_type_slugs": [
    "<string>"
  ]
}
'
{
  "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
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.pubrio.com/llms.txt

Use this file to discover all available pages before exploring further.

承認

pubrio-api-key
string
header
必須

API で実行する操作内容と、その操作に付与された権限を識別するための一意の API トークンです。このトークンはダッシュボードの 設定 画面から発行できます。

ボディ

application/json
start_date
string
必須

期間の開始日(YYYY-MM-DD 形式、ワークスペースのタイムゾーンで解釈されます)。

:

"2026-05-01"

end_date
string
必須

期間の終了日(YYYY-MM-DD 形式、ワークスペースのタイムゾーンで解釈されます)。

:

"2026-05-14"

profile_id
integer

オプション。リクエストを送信するチームを表す識別子です。API キーにワークスペース情報が既に含まれているため、このパラメータは必須ではなくなりました。指定した場合、検索結果が特定のチーム(ワークスペース)に紐づけられ、データ取得およびクレジット利用状況の追跡が可能になります。詳しくは、チーム関連の「ユーザー詳細」エンドポイントを参照してください。

keys
string[]

省略可。マスク済みAPIキー識別子(例: 0••••••••••••••••f39)で結果を絞り込みます。/api_keys のレスポンスやログエントリの masked_authentication フィールドの値を指定できます。

log_type_slugs
string[]

省略可。ログタイプスラッグ(例: people_searchcompany_searchpeople_redeem)で結果を絞り込み、特定エンドポイントに限定します。

レスポンス

API使用状況の内訳を返す成功レスポンス。

metadata
object
data
object