Skip to main content
Version: 1.0.0

SkinAI Partner Analytics API

Overview​

The SkinAI Partner Analytics API provides explicit, product-oriented analytics for authorized SkinAI experiences.

The public contract is resource-based and built around the actual analytics primitives stored in the analytics database: traffic, event activity, segmentation, recommendation effectiveness, hourly activity, and retention.

Authentication​

All app-scoped analytics endpoints require the X-API-Key header. The event catalog is public.

Authorization Model​

A partner API key can be linked to one or more SkinAI projects. Every app-scoped analytics request must include an app_key path parameter, and the request is authorized only when that app_key belongs to a project linked to the provided API key.

Reporting Window​

Date-based routes require start_date and end_date in YYYY-MM-DD format.

Standard routes support windows up to 93 days.

High-cost exact routes are limited to 31 days: events (raw event list), events/*/segments/*, activity/hourly, and recommendations/effectiveness.

Retention routes support an optional as_of_date parameter for reproducible reporting snapshots.

Authentication​

Partner API key linked to one or more SkinAI projects.

Security Scheme Type:

apiKey

Header parameter name:

X-API-Key