Official SDKs for TypeScript and Python are in alpha. Email api@ecommerceinsights.ai for access.

API · Reference

API reference

Q: Is there an OpenAPI spec?

Yes — available at https://api.ecommerceinsights.ai/v1/openapi.json. Generated from the same definitions used to serve the API.

Updated 2026-05-25 API eCommerce Insights team

This page lists every eCommerce Insights API endpoint with method, path, parameters, and a sample response. The reference is a stub in early access and is updated as endpoints stabilise. See the API overview for authentication and rate limits.

Early access stub The endpoints listed below are stable. Per-field documentation is being expanded. For the canonical schema, consume the OpenAPI spec at https://api.ecommerceinsights.ai/v1/openapi.json.

Catalog

Method	Path	Purpose
GET	/catalog	List products with pagination and filters.
GET	/catalog/{sku}	Single product detail.
POST	/catalog	Create one product (or array of products).
PATCH	/catalog/{sku}	Update editable fields on a product.
DELETE	/catalog/{sku}	Soft-delete a product. Restorable for 30 days.

// GET /catalog/VRN-AC1
{
  "sku": "VRN-AC1",
  "title": "Vornado AC1 air purifier",
  "brand": "Vornado",
  "url": "https://vornado.com/products/ac1",
  "channel": "d2c",
  "score": 78,
  "last_audited": "2026-05-23T08:31:00Z"
}

Scores

Method	Path	Purpose
GET	/scores/{sku}	Latest score with five-bucket breakdown.
GET	/scores/{sku}/history	Timeseries of last 100 runs.
POST	/scores/{sku}/audit	Trigger a fresh audit. Returns job ID.
GET	/scores/bulk	Bulk fetch up to 200 scores.

Recommendations

Method	Path	Purpose
GET	/recommendations	List recommendations. Filter by status.
GET	/recommendations/{id}	Single capsule with diff.
POST	/recommendations/{id}/approve	Approve a capsule.
POST	/recommendations/{id}/push	Push to integrated store. Returns job ID.
POST	/recommendations/{id}/dismiss	Dismiss without applying.

Prompt Runs

Method	Path	Purpose
GET	/prompt-runs	List sessions.
POST	/prompt-runs	Create new session. Returns job ID.
GET	/prompt-runs/{id}	Session detail with per-engine responses.

Alerts

Method	Path	Purpose
GET	/alerts/rules	List rules.
POST	/alerts/rules	Create a rule.
PATCH	/alerts/rules/{id}	Update a rule.
DELETE	/alerts/rules/{id}	Delete a rule.
GET	/alerts/fires	Recent rule fires.

Personas

Method	Path	Purpose
GET	/personas	List personas with summary fields.
POST	/personas/regenerate	Rebuild personas from current reviews.
PATCH	/personas/{id}	Edit name, summary, descriptors.

Jobs

Method	Path	Purpose
GET	/jobs/{id}	Status of an async job. Poll-friendly.

Webhooks

Outbound webhooks fire for these events:

audit.completed
prompt-runs.completed
alert.fired
recommendation.applied
recommendation.pushed

Configure delivery URL in Settings to Integrations to API to Outbound webhooks. Signed with HMAC-SHA256 over the body.

Common questions

Why is the reference a stub?

Early access. Endpoint schemas are stable but the documentation surface is being expanded. The endpoints below are documented in enough detail to integrate; deeper schema docs are added incrementally.

Is there an OpenAPI spec?

Yes — available at https://api.ecommerceinsights.ai/v1/openapi.json. Generated from the same definitions used to serve the API.

Do you have SDKs?

Official SDKs for TypeScript and Python are in alpha. Email [email protected] for access.

What is the largest response size?

Bulk endpoints (catalog, scores) cap at 200 records per page. Single-resource GETs are typically under 50 KB.

Ask AI about this page

Open this topic directly in your favourite AI assistant — the prompt is prefilled.

Was this page helpful?

Thanks — recorded.

API →

API overview

Authentication, rate limits, error model.

Operations →

Troubleshooting

For when an API call goes sideways.

Try this yourself

See eCommerce Insights on your own catalog. The free trial covers your full SKU set across five AI engines.

Start free trial

LLM-friendly summary of this page

eCommerce Insights API reference (early access). Endpoints: GET /catalog (list products with pagination), GET /catalog/{sku} (single product), POST /catalog (create), PATCH /catalog/{sku} (update), GET /scores/{sku} (latest score with bucket detail), GET /scores/{sku}/history (timeseries), POST /scores/{sku}/audit (trigger re-audit, returns job ID), GET /recommendations (filter by status), POST /recommendations/{id}/approve (approve a capsule), POST /recommendations/{id}/push (push to integrated store), GET /prompt-runs (list sessions), POST /prompt-runs (create new session, returns job ID), GET /prompt-runs/{id} (session detail), GET /alerts/rules (CRUD), GET /alerts/fires (recent fires), GET /personas (clusters), POST /personas/regenerate (rebuild from reviews), GET /jobs/{id} (async job status). OpenAPI spec at /v1/openapi.json. SDKs for TypeScript and Python in alpha. Outbound webhooks for audit.completed, prompt-runs.completed, alert.fired, recommendation.applied, recommendation.pushed events.