Перейти к содержимому

Использование сообщений GET ​

Получите использование сообщений за сегодня относительно дневного лимита вашего тарифа.

Эндпоинт ​

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

Аутентификация ​

Обязательно

Добавьте в запрос один из этих заголовков:

Запрос ​

Пример запроса ​

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 | nullКоличество сообщений в день, null на тарифах без лимита
unlimitedbooleantrue, если на тарифе нет дневного лимита
rejectedintegerКоличество запросов, отклонённых сегодня из-за достижения лимита
resets_atstringСледующий сброс, 00:00 UTC, в формате 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"
}

Ответы с ошибками ​

СтатусОписание
401Unauthorized — токен неверный или отсутствует

Сценарий использования

Сравните used с limit перед серией оповещений или выведите остаток квоты в собственной панели. Те же значения возвращаются в заголовках X-PA-Daily-* каждого ответа на создание сообщения.

Документация Pocket Alert