REST API guide

Programmatic KPIs and alerts for marketplace operators.

Connect FiveX marketplace entities to the dashboards, Slack alerts and internal tools your team already uses, so operational signals move faster than manual exports.

SKU-level economics Marketplace alerts Internal tooling

What this guide helps you build

Live KPI surfaces

Expose revenue, orders, ad spend, TACOS, margin and product performance in the internal cockpit your team checks every day.

Explore analytics

Operational alerts

Notify operators when margins fall, campaign spend drifts, stock coverage drops or channel performance moves outside agreed guardrails.

View stock signals

Partner workflows

Give agencies, BI teams and partner tools a controlled data layer instead of asking them to work from screenshots or spreadsheet handoffs.

See integrations
Implementation overview

Use the API for actions that need to stay close to the operation.

REST works best for current state, triggered checks and lightweight automation. Use exports when you need historical warehouse-scale analysis.

Model the alert around a decision

Start with the action an operator should take: pause budget, review price, replenish stock or investigate margin. Then request only the entities and metrics needed to make that decision.

Keep thresholds explainable

Use margin, stock, conversion and advertising context together. A low ROAS alert is more useful when it also includes contribution margin, stock coverage and product status.

Separate notification from automation

Let early workflows send reviewed alerts before moving to automated actions. This keeps commercial teams confident while engineering validates edge cases.

Recommended workflow

How to move from idea to production workflow

  1. 01

    Choose the product, channel or campaign entity that should trigger the workflow.

  2. 02

    Request the current KPI state through the API and enrich it with local team context.

  3. 03

    Apply thresholds that map to a clear action owner and escalation path.

  4. 04

    Send alerts to Slack, email, BI or an internal console with links back to FiveX.

Build the API workflow with the right scope from day one.

Bring your channels, reporting needs and automation goals. We will map the safest route across REST, exports, OAuth and governance.