Projects

Track a search result click

Register a click on a search result for analytics. Call this after the user clicks on a result returned by GET /api/v2/projects/{slug}/search/.

Include the optional query and 1-based position when they are available to attribute the click to the result list that produced it. Clients that do not provide attribution can continue to send an empty body.

Required permission: search (private projects only).

post/api/v2/projects/{slug}/search/click/

Request

  • Base URL: https://app.biel.ai
  • URL: https://app.biel.ai/api/v2/projects/{slug}/search/click/
  • Auth: one of:
    • API key in header Authorization
    • none

Path parameters

slugstring required

Project slug identifier.

Request body

querystring

Search query that produced the clicked result.

positioninteger

One-based rank of the clicked result in that query's result list.

Response

Click registered successfully

messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.