Personyze Personyze developer docs
Open Personyze
Analytics

REST Campaign Summary object

Daily campaign performance per action — for your own BI tooling.

Personyze developer documentation Questions: support@personyze.com

For information about how REST API works, see rest main page.

Read-only daily performance figures per action, per campaign. This is the object to use when you want Personyze campaign results inside your own BI tool, data warehouse or reporting dashboard.

The endpoint URL is:

app.personyze.com/rest/summary_actions

GET only. One row per (day, action) pair.

This object returns per-action rows only. The underlying summary also holds rows aggregated per A/B group and per campaign, and those are deliberately not exposed here. The practical consequence: if you are running an A/B test, you can read each variant's own numbers — provided each variant is its own action — but you cannot reconstruct lift against the control group, because the control arm shows no action and therefore has no rows. The A/B verdict is computed by Personyze and read in the panel.

Identity columns

Column Description
day The day the figures cover. This is the indexed column — filter or sort by it.
action_id, action_name The action (the piece of content that was shown).
campaign_id, campaign_name The campaign (targeting rule) the action belongs to.

Delivery columns

Counted both as raw occurrences (n_*) and as distinct sessions (n_sessions_*):

Column Meaning
n_executed / n_sessions_executed The action ran.
n_delivered / n_sessions_delivered It was actually delivered to the visitor.
n_extra / n_sessions_extra The configured "extra" engagement happened (e.g. a click).
n_closed / n_sessions_closed The visitor dismissed it.
n_failed / n_sessions_failed It could not be shown.

Goal and recommendation columns

products_goal_n_times, products_goal_n_sessions, products_goal_value — conversions attributed to the action, and their monetary value.

For recommendations, the same three shapes repeat for products and for content, at each stage of the funnel:

products_recom_viewed_n_times, products_recom_viewed_n_sessions, products_recom_extra_n_times, products_recom_extra_n_sessions, products_recom_extra_value, products_recom_goal_n_times, products_recom_goal_n_sessions, products_recom_goal_value

…and the identical set prefixed articles_recom_ for content recommendations.

Custom goal events

If your account defines goal events, each one adds four columns, numbered by its index:

goal_event_{N}_name, goal_event_{N}_n_times, goal_event_{N}_n_sessions, goal_event_{N}_value

goal_event_{N}_name returns the event's name as configured in the panel, so a report can label its own columns without hard-coding them. Which indices exist depends on your account — request all columns once to discover them.

Select example

Last 30 days, newest first:

curl 'https://api:FD09908F25BECB09D78EBEA1DADFB618651F612D@app.personyze.com/rest/summary_actions/order_by_desc/day/limit/1000'

A date range for one campaign, with just the headline numbers:

curl 'https://api:FD09908F25BECB09D78EBEA1DADFB618651F612D@app.personyze.com/rest/summary_actions/where/day>=2026-07-01&day<=2026-07-31&campaign_id=42/columns/day,action_name,n_delivered,products_goal_n_times,products_goal_value'

Performance

day is the only well-indexed column here. Always constrain or sort by day — an unfiltered scan across all history will be refused or truncated, as described in errors and limits. Pull history in date-ranged pages rather than in one request.