/distributors/{id}/stats - Get distributor statistics

GET /distributors/{id}/stats
Bearer auth

Get users, systems, resellers and customers count for a specific distributor (Owner only)

Path parameters

  • id string Required

    Distributor Logto ID

Responses

  • 200 application/json

    Distributor stats retrieved successfully

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object

      Statistics for a distributor (users, systems, resellers, customers and applications count)

      Hide data attributes Show data attributes object
      • users_count integer

        Number of users in the distributor organization

      • systems_count integer

        Number of systems in the distributor organization

      • resellers_count integer

        Number of resellers created by this distributor

      • customers_count integer

        Number of customers in the distributor hierarchy (via resellers)

      • applications_count integer

        Number of applications directly associated with this distributor

      • applications_hierarchy_count integer

        Total number of applications in the distributor hierarchy (distributor + resellers + customers)
  • 400 application/json

    Bad request - validation error

    Hide response attributes Show response attributes object
    • code integer

      HTTP error code

    • message string

      Error message

    • data object
      Hide data attributes Show data attributes object
      • type string

        Type of error

        Values are validation_error or external_api_error.

      • errors array[object]
        Hide errors attributes Show errors attributes object
        • key string

          Field name that failed validation

        • message string

          Error code or message

        • value string

          Value that failed validation

      • details

        Additional error details
  • 401 application/json

    Unauthorized - invalid or missing token

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
  • 403 application/json

    Forbidden - insufficient permissions

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
  • 404 application/json

    Resource not found

    Hide response attributes Show response attributes object
    • code integer

      HTTP error code

    • message string

      Error message

    • data object
      Hide data attributes Show data attributes object
      • type string

        Type of error

        Values are validation_error or external_api_error.

      • errors array[object]
        Hide errors attributes Show errors attributes object
        • key string

          Field name that failed validation

        • message string

          Error code or message

        • value string

          Value that failed validation

      • details

        Additional error details
GET /distributors/{id}/stats 
curl \
 --request GET 'https://api.your-domain.com/api/distributors/{id}/stats' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "code": 200,
  "message": "distributor stats retrieved successfully",
  "data": {
    "users_count": 980,
    "systems_count": 32,
    "resellers_count": 25,
    "customers_count": 420,
    "applications_count": 50,
    "applications_hierarchy_count": 3246
  }
}
Response examples (400) 
{
  "code": 400,
  "message": "validation failed",
  "data": {
    "type": "validation_error",
    "errors": [
      {
        "key": "username",
        "message": "required",
        "value": "string"
      }
    ]
  }
}
Response examples (401) 
{
  "code": 401,
  "message": "invalid token",
  "data": {}
}
Response examples (403) 
{
  "code": 403,
  "message": "insufficient permissions",
  "data": {}
}
Response examples (404) 
{
  "code": 400,
  "message": "validation failed",
  "data": {
    "type": "validation_error",
    "errors": [
      {
        "key": "username",
        "message": "required",
        "value": "string"
      }
    ]
  }
}