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

# Analyze Employee performance evidence

> Return a pageable factual ranking and review signals from Team Pulse and Glow Moments for only the Employees visible to the member. It never recommends an employment decision.

Use when: Use first for best-performer, needs-attention, strengths, weaknesses, or workforce-comparison requests; follow nextOffset until null for the complete filtered cohort. Returns: factual visible-cohort ranks, performance scores, measured evidence, attention signals, counts, pagination, and guidance for human review.



## OpenAPI

````yaml /specs/openapi/jointl-api-v1.openapi.yaml post /api/v1/operations/employees.analytics
openapi: 3.1.2
info:
  title: Jointl REST API and OAuth
  version: 1.0.0
  summary: Supported public HTTP contract for Jointl third-party connections.
  description: >-
    HTTP contract for Jointl REST operations, OAuth, and Zapier subscription and
    action endpoints. Jointl does not provide a public sandbox.
  termsOfService: https://join.tl/legal/terms-of-service
  contact:
    name: Jointl Support
    url: https://join.tl
servers:
  - url: https://api.join.tl
    description: Jointl production API
security: []
tags:
  - name: OAuth
    description: OAuth 2.0 and OpenID Connect endpoints.
  - name: Discovery
    description: OAuth resource and issuer discovery.
  - name: Operations
    description: Permission-filtered read operations.
  - name: Actions
    description: Prepare, human approval, and confirmation.
  - name: Zapier
    description: Endpoints restricted to the approved Jointl Zapier app.
paths:
  /api/v1/operations/employees.analytics:
    post:
      tags:
        - Operations
      summary: Analyze Employee performance evidence
      description: >-
        Return a pageable factual ranking and review signals from Team Pulse and
        Glow Moments for only the Employees visible to the member. It never
        recommends an employment decision.


        Use when: Use first for best-performer, needs-attention, strengths,
        weaknesses, or workforce-comparison requests; follow nextOffset until
        null for the complete filtered cohort. Returns: factual visible-cohort
        ranks, performance scores, measured evidence, attention signals, counts,
        pagination, and guidance for human review.
      operationId: executeEmployeesAnalytics
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmployeesAnalyticsInput'
            example: {}
      responses:
        '200':
          description: Operation completed.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/EmployeesAnalyticsResult'
                  requestId:
                    type: string
                    description: Request correlation identifier.
                required:
                  - data
                  - requestId
                additionalProperties: false
              example:
                data:
                  evaluatedEmployeeCount: 1
                  evidenceWindow:
                    endDate: '2026-01-15T00:00:00.000Z'
                    inclusive: true
                    startDate: '2026-01-15T00:00:00.000Z'
                    timeZone: UTC
                  exactCohort: false
                  hasMore: false
                  items:
                    - {}
                  nextOffset: 1
                  offset: 1
                  returnedEmployeeCount: 1
                  safety: {}
                  scoredEmployeeCount: 75
                requestId: request_example_01
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '413':
          $ref: '#/components/responses/TooLarge'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          $ref: '#/components/responses/Unavailable'
      security:
        - JointlOAuth:
            - workspace.read
        - JointlApiKey: []
components:
  schemas:
    EmployeesAnalyticsInput:
      additionalProperties: false
      properties:
        endDate:
          description: >-
            Inclusive UTC evidence end date in YYYY-MM-DD. Omit both dates for
            the trailing six-month default.
          pattern: ^\d{4}-\d{2}-\d{2}$
          type: string
        limit:
          default: 25
          maximum: 100
          minimum: 1
          type: integer
        offset:
          default: 0
          maximum: 499
          minimum: 0
          type: integer
        selectedCompanies:
          default: []
          description: >-
            Exact Jointl company IDs; empty means every authorized company,
            subject to the cohort bound.
          items:
            maxLength: 128
            minLength: 1
            pattern: ^[A-Za-z0-9_-]+$
            type: string
          maxItems: 100
          type: array
        selectedEmployeeStatus:
          default:
            - active
          description: >-
            Defaults to active Employees. Pass an empty array to include every
            authorized Employee status.
          items:
            enum:
              - active
              - left
            type: string
          maxItems: 100
          type: array
        selectedTags:
          default: []
          description: Exact Jointl tag IDs; empty means every tag.
          items:
            maxLength: 128
            minLength: 1
            pattern: ^[A-Za-z0-9_-]+$
            type: string
          maxItems: 100
          type: array
        startDate:
          description: >-
            Inclusive UTC evidence start date in YYYY-MM-DD. Omit both dates for
            the trailing six-month default.
          pattern: ^\d{4}-\d{2}-\d{2}$
          type: string
      type: object
    EmployeesAnalyticsResult:
      additionalProperties: true
      properties:
        evaluatedEmployeeCount:
          type: number
        evidenceWindow:
          additionalProperties: true
          properties:
            endDate:
              type:
                - string
                - 'null'
            inclusive:
              type: boolean
            startDate:
              type:
                - string
                - 'null'
            timeZone:
              type: string
          required:
            - startDate
            - endDate
            - inclusive
            - timeZone
          type: object
        exactCohort:
          type: boolean
        hasMore:
          type: boolean
        items:
          items:
            additionalProperties: true
            properties:
              attentionSignals:
                type: array
                items:
                  type: string
              detailOperation:
                type: string
              employeeId:
                type: string
              evidenceSummary:
                type: string
              name:
                type: string
              performanceScore:
                type:
                  - number
                  - 'null'
              performanceScorePercent:
                type:
                  - number
                  - 'null'
              rankWithinVisibleCohort:
                type:
                  - number
                  - 'null'
              visibleCohortSize:
                type: number
            type: object
          type: array
        nextOffset:
          type:
            - number
            - 'null'
        offset:
          type: number
        returnedEmployeeCount:
          type: number
        safety:
          additionalProperties: true
          type: object
        scoredEmployeeCount:
          type: number
      required:
        - items
        - evaluatedEmployeeCount
        - scoredEmployeeCount
        - returnedEmployeeCount
        - offset
        - nextOffset
        - evidenceWindow
        - exactCohort
        - hasMore
        - safety
      type: object
    ErrorEnvelope:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
          additionalProperties: false
        requestId:
          type: string
      required:
        - error
        - requestId
      additionalProperties: false
  headers:
    RequestId:
      description: Request correlation identifier.
      schema:
        type: string
    RetryAfter:
      description: Seconds before retrying.
      schema:
        type: integer
        minimum: 1
  responses:
    BadRequest:
      description: Invalid request.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: invalid-external-operation-input
              message: The operation input is invalid.
            requestId: request_example_400
    Unauthorized:
      description: Authentication required.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: not-authenticated
              message: Authentication is required.
            requestId: request_example_401
    Forbidden:
      description: Insufficient scope or permission.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: not-authorized
              message: You are not allowed to perform this action.
            requestId: request_example_403
    NotFound:
      description: The operation or visible record was not found.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: not-found
              message: The requested record was not found.
            requestId: request_example_404
    Conflict:
      description: State, replay, or idempotency conflict.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: external-action-conflict
              message: The action conflicts with current state.
            requestId: request_example_409
    TooLarge:
      description: Request exceeds one MiB.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: request-too-large
              message: The request body is too large.
            requestId: request_example_413
    RateLimited:
      description: Rate limit exceeded.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: too-many-requests
              message: Too many requests.
            requestId: request_example_429
    ServerError:
      description: Server error.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: internal-error
              message: The request could not be completed.
            requestId: request_example_500
    Unavailable:
      description: Temporarily unavailable or action outcome unknown.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: temporarily-unavailable
              message: The service is temporarily unavailable.
            requestId: request_example_503
  securitySchemes:
    JointlOAuth:
      type: oauth2
      description: OAuth access token issued for the REST resource.
      flows:
        authorizationCode:
          authorizationUrl: https://api.join.tl/oauth/authorize
          tokenUrl: https://api.join.tl/oauth/token
          refreshUrl: https://api.join.tl/oauth/token
          scopes:
            openid: Authenticate the Jointl member.
            email: Read the authorized member email claim.
            workspace.read: Read authorized Jointl workspace data.
            workspace.write: Prepare and confirm authorized Jointl changes.
            offline_access: Receive a rotating refresh token.
      x-jointl-resource: https://api.join.tl/api/v1
      x-jointl-pkce-required: S256
    JointlApiKey:
      type: http
      scheme: bearer
      bearerFormat: Jointl personal or service-account API key
      description: >-
        Server-side personal or service credential. Never embed in browser or
        hosted AI clients.

````