Skip to content

Message Statistics GET

Get message count statistics grouped by date.

Endpoint

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

Authentication

Required

Include one of these headers in your request:

  • Token: <your-api-key> — Get it from API Keys
  • Authorization: Bearer <jwt-token> — From Login

Request

Example Request

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

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

return $response->json();

Response

Success Response

200 OK

Returns an array of daily message counts

FieldTypeDescription
datestringDate in YYYY-MM-DD format
countintegerNumber of messages sent that day
json
[
  { "date": "2023-06-07", "count": 9 },
  { "date": "2023-06-08", "count": 14 },
  { "date": "2023-06-11", "count": 3 },
  { "date": "2023-06-12", "count": 23 },
  { "date": "2023-06-13", "count": 17 }
]

Error Responses

StatusDescription
401Unauthorized — Invalid or missing token

Use Case

Use this endpoint to display message volume charts in your dashboard or to monitor notification activity over time.

Pocket Alert Documentation