find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/lucidworks-signals-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Lucidworks Signals API
  description: The Signals API captures and retrieves user behavior signals for click, query, cart-add, and purchase-complete events. Signals power relevance tuning, recommendations, and analytics across Lucidworks Commerce Studio and Analytics Studio.
  version: 1.0.0
  contact:
    name: Lucidworks Support
    url: https://lucidworks.com/support
servers:
- url: https://api.lucidworks.ai
security:
- bearerAuth: []
tags:
- name: Signals
  description: Capture and retrieve user behavior signals
paths:
  /signals/click:
    get:
      tags:
      - Signals
      summary: Get click signals
      operationId: getClickSignals
      parameters:
      - name: app
        in: query
        schema:
          type: string
      - name: from
        in: query
        schema:
          type: string
          format: date-time
      - name: to
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Click signals
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignalList'
    post:
      tags:
      - Signals
      summary: Record click signal
      operationId: recordClickSignal
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Signal'
      responses:
        '201':
          description: Signal recorded
  /signals/query:
    get:
      tags:
      - Signals
      summary: Get query signals
      operationId: getQuerySignals
      responses:
        '200':
          description: Query signals
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignalList'
    post:
      tags:
      - Signals
      summary: Record query signal
      operationId: recordQuerySignal
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Signal'
      responses:
        '201':
          description: Signal recorded
  /signals/cartadd:
    get:
      tags:
      - Signals
      summary: Get cart-add signals
      operationId: getCartAddSignals
      responses:
        '200':
          description: Cart-add signals
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignalList'
    post:
      tags:
      - Signals
      summary: Record cart-add signal
      operationId: recordCartAddSignal
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Signal'
      responses:
        '201':
          description: Signal recorded
  /signals/purchase-complete:
    get:
      tags:
      - Signals
      summary: Get purchase-complete signals
      operationId: getPurchaseCompleteSignals
      responses:
        '200':
          description: Purchase signals
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignalList'
    post:
      tags:
      - Signals
      summary: Record purchase-complete signal
      operationId: recordPurchaseSignal
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Signal'
      responses:
        '201':
          description: Signal recorded
components:
  schemas:
    Signal:
      type: object
      properties:
        type:
          type: string
        userId:
          type: string
        sessionId:
          type: string
        timestamp:
          type: string
          format: date-time
        params:
          type: object
          additionalProperties: true
    SignalList:
      type: object
      properties:
        signals:
          type: array
          items:
            $ref: '#/components/schemas/Signal'
        count:
          type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: Lucidworks Signals API Reference
  url: https://doc.lucidworks.com/api-reference/get-signals/click-signals