Billing

Summarize users

Admin-only endpoint that returns total/new/email-verified/banned user counts, product activation and 7-day retention, plus breakdowns by plan, provider, and signup locale. Product activation means at least one successful 2xx API request; 7-day retention means another successful request on or after day 7. Without an explicit time range the new-user window defaults to the last 30 days.

get/admin/billing/stats/users

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/admin/billing/stats/users
  • Auth: API key in header x-api-key

Query parameters

fromstring

New-user lower bound in RFC3339 format

tostring

New-user upper bound in RFC3339 format

Headers

x-api-keystring required

Admin API key required unless an Admin JWT is already present

Response

User stats

codeinteger
msgstring

Example response

{
  "code": 200,
  "data": {
    "activated_total": 290,
    "banned_total": 3,
    "by_browser_language": [
      {
        "count": 42,
        "key": "Free"
      }
    ],
    "by_locale": [
      {
        "count": 42,
        "key": "Free"
      }
    ],
    "by_plan": [
      {
        "count": 42,
        "key": "Free"
      }
    ],
    "by_provider": [
      {
        "count": 42,
        "key": "Free"
      }
    ],
    "email_verified_total": 290,
    "new_users": 12,
    "product_activated_total": 180,
    "retained_7d_total": 72,
    "total_users": 315
  },
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.