Base URL
Accept: application/json header. See Authentication.
Conventions
- Identifiers are UUIDs. Profile and element ids are strings, not integers.
PUTreplaces, it does not patch. Element updates must resendtype,enabled_for_display, andenabled_for_downloadalong with whatever you are changing. Send the element’s current values for the fields you do not want to touch.- Booleans are real booleans. Send
true, not"true"or1.
Endpoints
| Method | Path | Ability |
|---|---|---|
GET | /profiles | profiles:read |
POST | /profiles | profiles:write |
GET | /profiles/{id} | profiles:read |
PUT | /profiles/{id} | profiles:write |
GET | /profiles/{id}/elements | elements:read |
GET | /profiles/{id}/analytics/summary | analytics:read |
POST | /elements | elements:write |
POST | /elements/reorder | elements:write |
PUT | /elements/{id} | elements:write |
DELETE | /elements/{id} | elements:write |
Profiles
Create, read, and update profiles.
Elements
The links on a page: create, update, delete, reorder.
Analytics
Visits, clicks, and top links.