コンテンツへスキップ

メッセージ利用状況 GET ​

プランの 1 日の上限 に対する、本日のメッセージ利用状況を取得します。

エンドポイント ​

GET https://api.pocketalert.app/v1/messages/usage

認証 ​

必須

リクエストには、次のいずれかのヘッダーを含めてください。

  • Token: <your-api-key> — API キー から取得します
  • Authorization: Bearer <jwt-token> — ログイン から取得します

リクエスト ​

リクエストの例 ​

bash
curl -X GET "https://api.pocketalert.app/v1/messages/usage" \
  -H "Token: your-api-key"
javascript
const response = await fetch('https://api.pocketalert.app/v1/messages/usage', {
  headers: { 'Token': 'your-api-key' }
});
const usage = await response.json();
python
import requests

response = requests.get(
    'https://api.pocketalert.app/v1/messages/usage',
    headers={'Token': 'your-api-key'}
)
print(response.json())
php
$response = Http::withHeaders([
    'Token' => 'your-api-key',
])->get('https://api.pocketalert.app/v1/messages/usage');

return $response->json();

レスポンス ​

成功時のレスポンス ​

200 OK

本日の利用状況を返します。日付は UTC の日付です。

フィールド型説明
usedinteger本日受け付けられたメッセージ数
limitinteger | null1 日に送信できるメッセージ数。無制限のプランでは null
unlimitedbooleanプランに 1 日の上限がない場合は true
rejectedinteger上限に達したため本日拒否されたリクエスト数
resets_atstring次回のリセット時刻(UTC の 00:00、RFC3339 形式)
json
{
  "used": 42,
  "limit": 50,
  "unlimited": false,
  "rejected": 0,
  "resets_at": "2026-09-22T00:00:00Z"
}

無制限のプランの場合:

json
{
  "used": 1280,
  "limit": null,
  "unlimited": true,
  "rejected": 0,
  "resets_at": "2026-09-22T00:00:00Z"
}

エラーレスポンス ​

ステータス説明
401認証されていません。トークンが無効または未指定です

ユースケース

大量のアラートを送信する前に used と limit を比較したり、残りの利用枠を独自のダッシュボードに表示したりできます。同じ数値は、メッセージの作成 のレスポンスに X-PA-Daily-* ヘッダーとしても含まれます。

Pocket Alert ドキュメント