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

# Get a stat view

> Returns a readable saved view's stat definition IDs, employee filter, creator, sharing settings, current version, and caller-specific permissions. visibility describes whether all, some, or none of the filter's matching employees are accessible to this caller, or whether the filter has no matches. It does not indicate whether stats exist. Missing, archived, and unreadable views return 404. Requires access to Analytics in the workspace. Sharing a view shares its saved selections; each viewer can still read only the employee stats their own permissions allow.



## OpenAPI

````yaml https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/stats/views/{id}
openapi: 3.1.0
info:
  title: Windmill API
  version: 2.0.0
  description: >-
    Use the Windmill API to integrate your systems, automate workflows, and
    build applications on your organization's data. Authenticate with an API key
    or OAuth access token. Each request uses the authenticated user's
    permissions within the selected workspace.
servers:
  - url: https://api.gowindmill.com/api/v2
security:
  - bearerAuth: []
paths:
  /c/{companyId}/stats/views/{id}:
    get:
      tags:
        - Stat views
      summary: Get a stat view
      description: >-
        Returns a readable saved view's stat definition IDs, employee filter,
        creator, sharing settings, current version, and caller-specific
        permissions. visibility describes whether all, some, or none of the
        filter's matching employees are accessible to this caller, or whether
        the filter has no matches. It does not indicate whether stats exist.
        Missing, archived, and unreadable views return 404. Requires access to
        Analytics in the workspace. Sharing a view shares its saved selections;
        each viewer can still read only the employee stats their own permissions
        allow.
      operationId: stats.views.get
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 128
            description: >-
              Company ID. A URL slug is also accepted. The caller must have
              access to this company.
            title: Company ID
            example: company-acme
          required: true
          description: >-
            Company ID. A URL slug is also accepted. The caller must have access
            to this company.
          name: companyId
          in: path
        - schema:
            type: string
            format: uuid
            description: UUID of an active saved stat view in this workspace.
            title: Stat view ID
            example: 22222222-2222-4222-8222-222222222222
          required: true
          description: UUID of an active saved stat view in this workspace.
          name: id
          in: path
      responses:
        '200':
          description: Stat view configuration and viewer-specific visibility
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatViewDetailResponse'
        '400':
          description: Bad request or request validation failed
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - BAD_REQUEST
                          message:
                            type: string
                          requestId:
                            type: string
                        required:
                          - code
                          - message
                          - requestId
                    required:
                      - error
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - VALIDATION_ERROR
                          message:
                            type: string
                          requestId:
                            type: string
                          details:
                            type: array
                            items:
                              type: object
                              properties:
                                path:
                                  type: array
                                  items:
                                    anyOf:
                                      - type: string
                                      - type: number
                                message:
                                  type: string
                              required:
                                - path
                                - message
                        required:
                          - code
                          - message
                          - requestId
                          - details
                    required:
                      - error
        '401':
          description: >-
            Authentication is missing or invalid. Send a valid API key or OAuth
            access token in the Authorization: Bearer <TOKEN> header before
            retrying.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - UNAUTHORIZED
                      message:
                        type: string
                      requestId:
                        type: string
                    required:
                      - code
                      - message
                      - requestId
                required:
                  - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - FORBIDDEN
                      message:
                        type: string
                      requestId:
                        type: string
                    required:
                      - code
                      - message
                      - requestId
                required:
                  - error
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - NOT_FOUND
                      message:
                        type: string
                      requestId:
                        type: string
                    required:
                      - code
                      - message
                      - requestId
                required:
                  - error
        '429':
          description: >-
            The API-client request budget is exhausted. API keys allow 500
            requests per minute per key; OAuth clients allow 500 per minute per
            client and workspace. Reads and writes share the budget. One HTTP
            request counts once, including bulk requests. Wait for the
            Retry-After delay before retrying.
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request.
              required: true
              schema:
                type: integer
                minimum: 0
                example: 42
            RateLimit:
              description: >-
                Current request budget: limit is the maximum count, remaining is
                the unused count, and reset is seconds until the window resets,
                not a timestamp.
              required: true
              schema:
                type: string
                example: limit=500, remaining=0, reset=42
            RateLimit-Policy:
              description: >-
                Request limit and window length in seconds, formatted as
                <limit>;w=<seconds>.
              required: true
              schema:
                type: string
                example: 500;w=60
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - RATE_LIMITED
                      message:
                        type: string
                      requestId:
                        type: string
                    required:
                      - code
                      - message
                      - requestId
                required:
                  - error
      security:
        - bearerAuth: []
components:
  schemas:
    StatViewDetailResponse:
      type: object
      properties:
        view:
          $ref: '#/components/schemas/StatViewDetail'
      required:
        - view
      title: Stat view details response
    StatViewDetail:
      allOf:
        - $ref: '#/components/schemas/StatViewSummary'
        - type: object
          properties:
            statMetadataIds:
              type: array
              items:
                type: string
                format: uuid
              description: Saved stat definition UUIDs in display order.
              title: Stat definition IDs
              example:
                - 11111111-1111-4111-8111-111111111111
            employeeFilter:
              $ref: '#/components/schemas/ComplexEmployeeFilter'
            visibility:
              type: string
              enum:
                - full
                - partial
                - noneAccessible
                - noMatches
              description: >-
                Employee coverage for this caller: full means every matching
                employee is accessible; partial means some are accessible;
                noneAccessible means employees match but none are accessible;
                noMatches means the saved filter matches no employees. This
                describes employee access, not whether stat data exists.
              title: Employee visibility
              example: full
          required:
            - statMetadataIds
            - employeeFilter
            - visibility
      title: Stat view
      description: Readable saved configuration and employee coverage.
    StatViewSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Saved stat view UUID.
          title: Stat view ID
          example: 22222222-2222-4222-8222-222222222222
        name:
          type: string
          description: Display name of the saved view.
          title: View name
          example: Engineering activity
        createdAt:
          type: string
          description: Creation time as an ISO 8601 timestamp.
          title: Created at
          example: '2026-01-01T10:00:00.000Z'
        updatedAt:
          type: string
          description: Last change time as an ISO 8601 timestamp.
          title: Updated at
          example: '2026-01-01T10:00:00.000Z'
        version:
          type: integer
          exclusiveMinimum: 0
          description: >-
            Current version. Send this as expectedVersion when updating or
            changing sharing.
          title: Version
          example: 1
        creator:
          $ref: '#/components/schemas/StatViewCreator'
        sharingAccess:
          $ref: '#/components/schemas/StatViewSharingAccess'
        isOwner:
          type: boolean
          description: Whether the authenticated workspace member created this view.
          title: Is owner
          example: true
        canWrite:
          type: boolean
          description: >-
            Whether the caller can modify, share, or archive the view. Only its
            owner can.
          title: Can edit
          example: true
      required:
        - id
        - name
        - createdAt
        - updatedAt
        - version
        - creator
        - sharingAccess
        - isOwner
        - canWrite
      title: Stat view summary
      description: >-
        Saved view identity, creator, version, sharing, and caller-specific
        permissions.
    ComplexEmployeeFilter:
      type: object
      properties:
        hasDirectReports:
          type:
            - boolean
            - 'null'
          description: >-
            True selects managers with a direct report; false selects employees
            without direct reports.
          title: Has direct reports
          example: true
        hasManager:
          type:
            - boolean
            - 'null'
          description: >-
            True selects employees with an assigned manager; false selects
            employees without a manager.
          title: Has a manager
          example: true
        employeeGroupId:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 128
          description: Select employees belonging to this employee group.
          title: Employee group ID
          example: group-engineering
        employeeGroupIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: Select members of any listed employee group. Up to 1000 IDs.
          title: Employee group IDs
          example:
            - group-engineering
        jobTitle:
          type:
            - string
            - 'null'
          maxLength: 256
          description: Select employees whose job title exactly matches this value.
          title: Exact job title
          example: Engineer
        jobTitles:
          type:
            - array
            - 'null'
          items:
            type: string
            maxLength: 256
          maxItems: 1000
          description: >-
            Select employees whose job title exactly matches any listed value.
            Up to 1000 titles.
          title: Exact job titles
          example:
            - Engineer
            - Designer
        countries:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: >-
            Select employees whose HRIS work country matches any listed country
            code. Up to 1000 values.
          title: Work countries
          example:
            - US
        emails:
          type:
            - array
            - 'null'
          items:
            type: string
            maxLength: 320
            format: email
          maxItems: 1000
          description: >-
            Select employees associated with any listed email address. Up to
            1000 valid addresses.
          title: Employee email addresses
          example:
            - avery@example.test
        emailDomains:
          type:
            - array
            - 'null'
          items:
            type: string
            maxLength: 254
          maxItems: 1000
          description: >-
            Select employees with an email address on any listed domain. A
            domain matches exactly, so subdomains are listed separately. Up to
            1000 values.
          title: Employee email domains
          example:
            - example.test
        employeeId:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 128
          description: Select a single employee by ID.
          title: Employee ID
          example: employee-avery
        employeeIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: Select employees with any listed ID. Up to 1000 IDs.
          title: Employee IDs
          example:
            - employee-avery
        excludedEmployeeId:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 128
          description: Exclude this employee from the results.
          title: Excluded employee ID
          example: employee-excluded
        excludedEmployeeIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: >-
            Exclude employees with any listed ID. Use this field for exclusions
            in API bulk mutations. Up to 1000 IDs.
          title: Excluded employee IDs
          example:
            - employee-excluded
        managerId:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 128
          description: Select direct reports of this manager; exclude deeper reports.
          title: Direct manager ID
          example: employee-morgan
        managerIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: >-
            Select direct reports of any listed manager, at depth 1. Up to 1000
            manager IDs.
          title: Direct manager IDs
          example:
            - employee-morgan
        ancestorManagerId:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 128
          description: Select direct and indirect reports below this manager at any depth.
          title: Ancestor manager ID
          example: employee-morgan
        ancestorManagerIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: >-
            Select anyone below any listed manager, at depth 1 or greater. Up to
            1000 manager IDs.
          title: Ancestor manager IDs
          example:
            - employee-morgan
        indirectManagerId:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 128
          description: >-
            Select reports at depth 2 or greater below this manager; exclude
            direct reports.
          title: Indirect manager ID
          example: employee-morgan
        indirectManagerIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: >-
            Select reports at depth 2 or greater below any listed manager. Up to
            1000 manager IDs.
          title: Indirect manager IDs
          example:
            - employee-morgan
        isMember:
          type:
            - boolean
            - 'null'
          description: >-
            True selects employees with active workspace membership; false
            selects employees without a member link or with inactive membership.
          title: Has active workspace membership
          example: true
        memberRole:
          type:
            - string
            - 'null'
          enum:
            - admin
            - hr-admin
            - integration-manager
            - data-analyst
            - team-member
            - null
          description: Select employees associated with this workspace member role.
          title: Workspace role
          example: team-member
        query:
          type:
            - string
            - 'null'
          maxLength: 256
          description: >-
            Search employee names, preferred names, and the part of each
            employee email before the @. Names also match close spellings. Job
            titles and email domains are not searched; use jobTitle to filter by
            title. A top-level query controls the default relevance ordering.
          title: Employee search text
          example: Avery
        platformAccess:
          type:
            - string
            - 'null'
          enum:
            - HAS_ACCESS
            - INVITE_PENDING
            - NO_ACCESS
            - null
          description: >-
            HAS_ACCESS selects active access; INVITE_PENDING selects pending
            invitations; NO_ACCESS selects employees without access.
          title: Workspace access status
          example: HAS_ACCESS
        startDate:
          anyOf:
            - type: object
              properties:
                range:
                  type: string
                  minLength: 1
                  maxLength: 128
              required:
                - range
              additionalProperties: false
            - type: object
              properties:
                from:
                  anyOf:
                    - type: string
                      format: date
                    - type: string
                      format: date-time
                  description: ISO 8601 date or datetime. Inclusive lower bound.
                to:
                  anyOf:
                    - type: string
                      format: date
                    - type: string
                      format: date-time
                  description: ISO 8601 date or datetime. Inclusive upper bound.
              additionalProperties: false
            - type: 'null'
          description: >-
            Select start dates within inclusive date bounds or a supported named
            date range.
          title: Start-date range
          example:
            from: '2025-01-01'
            to: '2025-12-31'
        isAccountAdmin:
          type:
            - boolean
            - 'null'
          description: >-
            True selects account administrators; false selects employees who are
            not account administrators.
          title: Account administrator
          example: false
        hasIntegrationIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: >-
            Select employees linked to every listed integration identifier. Up
            to 1000 IDs.
          title: Linked integrations
          example:
            - slack
        lacksIntegrationIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: >-
            Select employees without links to the listed integration
            identifiers. Up to 1000 IDs.
          title: Unlinked integrations
          example:
            - slack
        includeArchived:
          type:
            - boolean
            - 'null'
          description: Include archived employees in addition to current employees.
          title: Include former employees
          example: false
        onlyArchived:
          type:
            - boolean
            - 'null'
          description: Select only archived employees.
          title: Former employees only
          example: false
        includeExternalOrgs:
          type:
            - boolean
            - 'null'
          description: Include employees outside the primary organization.
          title: Include other organizations
          example: false
        and:
          type: array
          items:
            $ref: '#/components/schemas/ComplexEmployeeFilter'
          maxItems: 49
          description: >-
            All child filters must match, in addition to the other predicates in
            this filter. Up to 49 children.
          title: All conditions
        or:
          type: array
          items:
            $ref: '#/components/schemas/ComplexEmployeeFilter'
          maxItems: 49
          description: >-
            At least one child filter must match, in addition to the other
            predicates in this filter. Up to 49 children.
          title: Any condition
      additionalProperties: false
      description: Employee selection saved in this view.
      title: Saved employee filter
      example: {}
    StatViewCreator:
      type: object
      properties:
        id:
          type: string
          description: Employee ID of the view's creator.
          title: Creator employee ID
          example: employee-morgan
        firstName:
          type:
            - string
            - 'null'
          description: Creator's first name, or null when unavailable.
          title: First name
          example: Morgan
        lastName:
          type:
            - string
            - 'null'
          description: Creator's last name, or null when unavailable.
          title: Last name
          example: Lee
        avatarUrl:
          type:
            - string
            - 'null'
          description: Creator's avatar URL, or null when unset.
          title: Avatar URL
          example: null
        archivedAt:
          type:
            - string
            - 'null'
          description: >-
            Creator employee's archive time as an ISO 8601 timestamp, or null
            when active.
          title: Archived at
          example: null
      required:
        - id
        - firstName
        - lastName
        - avatarUrl
        - archivedAt
      title: Creator
      description: Employee profile of the view's creator.
    StatViewSharingAccess:
      type: object
      properties:
        companyAccess:
          type: string
          enum:
            - none
            - read
            - write
          description: Workspace-wide sharing level.
          title: Workspace access
          example: read
        employeeAccess:
          type: array
          items:
            type: object
            properties:
              employeeId:
                type: string
                minLength: 1
                description: >-
                  Employee ID in this workspace. For a subtree grant, identifies
                  its root employee.
                title: Employee ID
                example: employee-avery
              access:
                type: string
                enum:
                  - none
                  - read
                  - write
                description: >-
                  Sharing level: none, read, or write. Only the owner can write
                  a stat view.
                title: Access level
                example: read
            required:
              - employeeId
              - access
          description: Direct employee sharing grants, including the owner's access.
          title: Employee access
        groupAccess:
          type: array
          items:
            type: object
            properties:
              groupId:
                type: string
                minLength: 1
                description: >-
                  ID of an employee group in this workspace that the caller can
                  read.
                title: Group ID
                example: group-engineering
              access:
                type: string
                enum:
                  - none
                  - read
                  - write
                description: >-
                  Sharing level: none, read, or write. Only the owner can write
                  a stat view.
                title: Access level
                example: read
            required:
              - groupId
              - access
          description: Sharing grants for members of employee groups.
          title: Group access
        automationAccess:
          type: array
          items:
            type: object
            properties:
              companyAutomationId:
                type: string
                minLength: 1
                description: >-
                  Workspace automation ID. Automation sharing is not supported
                  for stat views.
                title: Automation ID
              access:
                type: string
                enum:
                  - none
                  - read
                  - write
                description: >-
                  Sharing level: none, read, or write. Only the owner can write
                  a stat view.
                title: Access level
                example: read
            required:
              - companyAutomationId
              - access
          description: >-
            Automation grants. New stat view sharing requests do not support
            this audience.
          title: Automation access
          example: []
        subtreeAccess:
          type: array
          items:
            type: object
            properties:
              employeeId:
                type: string
                minLength: 1
                description: >-
                  Employee ID in this workspace. For a subtree grant, identifies
                  its root employee.
                title: Employee ID
                example: employee-avery
              access:
                type: string
                enum:
                  - none
                  - read
                  - write
                description: >-
                  Sharing level: none, read, or write. Only the owner can write
                  a stat view.
                title: Access level
                example: read
            required:
              - employeeId
              - access
          description: Reporting-team grants rooted at the named employee.
          title: Reporting team access
        allManagersAccess:
          type: string
          enum:
            - none
            - read
            - write
          description: Sharing level for all managers.
          title: All managers access
          example: read
        capabilitiesAccess:
          type: array
          items:
            type: object
            properties:
              capability:
                type: string
                minLength: 1
                description: >-
                  Capability name. Capability-based sharing is not supported for
                  stat views.
                title: Capability
              access:
                type: string
                enum:
                  - none
                  - read
                  - write
                description: >-
                  Sharing level: none, read, or write. Only the owner can write
                  a stat view.
                title: Access level
                example: read
            required:
              - capability
              - access
          description: >-
            Capability grants. New stat view sharing requests do not support
            this audience.
          title: Capability access
          example: []
      required:
        - companyAccess
        - employeeAccess
        - groupAccess
        - automationAccess
        - subtreeAccess
        - allManagersAccess
        - capabilitiesAccess
      title: Stat view sharing access
      description: >-
        Structured sharing grants for the saved configuration. Sharing a view
        does not grant access to the employees' stat data.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Use an API key or OAuth access token. Enter only the token in the
        authorization dialog; requests send it as `Authorization: Bearer
        <TOKEN>`.


        Create an API key in your workspace's **Settings → API keys**. Keys
        start with `wm_api_` and only work in the workspace where they were
        created. Read-only keys can read data; creating, updating, or deleting
        data requires a read-write key.


        ```http

        Authorization: Bearer wm_api_example

        ```


        OAuth access tokens are issued for connected Windmill applications.


        ```http

        Authorization: Bearer <OAUTH_ACCESS_TOKEN>

        ```


        Both token types use the authenticated user's workspace permissions.
        Each endpoint's permission requirements and the sharing settings of the
        requested items still apply.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.