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

# Agent engagement

> The leaderboard, inactive agents and stats for a period.



## OpenAPI

````yaml /api-reference/management-openapi.yaml get /{agency_uid}/insights/engagements
openapi: 3.0.3
info:
  title: Kenekt Management API
  version: v1
  description: >-
    Manage an agency's stock and team: projects, lots, packages, designs,
    facades, developments, inclusions, commission rates, members and groups.


    Authenticate with an API key from a staff or admin member's account page,
    sent as `Authorization: Bearer YOUR_API_KEY`. A key works on every agency
    where its holder has a staff role; put that agency's public id in the path.


    This API is evolving: endpoints and fields may change without notice.
servers:
  - url: https://app.kenekt.com.au/v1
security: []
tags:
  - name: Stock / Projects
    description: 'Projects: a stage or release inside a development, grouping the lots.'
  - name: Stock / Lots
    description: Lots, their status, and moves between projects.
  - name: Stock / Packages
    description: 'Property packages: the sellable pairing of a lot with a design and facade.'
  - name: Stock / Designs
    description: Designs, their price tiers, rooms, and linked facades.
  - name: Stock / Facades
    description: Facades offered against designs.
  - name: Stock / Developments
    description: 'Developments: the estate or masterplanned community projects sit inside.'
  - name: Stock / Inclusions
    description: Inclusion packages, their items, and what they are linked to.
  - name: Stock / Commission Rates
    description: Commission rates and what they are applied to.
  - name: Stock / Attachments
    description: Photos and documents on any stock resource.
  - name: Stock / Library
    description: >-
      The whole library (designs, price tiers, facades, inclusions) as flat
      export rows.
  - name: Team / Members
    description: Members of the agency, their API keys, documents, and inclusions.
  - name: Team / Groups
    description: User groups and their memberships.
  - name: Team / Engagement
    description: >-
      Agent engagement: who is active, who has gone quiet, what they view and
      search for.
  - name: Agency
    description: The agency record and its settings.
  - name: Agency / Documents
    description: Agency-level documents.
  - name: EOIs
    description: Expressions of interest, purchasers, and sighted ID capture.
paths:
  /{agency_uid}/insights/engagements:
    get:
      tags:
        - Team / Engagement
      summary: Agent engagement
      description: The leaderboard, inactive agents and stats for a period.
      parameters:
        - name: agency_uid
          in: path
          required: true
          schema:
            type: string
          description: Agency public_uid
        - name: days
          in: query
          required: false
          schema:
            type: integer
          example: 30
        - name: sort
          in: query
          required: false
          schema:
            type: string
          example: views
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  engagements:
                    type: array
                    items:
                      type: object
                      properties:
                        public_uid:
                          type: string
                        name:
                          type: string
                        email:
                          type: string
                        phone:
                          nullable: true
                        last_active_on:
                          nullable: true
                        views:
                          type: integer
                        searches:
                          type: integer
                        flyers:
                          type: integer
                        lists:
                          type: integer
                        enquiries:
                          type: integer
                      required:
                        - public_uid
                        - name
                        - email
                        - phone
                        - last_active_on
                        - views
                        - searches
                        - flyers
                        - lists
                        - enquiries
                  inactive:
                    type: array
                    items:
                      type: object
                      properties:
                        public_uid:
                          type: string
                          nullable: true
                        name:
                          type: string
                        email:
                          type: string
                        phone:
                          nullable: true
                        last_active_on:
                          nullable: true
                      required:
                        - public_uid
                        - name
                        - email
                        - phone
                        - last_active_on
                  stalled_invitations:
                    type: array
                    items:
                      type: object
                      properties:
                        public_uid:
                          type: string
                        name:
                          type: string
                        email:
                          type: string
                        phone:
                          nullable: true
                        last_active_on:
                          nullable: true
                        link_sent_at:
                          type: string
                        link_expires_at:
                          type: string
                      required:
                        - public_uid
                        - name
                        - email
                        - phone
                        - last_active_on
                        - link_sent_at
                        - link_expires_at
                  stalled_sign_ins:
                    type: array
                    items: {}
                  period:
                    type: object
                    properties:
                      days:
                        type: integer
                      from:
                        type: string
                      to:
                        type: string
                    required:
                      - days
                      - from
                      - to
                  sort:
                    type: string
                required:
                  - engagements
                  - inactive
                  - stalled_invitations
                  - stalled_sign_ins
                  - period
                  - sort
              example:
                engagements:
                  - public_uid: USR-USER1-001
                    name: User One
                    email: user1@example.com
                    phone: null
                    last_active_on: null
                    views: 1
                    searches: 0
                    flyers: 0
                    lists: 0
                    enquiries: 0
                inactive:
                  - public_uid: USR-USER2-001
                    name: User Two
                    email: user2@example.com
                    phone: null
                    last_active_on: null
                  - public_uid: null
                    name: BDM User
                    email: bdm@example.com
                    phone: null
                    last_active_on: null
                stalled_invitations:
                  - public_uid: USR-USER2-001
                    name: User Two
                    email: user2@example.com
                    phone: null
                    last_active_on: null
                    link_sent_at: '2026-09-14T14:02:38+10:00'
                    link_expires_at: '2026-09-14T14:32:38+10:00'
                stalled_sign_ins: []
                period:
                  days: 30
                  from: '2026-08-15T14:02:38+10:00'
                  to: '2026-09-14T14:02:38+10:00'
                sort: views
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  required:
                    type: string
                  granted:
                    type: array
                    items:
                      type: string
                required:
                  - error
              example:
                error: Insufficient scope
                required: insights
                granted:
                  - projects
      security:
        - bearer_auth: []
components:
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: Token

````

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