The top-level object returned from all API endpoints.

All API responses follow the same top-level model:

Property

Description

Type(s)

success

The payload-level response status. Can be used by consumers to conditionally show error UX.

boolean

data

If success is false, data is a string with more info. If success is true, data will be a PopRank model or a primitive, like number or string.

any