Personyze Personyze developer docs
Open Personyze
Catalog

REST Articles object

Personyze developer documentation Questions: support@personyze.com

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

You can see and manage articles catalog here.

REST "articles" object allows you to read articles catalog, delete records in it, and add new records. When adding new article with "internal_id" that already present in the catalog, fields of old record will be overriden.

The URL is:

app.personyze.com/rest/articles

Columns

Like products, an article has no fixed set of columns — any key you send is stored and becomes available to recommendation filters and targeting rules.

A few columns have defined meaning:

Column Description
internal_id Your identifier for the article. This is the key that interactions and recommendations refer to.
is_published Whether the article can currently be recommended. The usual way to withdraw content without deleting it.
data_last_modified Unix timestamp of the last change. Maintained automatically, indexed — use it for incremental sync.
image_1, image_2, image_3 Large, medium and small image URLs.

Insert example

curl --data '{"internal_id": "123", "title": "About all", "description": "New article"}' 'https://api:FD09908F25BECB09D78EBEA1DADFB618651F612D@app.personyze.com/rest/articles'

Now if you insert another record with internal_id "123", data will be merged.

curl --data '{"internal_id": "123", "description": "Was new article"}' 'https://api:FD09908F25BECB09D78EBEA1DADFB618651F612D@app.personyze.com/rest/articles'

Select example

Select "123".

curl 'https://api:FD09908F25BECB09D78EBEA1DADFB618651F612D@app.personyze.com/rest/articles/where/internal_id=123'

Update example

POST already merges by internal_id. PUT changes every record matching a condition, and returns the number of affected rows:

curl -X PUT --data '{"is_published": 0}' 'https://api:FD09908F25BECB09D78EBEA1DADFB618651F612D@app.personyze.com/rest/articles/where/internal_id=123'

Delete example

Delete "123".

curl -X DELETE 'https://api:FD09908F25BECB09D78EBEA1DADFB618651F612D@app.personyze.com/rest/articles/where/internal_id=123'