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

> What agents searched for, optionally for one agent.



## OpenAPI

````yaml /api-reference/management-openapi.yaml get /{agency_uid}/insights/engagements/searches
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/searches:
    get:
      tags:
        - Team / Engagement
      summary: Agent searches
      description: What agents searched for, optionally for one agent.
      parameters:
        - name: agency_uid
          in: path
          required: true
          schema:
            type: string
          description: Agency public_uid
        - name: agent
          in: query
          required: false
          schema:
            type: string
          example: user2@example.com
        - name: days
          in: query
          required: false
          schema:
            type: integer
          example: 30
        - name: suburb
          in: query
          required: false
          schema:
            type: string
          example: logan
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  summary:
                    type: object
                    properties:
                      total:
                        type: integer
                      nl_searches:
                        type: integer
                      failed:
                        type: integer
                      unique_users:
                        type: integer
                    required:
                      - total
                      - nl_searches
                      - failed
                      - unique_users
                  top_suburbs:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        count:
                          type: integer
                      required:
                        - value
                        - count
                  top_regions:
                    type: array
                    items: {}
                  top_bedrooms:
                    type: array
                    items: {}
                  price_buckets:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                        count:
                          type: integer
                      required:
                        - value
                        - count
                  recent_nl_queries:
                    type: array
                    items:
                      type: object
                      properties:
                        query:
                          type: string
                        created_at:
                          type: string
                        parse_failed:
                          type: boolean
                        agent_public_uid:
                          type: string
                      required:
                        - query
                        - created_at
                        - parse_failed
                        - agent_public_uid
                  failed_queries:
                    type: array
                    items: {}
                  filters:
                    type: object
                    properties:
                      agent:
                        type: string
                        nullable: true
                      suburb:
                        type: string
                        nullable: true
                    required:
                      - agent
                      - suburb
                  period:
                    type: object
                    properties:
                      days:
                        type: integer
                      from:
                        type: string
                      to:
                        type: string
                    required:
                      - days
                      - from
                      - to
                required:
                  - summary
                  - top_suburbs
                  - top_regions
                  - top_bedrooms
                  - price_buckets
                  - recent_nl_queries
                  - failed_queries
                  - filters
                  - period
              example:
                summary:
                  total: 1
                  nl_searches: 0
                  failed: 0
                  unique_users: 1
                top_suburbs:
                  - value: Ripley
                    count: 1
                top_regions: []
                top_bedrooms: []
                price_buckets:
                  - value: Under $400k
                    count: 0
                  - value: $400–500k
                    count: 0
                  - value: $500–600k
                    count: 0
                  - value: $600–700k
                    count: 0
                  - value: $700–800k
                    count: 0
                  - value: $800k+
                    count: 0
                recent_nl_queries: []
                failed_queries: []
                filters:
                  agent: USR-USER2-001
                  suburb: null
                period:
                  days: 7
                  from: '2026-09-13T09:31:23+10:00'
                  to: '2026-09-20T09:31:23+10:00'
        '422':
          description: Unprocessable Entity
          headers:
            Content-Type:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  candidates:
                    type: array
                    items:
                      type: object
                      properties:
                        public_uid:
                          type: string
                        name:
                          type: string
                        email:
                          type: string
                      required:
                        - public_uid
                        - name
                        - email
                required:
                  - candidates
              example:
                candidates:
                  - public_uid: USR-USER1-001
                    name: Sam Lee
                    email: user1@example.com
                  - public_uid: USR-USER2-001
                    name: Sam Leigh
                    email: user2@example.com
      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.