> ## 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.

# Get Jointl Insights

> Return the General, Performance, or Exit Intelligence view available to the member for an inclusive UTC date range, using the same calculations shown in Jointl.

Use when: Use for workspace activity and completion metrics, team performance evidence, or Exit Intelligence themes; select one view and supply both dates when the user specifies a period. Returns: the selected Insights dataset plus the applied view, inclusive UTC dates, and company, Flow, and role filters.



## OpenAPI

````yaml /specs/openapi/jointl-api-v1.openapi.yaml post /api/v1/operations/insights.get
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/insights.get:
    post:
      tags:
        - Operations
      summary: Get Jointl Insights
      description: >-
        Return the General, Performance, or Exit Intelligence view available to
        the member for an inclusive UTC date range, using the same calculations
        shown in Jointl.


        Use when: Use for workspace activity and completion metrics, team
        performance evidence, or Exit Intelligence themes; select one view and
        supply both dates when the user specifies a period. Returns: the
        selected Insights dataset plus the applied view, inclusive UTC dates,
        and company, Flow, and role filters.
      operationId: executeInsightsGet
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsightsGetInput'
            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/InsightsGetResult'
                  requestId:
                    type: string
                    description: Request correlation identifier.
                required:
                  - data
                  - requestId
                additionalProperties: false
              example:
                data:
                  data:
                    summary:
                      activeChecks: 12
                      activeEmployees: 34
                  dateRange:
                    endDate: '2026-01-15T00:00:00.000Z'
                    inclusive: true
                    startDate: '2025-07-15T00:00:00.000Z'
                    timeZone: UTC
                  filters:
                    companyIds: []
                    flowIds: []
                    roleTitles: []
                  view: general
                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:
    InsightsGetInput:
      additionalProperties: false
      properties:
        endDate:
          description: >-
            Inclusive UTC end date in YYYY-MM-DD. Omit both dates for the
            trailing six-month default.
          pattern: ^\d{4}-\d{2}-\d{2}$
          type: string
        selectedCompanies:
          default: []
          description: >-
            Exact authorized Jointl company IDs; empty means every authorized
            company.
          items:
            maxLength: 128
            minLength: 1
            pattern: ^[A-Za-z0-9_-]+$
            type: string
          maxItems: 100
          type: array
        selectedFlows:
          default: []
          description: >-
            Exact authorized Flow IDs; empty means every authorized Flow for
            this view.
          items:
            maxLength: 128
            minLength: 1
            pattern: ^[A-Za-z0-9_-]+$
            type: string
          maxItems: 100
          type: array
        selectedRoles:
          default: []
          description: Exact Employee role-title labels; empty means every authorized role.
          items:
            maxLength: 180
            minLength: 1
            type: string
          maxItems: 100
          type: array
        startDate:
          description: >-
            Inclusive UTC start date in YYYY-MM-DD. Omit both dates for the
            trailing six-month default.
          pattern: ^\d{4}-\d{2}-\d{2}$
          type: string
        view:
          default: general
          description: >-
            general maps to /insights, performance to
            /insights?view=performance, and exitIntelligence to
            /insights?view=exit-intelligence.
          enum:
            - general
            - performance
            - exitIntelligence
          type: string
      type: object
    InsightsGetResult:
      additionalProperties: true
      properties:
        data:
          additionalProperties: true
          type: object
        dateRange:
          additionalProperties: true
          properties:
            endDate:
              type: string
            inclusive:
              type: boolean
            startDate:
              type: string
            timeZone:
              type: string
          required:
            - startDate
            - endDate
            - inclusive
            - timeZone
          type: object
        filters:
          additionalProperties: true
          properties:
            companyIds:
              type: array
              items:
                type: string
            flowIds:
              type: array
              items:
                type: string
            roleTitles:
              type: array
              items:
                type: string
          required:
            - companyIds
            - flowIds
            - roleTitles
          type: object
        view:
          type: string
      required:
        - view
        - dateRange
        - filters
        - data
      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.

````