This is the Personyze technical documentation for developers. It covers the server-side REST API, the in-browser Javascript API, and the native mobile SDKs.
For product guides, campaign setup and everything non-technical, see the Personyze knowledge base.
Start here
Building an integration
Start here if you're connecting another system — which endpoint does what, how identity and merging work, and how to sync incrementally.
Server-side personalization & A/B testing
Ask Personyze what a user should see and act on the answer in your own backend — no browser required.
REST API
Read and change data on a Personyze account from third-party applications — users, products, articles, placeholders and more.
API keys
How to generate, scope and revoke the keys that authenticate every API request.
Client-side API
The Javascript API in the browser — report product and article interactions from your own page code.
Mobile SDKs
Personalize Android and iOS applications with the native Personyze SDKs.
Templates language
The templating language used in the HTML source of Personyze actions.
Custom recommendations app
Build a non-web application that consumes Personyze recommendations directly.
Popular REST objects
- users — import and update user profiles.
- zapier_users — the endpoint used by the Personyze integration on Zapier.
- user_lists and user_list_users — segments and their membership.
- do — perform operations on users who are online right now.
- products and articles — your catalog and content database.
- products_interactions — report views, cart additions and purchases from your backend.
- summary_actions — daily campaign performance, for your own reporting.
Before you write a client, read errors, limits and retries — it covers the status codes, the 1000-row cap and the indexing rules that apply to every object.
Getting help
Write to support@personyze.com with the endpoint you are calling and the response you received, and we will take a look.