Clearway Documentation
stringstringboolean · required
Analytics
Read analytics
POST
https://api-dev.clearway.to
/GET_ANALYTICS_ENTITLEMENT
Dashboard-only — returns 403 API_GATEWAY_KEY_FORBIDDEN when called with an API key on the merchant API gateway. Use the Clearway dashboard instead. Advanced analytics entitlement probe. Requires the read:analytics scope (or full_access). Session-backed today; API key path reserved.
Headers
x-cidOptional correlation id for support trails.
x-brand-idOptional platform brand slug for multi-brand merchants.
Read analytics › Responses
Success
success