Personyze

Fetch one personalization action with its editable HTML content (content_begin/content_end) and presenting rules.

get_action_content

List visitor user_ids that belong to an audience. Returns [{user_list_id, user_id}]. Use get_visitors with "where"="user_id:<ids>" to fetch the profiles.

list_audience_members

List the account's audiences (user segments). Returns [{id, name}]. Audience ids are used by the audience-membership tools.

list_audiences

List the account's campaigns (targeting conditions). Returns [{id, name}]. The id matches "campaign_id" in get_campaign_performance results.

list_campaigns

List personalization actions (banners, popups, recommendations, email widgets, etc.). Available columns: id, name, version_tag ("production" or "testing"), type_id, placeholders (placeholder ids the action renders into), content_type, content_param, content_begin, content_end (editable HTML content), presenting_rules, libs_app. Filter syntax (same as the Personyze REST API "where" path parameter): "column=value" (equals), "column!=value", "column>value", "column<value", "column>=value", "column<=value", "column:v1,v2,v3" (IN), "column!:v1,v2" (NOT IN). Join conditions with "&" for AND and "|" for OR (AND binds tighter). Values must be URL-encoded (encodeURIComponent).

list_actions

List placeholders — named page locations where personalization actions can render. Returns [{id, name, html_id, units_count_max}].

list_placeholders

Open a support ticket with the human support team, and get its number back. Offer this when you genuinely cannot help: a question about something outside the account data you can read, something that looks broken, billing, or an answer you are not confident in. Offering a ticket is a better answer than a guess — but ask before opening one, and never open one silently. Write the message yourself, in the person's own terms: what they were trying to do, what happened, and anything you already checked and ruled out, so support does not start from nothing. Say afterwards that support replies in the panel under Support Tickets.

open_support_ticket

Switch ONE personalization action on or off inside its campaign. Unlike the draft tools, this takes effect for real visitors as soon as the account's JS rebuilds — pausing stops that action being shown, resuming starts it again. Nothing else about the campaign changes, and it is fully reversible by calling this again. ALWAYS confirm before calling it, and confirm in concrete terms: name the action, name the campaign it is in, and say plainly that live visitors stop (or start) seeing it. "Shall I pause it?" is not enough — the person should be able to tell from your question exactly what will change on their site. One action per call. If asked to pause several, confirm and call it once per action, naming each; never treat "pause the campaign" as licence to switch off everything in it without saying so first. Use list_actions to find the action, and get_campaign_performance if asked to pick by results.

set_action_active

Call any Personyze REST API object directly, for anything the dedicated tools don't cover. Objects: account, actions, articles, conditions, containers_grab_variable, current_notification, events, forms, placeholders, products, products_interactions, products_stats_1day, products_stats_2day, products_stats_4day, products_stats_week, products_stats_recent, products_stats_all, sessions_archive, summary_actions, tracker_code, user_interests, user_list_users, user_lists, users, users_columns. "path" is the URL part after /rest/<object>/ — key/value segments like "where/<filter>/columns/<c1,c2>/order_by/<col>/limit/<n>" or a bare numeric id. Filter syntax (same as the Personyze REST API "where" path parameter): "column=value" (equals), "column!=value", "column>value", "column<value", "column>=value", "column<=value", "column:v1,v2,v3" (IN), "column!:v1,v2" (NOT IN). Join conditions with "&" for AND and "|" for OR (AND binds tighter). Values must be URL-encoded (encodeURIComponent). "body" is the JSON payload for post/put. Docs for each object: https://personyze.com/wiki/rest:start

personyze_api

Per-product counters — how often each product was viewed, delivered in a recommendation, favourited, and how often it reached its goal (a purchase, on most accounts). Use this for "best sellers", "most viewed products" and similar. Counters come from fixed rolling windows, not an arbitrary date range: choose the closest one and say which you used. Returns internal_id (the product id in your catalog) plus n_viewed, n_delivered, n_extra, n_favorite, n_goal. Join to product names with the "products" object via personyze_api when needed.

get_product_stats

Remove a visitor (by numeric user_id) from an audience. Returns the number of rows deleted.

remove_audience_member

Search Personyze's knowledge base and read the top articles. This is your ONLY source for how the product works — how to set something up, where a setting lives, what a feature does, why a screen behaves the way it does. Use it before answering any such question, and answer only from what comes back. Do not fill gaps from what platforms like this usually do. Returns [{title, url, excerpt}]; the top results carry an excerpt, the rest are titles worth offering. Always link the articles you used — a how-to nobody can check is exactly what this tool exists to replace. If nothing relevant comes back, say the documentation does not seem to cover it and offer a support ticket. An empty result is an answer; it is never a reason to guess.

search_docs

Search visitor (user) profiles collected by Personyze. Common columns: user_id, internal_id (your CRM/site user id), email, first_name, last_name, session_counter, last_session_time, plus custom columns configured in the account. Example where: "email=john%40example.com" or "internal_id:id1,id2". Filter syntax (same as the Personyze REST API "where" path parameter): "column=value" (equals), "column!=value", "column>value", "column<value", "column>=value", "column<=value", "column:v1,v2,v3" (IN), "column!:v1,v2" (NOT IN). Join conditions with "&" for AND and "|" for OR (AND binds tighter). Values must be URL-encoded (encodeURIComponent). A "where" or an indexed order_by is required for large accounts. Empty values are omitted from results.

get_visitors

Site-wide traffic for a date range, broken down by one dimension and ranked by one counter. This is the whole site, not one campaign — use get_campaign_performance for per-action numbers. Dimensions: page (most-visited pages), landing_page (where sessions start), referrer (traffic sources), search_term (organic keywords), device (device type / OS / browser), city, country. Counters, all summed over the range: visits, users, sessions, new_users, mobile_sessions, one_visit_sessions (sessions that saw a single page — bounces), goals, goal_events, goal_value, action_impressions and action_clicks (personalization actions on those pages), session_time_total and session_time_focus (seconds; focus = tab actually in front). Rates, computed after grouping and returned on every row: bounce_rate (single-page sessions / sessions), goal_rate, click_rate, new_user_rate, mobile_rate. They are fractions — 0.42 means 42%. Ranking by a rate excludes rows whose denominator is under min_sessions (default 100), because a 100% bounce rate over three sessions outranks every real problem on the site. Say that rows were excluded when you quote a rate. For "where am I losing the most", prefer ranking by one_visit_sessions over bounce_rate: it finds the pages losing the most sessions in absolute terms, which is what is worth someone's time — a 95% bounce rate on 20 sessions is not. Use ascending for "worst" questions about rates where low is bad (goal_rate, click_rate). Read the results with these caveats: users and new_users are distinct-per-day and are summed, so over a multi-day range they overstate unique people — rank by visits or sessions unless asked otherwise, and say "visits" rather than "people" when quoting them. An empty referrer means direct traffic. An empty search_term is normal: search engines stopped passing keywords years ago, so use the referrer dimension to size organic traffic instead. Empty device or city values mean the visitor could not be identified, not zero traffic.

get_traffic_analytics

Replace the HTML content of one personalization action — the markup a visitor actually sees. This is how you finish a campaign you built: create_campaign_draft makes the campaign and its targeting, and this puts something in it. Only works on HTML action types, and only while every campaign showing the action is in staging mode — if any of them is live it is refused, because this would change what real visitors see. One action can be shown by SEVERAL campaigns; the reply lists them, and you should name them when you report back. Write complete, self-contained HTML with inline styles — there is no stylesheet to rely on. Read the current content with get_action_content first when editing rather than replacing. Ask before calling, and show the person the HTML you intend to write.

update_action_content