تخطَّ إلى المحتوى

الحساب والباقة

GET /v1/me

يعمل مع أي مفتاح صالح. يرجع المؤسسة والباقة ونطاقات المفتاح. يكون user وrole بقيمة null مع مفتاح API (ولهما قيمة في جلسات لوحة المتابعة).

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

النطاق read:creatives. يرجع باقتك، وما تشمله، واستهلاك الفترة الحالية. عدّادات الاستهلاك شهرية حسب التقويم (بتوقيت UTC). وفي كل حدّ، null تعني أنه لا يوجد حدّ ثابت، و0 تعني أن الباقة لا تشمله.

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

الرد (الأرقام للتوضيح فقط):

{
"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" }
}
الحقلمعناه
planfree أو starter أو enterprise.
playgroundAppIdالتطبيق الذي تستخدمه صفحة «جرّب سياستك». تنشئه AD80 لك.
policyLimitsالحدود البنيوية للسياسة (عدد القواعد في السياسة، وعدد الأحرف في القاعدة)، وهي واحدة في كل الباقات.
entitlementsما تشمله الباقة. reporting: none أو basic أو advanced. investigationTools: none أو basic أو incident_management. support: community أو standard أو priority.
usageعدّادات الفترة الحالية: used وlimit وremaining (null = لا حدّ ثابت). يعدّ notClassifiedImpressions مرات الظهور التي لم تُفحص لأن الرصيد نفد.
upgrade.targetالباقة الأعلى التالية، أو null إن كنت على أعلى باقة. الترقية تتم بالتواصل مع AD80، فلا يوجد API للدفع.
GET /v1/overview

النطاق read:creatives. الأرقام التي تقوم عليها صفحة نظرة عامة في لوحة المتابعة، في طلب واحد.

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 آخر 7 أيام بتوقيت UTC، من الأقدم إلى الأحدث. ويعرض sdkHealth تطبيقاتك التي تستخدم SDK (دون تطبيق «جرّب سياستك») مع آخر رفع مقبول لكل منها.