Our API integration has three key components, plus an optional fourth, for sending user-specific data.
- Inventory - the items that LiftIgniter should recommend
- Model - requests to this endpoint generate a list of recommendations (returned in JSON format) and are the only API calls that count towards billing.
- Activity - LiftIgniter requires tracking of several types of events to effectively train our models. These are: pageview, widget_shown, widget_visible, and widget_click.
We've also created a Postman Collection to demonstrate the various fields required for each endpoint, and in particular the various JSON fields required for each event type going to the /activity endpoint. You can view the Postman version of our API documentation here. You can also import the collection into your own Postman client.