REST API
Read your organization's data with an API key.
Read your organization's data with an API key. Available on the Studio and Agency plans.
Authentication
Create a key under Settings → API keys (owners and admins). It is shown once. Send it in either header:
Authorization: Bearer <api key>
X-Api-Key: <api key>
A key reads everything listed below for its organization. Revoke a key on the same page; it stops working immediately. The page shows when each key was last used.
Base URL
https://www.apps-patrol.com/api/rest/v1
GET /overview
Current totals across tracked apps, from the latest daily metrics.
curl -H "Authorization: Bearer $APPS_PATROL_API_KEY" https://www.apps-patrol.com/api/rest/v1/overview
{
"organization": { "id": 4, "name": "Acme Apps", "plan": "studio" },
"mrr_cents": 17588,
"active_subs": 19,
"apps": [
{ "id": 10, "name": "Cart Holder", "handle": "cart-holder" }
]
}
mrr_cents is in the currency of your subscriptions, in the smallest unit.
GET /apps
Tracked apps.
{
"apps": [
{ "id": 10, "name": "Cart Holder", "handle": "cart-holder", "public_id": "7c46d20f-1f89-46e5-aeb4-922c96c648f8" }
]
}
GET /keywords
Tracked keywords, up to 500.
{
"keywords": [
{ "id": 12, "term": "cart timer", "locale": "en", "app_id": 10 }
]
}
GET /mcp
A machine-readable list of the endpoints above. See MCP manifest.
Rate limit
120 requests per minute per key. Every response has X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset; a 429 also has Retry-After.
Errors
| Status | Code | Meaning |
|---|---|---|
401 | unauthorized | Missing, wrong or revoked key. |
402 | plan_required | The organization's plan no longer includes the API. |
429 | rate_limited | Too many requests this minute. |
Not available yet
The API is read-only and does not yet cover revenue history, customers, rank history, competitors or reviews, and has no pagination.