Notifications

Advance Funnel Stage

Changed on

Advance the funnel stage from the client side.

Studio calls this when key milestones happen in-browser that the server cannot observe directly (e.g. first_search executed in the test tab). Accepts both resource-creation stages and activation funnel stages.

source is optional provenance for the stage being advanced, recorded on the analytics event so a stage reached two different ways can be counted separately. It distinguishes a click on sample data from a real upload, and a search of a sample retriever from a search of the caller's own data, which the stage name alone cannot. Ignored for resource-creation stages.

post/v1/notifications/funnel/advance

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/notifications/funnel/advance
  • Auth: HTTP bearer

Request body

stagestring required
sourcestring nullable

Response

Successful Response

object required

Changes

    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the new optional request property