Access levels
Your key has one of three levels. A higher level includes everything below it.
| Level | Plan | Includes |
|---|---|---|
| Level 1 | API 1, Public | Identity and reference data, the overall score and its direction, public signals, malls and operators in summary. |
| Level 2+ | API 2, Professional | Everything in Level 1, plus topic and dimension scores, benchmarks, the full signal feed, store-level reference data and history. |
| Level 3+ | API 3, Corporate | Everything in Level 2, plus score drivers, evidence behind every point, deduced store and mall performance data and bulk export. |
Every endpoint and every data point in the reference states the lowest level that includes it. Calling something above your level returns 403 level_required, with the level it needs in the message. Responses also vary by level: for example the score of a brand returns its four dimensions at Level 2 and its drivers at Level 3.
Endpoints by level
| Endpoint | Level |
|---|---|
GET /brands | Level 1 |
GET /brands/{id} | Level 1 |
GET /brands/{id}/malls | Level 1 |
GET /brands/{id}/score | Level 1 |
GET /brands/{id}/score/history | Level 2+ |
GET /brands/{id}/topics | Level 2+ |
GET /signals | Level 1 |
GET /signals/{id} | Level 1 |
GET /data-points | Level 1 |
GET /brands/{id}/data-points | Level 2+ |
GET /malls | Level 1 |
GET /malls/{id} | Level 1 |
GET /malls/{id}/tenants | Level 2+ |
GET /operators | Level 1 |
GET /operators/{id} | Level 1 |
GET /operators/{id}/malls | Level 1 |
GET /stores | Level 2+ |
GET /stores/{id} | Level 2+ |
To change your level, contact us; the key keeps working and its level changes at once.