Personyze Wiki Personyze Wiki docs
Open Personyze
Developer Resources

Developer Resources — REST API & SDKs

REST API, template language, and SDKs for integrating with Personyze programmatically. Full native documentation in the wiki, plus GitHub repos for code.

Updated 2 weeks ago 3 min read
A
by Admin

Personyze offers a REST API for managing your account programmatically, a template language for authoring action HTML, and a set of SDKs for native mobile and tag-manager integration. This page is the starting point — quick overviews plus links to the full reference documentation.

REST API

The Personyze REST API lets third-party applications read and modify data in your account: manage users and user lists, work with the product and article catalogs, control placeholders and actions, perform live operations on online users, query daily reporting summaries, and more. It uses standard HTTP, accepts and returns JSON, and supports the four standard verbs (GET, POST, PUT, DELETE).

Quick example

Fetch the user with internal ID 42:

curl 'https://api:YOUR_API_KEY@app.personyze.com/rest/users/where/internal_id=42'

The general shape of every request:

https://api:<API_KEY>@app.personyze.com/rest/<object>[/<modifier>/<value>...]

Full REST API reference (4 articles)

📖 Overview & Quick StartRequest shape, HTTP methods, response codes, conventions like id vs internal_id. Read →
🔑 AuthenticationGetting your API key, sending it via header or URL, error codes, multi-account patterns. curl, Python, JS examples. Read →
🧩 Path ParametersThe where / columns / order_by / limit syntax with all operators, AND/OR composition, and indexed-column rules. Read →
📚 Objects ReferencePer-object pages for all 18 endpoints — users, products, articles, actions, placeholders, interactions, events, sessions, summaries. Read →

Template language

Personyze actions (banners, popups, recommendation widgets, emails) are authored in a templating language that’s mostly plain HTML and CSS, with directives for editable parameters, loops over Personyze tables (products, articles), conditionals, and special class names that turn ordinary elements into Personyze-aware widgets.

📝 Template Language — Action HTML ReferenceComplete syntax reference: ${args} variables, user & session variables, functions, ${foreach} table loops, conditionals, special $-prefixed classes ($responsive, $btn, $popup, $cform, etc.), form handling, and the ${menu} directives that build the visual editor. Plus the GitHub library of 12 ready-to-use example templates. Read →

SDKs & tooling on GitHub

While the REST API and template language are now fully native in the wiki, all Personyze open-source code stays on GitHub at github.com/personyze:

Native mobile SDKs

📱 Android SDK (Java)Full Personyze tracking and personalization for Android apps. Repo → · Demo app →
🍎 iOS SDK (Swift)Native iOS integration with the same feature set as the Android SDK. Repo → · Demo app →

Both SDKs are published under MIT license. The demo apps are runnable references showing the full setup-to-personalization flow. For a guided walkthrough, see Mobile App Product Recommendations Integration Guide.

Web tooling

🏷 Google Tag Manager templatePersonyze tracking code packaged as an importable GTM template. Drop into your container instead of hand-coding the snippet. Repo →
📑 Template language sourceSource of the Template Language reference (above) plus 12 fully-annotated example templates: popups, forms, timers, recs, emails, social proof. Repo →

Pair the GTM template with the Google Tag Manager setup guide for the full integration flow.