For information about how REST API works, see rest main page.
Read-only list of the actions in your account — the pieces of content a campaign can show. Use it to resolve the action_id values returned by campaign summaries, forms and product interactions into names, or to inventory what a Personyze account contains.
The endpoint URL is:
app.personyze.com/rest/actionsGET only. Actions are authored in the panel, not through this API.
Columns
| Column | Description |
|---|---|
id |
The action id, as referenced elsewhere in the API. |
name |
The action's name in the panel. |
version_tag |
Which version this row describes — production or testing. |
type_id |
The action type (banner, popup, recommendation block, email, and so on). |
placeholders |
JSON array of the placeholder ids this action renders into, e.g. [14,15]. |
content_type |
How the action's content is stored. |
content_param |
Which parameter of the action holds its content. |
content_begin, content_end |
The HTML wrapper around the action's content, when it has one. Resolved for the requested version_tag. |
presenting_rules |
The action's presentation rules, as stored. |
libs_app |
Libraries the action depends on. |
Requesting fewer columns makes the query cheaper — the content and wrapper columns require extra joins that are skipped when you don't ask for them.
Select example
Names and ids only:
curl 'https://api:FD09908F25BECB09D78EBEA1DADFB618651F612D@app.personyze.com/rest/actions/columns/id,name,type_id'One action:
curl 'https://api:FD09908F25BECB09D78EBEA1DADFB618651F612D@app.personyze.com/rest/actions/where/id=88'Only what is live:
curl 'https://api:FD09908F25BECB09D78EBEA1DADFB618651F612D@app.personyze.com/rest/actions/where/version_tag=production/columns/id,name,placeholders'Related
conditions — the campaigns that decide when an action runs.