Ordexs API v1 Get an API key

Analytics

Retrieve customer insights

GEThttps://api.ordexs.com/v1/analytics/customers

Customers → Insights: buyers by month and how many came back, reliability, the best customers and the valuable ones going quiet, regions, sources and how long customers take to order again. For everyone, or one saved segment. Default window: the last 12 months.

Query parameters

  • fromstring

    ISO 8601 date-time, UTC

  • tostring

    ISO 8601 date-time, UTC

  • segment_idstring

    starts with seg_

Returns

200 OK · The insights. AnalyticsCustomers

  • objectstring

    always "analytics_customers"

  • fromstring

    ISO 8601 date-time, UTC

  • tostring

    ISO 8601 date-time, UTC

  • buyers_countinteger
  • reliabilityobject
  • monthsarray of objects
  • top_customersarray of objects
  • at_riskarray of objects

    Customers who spent a lot and haven't ordered for a while.

  • regionsarray of objects
  • sourcesarray of objects
  • repeat_timingobject
  • livemodeboolean

Errors

Every error has the same shape. This endpoint can answer with: