Skip to content

Account and plan

GET /v1/me

Any valid key. Returns the organization, the plan and the key’s scopes. user and role are null for an API key (they are set for dashboard sessions).

Terminal window
curl -s https://api.ad80.dev/v1/me -H "Authorization: Bearer $AD80_API_KEY"
{
"org": { "id": "12", "name": "Example Media" },
"plan": "starter",
"scopes": ["read:creatives", "read:verdicts"],
"user": null,
"role": null
}
GET /v1/plan

Scope read:creatives. Your plan, what it includes and this period’s usage. Usage counters are per calendar month (UTC). In every limit, null means no fixed limit and 0 means not included.

Terminal window
curl -s https://api.ad80.dev/v1/plan -H "Authorization: Bearer $AD80_API_KEY"

Response (the numbers are illustrative):

{
"plan": "starter",
"name": "Starter",
"price": { "display": "..." },
"playgroundAppId": "ad80.playground",
"policyLimits": { "maxRules": 20, "maxRuleChars": 500 },
"entitlements": {
"maxActivePolicies": 10,
"manualClassificationsPerMonth": 200,
"monitoredImpressionsPerMonth": 3000,
"expeditedNotificationsPerMonth": 10,
"notificationChannels": ["email", "webhook"],
"reporting": "basic",
"investigationTools": "basic",
"support": "standard",
"sdkIngestEnabled": true,
"incidentManagement": false
},
"usage": {
"periodStart": "2026-10-01T00:00:00Z",
"periodEnd": "2026-11-01T00:00:00Z",
"activePolicies": { "used": 2, "limit": 10, "remaining": 8 },
"manualClassifications": { "used": 14, "limit": 200, "remaining": 186 },
"monitoredImpressions": { "used": 1250, "limit": 3000, "remaining": 1750 },
"expeditedNotifications": { "used": 3, "limit": 10, "remaining": 7 },
"notClassifiedImpressions": 0
},
"upgrade": { "target": "enterprise", "contact": "mailto:contact@ad80.dev" }
}
FieldMeaning
planfree, starter or enterprise.
playgroundAppIdThe app the Policy Playground uses. AD80 creates it for you.
policyLimitsStructural limits on a policy (rules per policy, characters per rule), the same on every plan.
entitlementsWhat the plan includes. reporting: none, basic, advanced. investigationTools: none, basic, incident_management. support: community, standard, priority.
usageThis period’s counters: used, limit, remaining (null = no fixed limit). notClassifiedImpressions counts impressions that were not classified because the allowance was reached.
upgrade.targetThe next plan up, or null on the highest plan. Upgrading is done by contacting AD80; there is no payment API.
GET /v1/overview

Scope read:creatives. The numbers behind the dashboard’s Overview in one call.

Terminal window
curl -s https://api.ad80.dev/v1/overview -H "Authorization: Bearer $AD80_API_KEY"
{
"violationsToday": 3,
"violations7d": 17,
"unreviewed": 9,
"daily": [{ "date": "2026-10-22", "violations": 2, "creatives": 40 }],
"topNetworks": [{ "network": "meta", "violations": 6 }],
"usage": { "periodStart": "2026-10-01T00:00:00Z", "periodEnd": "2026-11-01T00:00:00Z", "...": "same as /v1/plan" },
"sdkHealth": [{ "appId": "com.example.news", "name": "com.example.news", "lastUploadAt": "2026-10-28T09:12:44Z" }]
}

daily covers the last 7 UTC days, oldest first. sdkHealth lists your SDK apps (not the Playground app) with their last accepted upload.