> ## Documentation Index
> Fetch the complete documentation index at: https://developers.podero.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Aggregate member counts, status buckets and facets

> Org-wide aggregate for the console Users screen: member counts, per-status bucket counts
(a server-side count over the same per-member classification the users list serves), and the
facet options (OEMs and device kinds present) that drive the filter dropdowns — without the
client fetching the org's users or devices.

Backed by grouped queries whose count is constant in org device count, so it runs live on
every hit with no response cache.



## OpenAPI

````yaml https://app.podero.com/api/partners/v2.0/openapi.json get /api/partners/v2.0/org/{org_id}/users/summary
openapi: 3.1.0
info:
  title: Podero Partner API
  version: '2.0'
  description: >-
    This API provides a unified interaction point for Podero's partner
    companies.


    The goal of this API is to give partners easily integratable endpoints that
    don't require extensive software

    development. For this reason, the endpoints focus around user and device
    management, setting of preferences

    and high level device controls.


    While direct control of devices is implemented for special use cases such as
    pause power, we abstract away low level

    direct device steering so developers and partners can focus on delivering
    maximum value to end users.
  termsOfService: https://www.podero.com/terms-and-conditions
servers: []
security: []
paths:
  /api/partners/v2.0/org/{org_id}/users/summary:
    get:
      tags:
        - Users
      summary: Aggregate member counts, status buckets and facets
      description: >-
        Org-wide aggregate for the console Users screen: member counts,
        per-status bucket counts

        (a server-side count over the same per-member classification the users
        list serves), and the

        facet options (OEMs and device kinds present) that drive the filter
        dropdowns — without the

        client fetching the org's users or devices.


        Backed by grouped queries whose count is constant in org device count,
        so it runs live on

        every hit with no response cache.
      operationId: >-
        integrations_api_api_v2_organizations_users_router_retrieve_organization_users_summary
      parameters:
        - in: path
          name: org_id
          schema:
            description: The organization ID to summarise
            format: uuid
            title: Org Id
            type: string
          required: true
          description: The organization ID to summarise
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersSummaryOutput'
      security:
        - OAuth2: []
components:
  schemas:
    UsersSummaryOutput:
      description: >-
        Org-wide aggregate for the console Users screen. ``status_buckets``
        counts every member

        into exactly one classification bucket (so counts sum to
        ``total_members``), served in the

        console's fixed precedence order.
      properties:
        total_members:
          title: Total Members
          type: integer
        members_with_device:
          title: Members With Device
          type: integer
        status_buckets:
          items:
            $ref: '#/components/schemas/StatusBucketOutput'
          title: Status Buckets
          type: array
        facet_options:
          $ref: '#/components/schemas/UsersFacetOptionsOutput'
      required:
        - total_members
        - members_with_device
        - status_buckets
        - facet_options
      title: UsersSummaryOutput
      type: object
    StatusBucketOutput:
      properties:
        status:
          enum:
            - disabled
            - communication-error
            - steering-error
            - actions-required
            - troubleshooting
            - communication-warning
            - steering-warning
            - normal
          title: Status
          type: string
        count:
          title: Count
          type: integer
      required:
        - status
        - count
      title: StatusBucketOutput
      type: object
    UsersFacetOptionsOutput:
      description: >-
        The filter-dropdown options present across the org: distinct device OEMs
        (sorted) and the

        device kinds with at least one operational device (same tokens the
        users-list `device_kind`

        filter accepts, minus the `any` sentinel).
      properties:
        manufacturers:
          items:
            type: string
          title: Manufacturers
          type: array
        device_kinds:
          items:
            enum:
              - ev
              - hp
              - inv
              - wb
            type: string
          title: Device Kinds
          type: array
      required:
        - manufacturers
        - device_kinds
      title: UsersFacetOptionsOutput
      type: object
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        password:
          tokenUrl: /api/partners/v2.0/auth/token
          scopes: {}
        clientCredentials:
          tokenUrl: /api/partners/v2.0/auth/token
          scopes: {}

````