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

# Get users



## OpenAPI

````yaml get /users
openapi: 3.0.0
info:
  version: 1.0.0
  title: Tusk Analytics API
servers:
  - url: https://use-tusk.uc.r.appspot.com/api/v1/analytics
security: []
paths:
  /users:
    get:
      tags:
        - Analytics
      summary: Get users
      parameters:
        - schema:
            type: string
            description: Start date to filter by (inclusive)
            format: date-time
          required: false
          name: startDate
          in: query
        - schema:
            type: string
            description: End date to filter by (inclusive)
            format: date-time
          required: false
          name: endDate
          in: query
        - schema:
            type: array
            description: Repo IDs to filter by
            items:
              type: number
          required: false
          name: repoIds
          in: query
        - schema:
            type: array
            description: GitHub/GitLab usernames to filter by
            items:
              type: string
          required: false
          name: usernames
          in: query
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    clientId:
                      type: string
                      format: uuid
                    prExternalCreatorId:
                      type: string
                      description: GitHub/GitLab username of PR creator
                    hasActiveSeat:
                      type: boolean
                      description: Whether the user has an active seat
                    totalUniquePrs:
                      type: number
                      description: Number of PRs processed by Tusk
                    prsWithTests:
                      type: number
                      description: Number of PRs with Tusk tests generated
                    prsWithFullyIncorporatedTests:
                      type: number
                      description: Number of PRs with all of Tusk tests incorporated
                    prsWithPartiallyIncorporatedTests:
                      type: number
                      description: Number of PRs with some of Tusk tests incorporated
                    prsWithAnyIncorporatedTests:
                      type: number
                      description: Number of PRs with any of Tusk tests incorporated
                    numTestsIncorporated:
                      type: number
                      description: Number of individual tests incorporated
                    numFailedTestsIncorporated:
                      type: number
                      description: >-
                        Number of individual failing tests incorporated (i.e.
                        potential bugs Tusk detected)
                    totalViews:
                      type: number
                      description: >-
                        Total number of views of Tusk output in GitHub/GitLab or
                        Tusk UI
                  required:
                    - clientId
                    - prExternalCreatorId
                    - hasActiveSeat
                    - totalUniquePrs
                    - prsWithTests
                    - prsWithFullyIncorporatedTests
                    - prsWithPartiallyIncorporatedTests
                    - prsWithAnyIncorporatedTests
                    - numTestsIncorporated
                    - numFailedTestsIncorporated
                    - totalViews
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````