Version 0.0.1


API Documentation

For more information please use the API documentation here.

Set up

To create a source for the elm connector you need your elm API key.

To generate your API key follow these steps:

  • Log in to elm.
  • Head to account settings
  • Visit the API Tab, here you will be able to generate your key.

If you cannot see a retailer that you have set up with elm as an option please contact your Kleene CSM.


Backfillℹ️Variable backfill is supported on the Data reports.
Incrementalβœ…Incremental is supported on the data reports.
API reliability🟒Reliable


API Limitations

  • Some combinations of retailers and timeframes will result in duplicate rows when extracting incrementally.
  • Some combinations of retailers and timeframe will not have data up to the current date.


API Limitations

These Limitations will cause the extract to fail:

  • Ocado and Epicurium do not have access to store level data
  • Running an extract that you do not have elm data for will fail - you can see your available retailers by running the retailers report.
  • BP does not have daily data available.

Reports detail

⬇️ ReportπŸ”‘ Incremental keyπŸ”‘ Primary keyπŸ“„ Link to API endpoint
RetailersN/AN/AGet Retailers
Data by StoreweekIDGet Data
Data by skuweek or date or monthIDGet Data
ActionsN/AN/AGet Actions