Personyze Personyze developer docs
Open Personyze
Analytics

REST Sessions object

Visitor sessions: where they came from, what they did, what it was worth.

Personyze developer documentation Questions: support@personyze.com

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

Read-only archive of visitor sessions — where each visit came from, what it did, and how much it was worth. Use it to export raw visit data into your own analytics, or to reconstruct a single visitor's history.

The endpoint URL is:

app.personyze.com/rest/sessions_archive

GET only.

Identity and timing

Column Description
user_id The Personyze user this session belongs to. Indexed — the fastest way to query.
first_visit_id Identifier of the session.
session_start_time When the session began, Unix timestamp.
session_counter Which session this is for that user — 1 is their first ever.
last_session_time Timestamp of the user's most recent session.
total_visits Total page views by this user.
time_in_focus, time_total Seconds engaged, and seconds elapsed.

Geography

country_code, region_code, city, time_zone.

city is returned as a readable city name.

Landing page and referrer

The URL is split into parts so you can filter on any of them: url_prefix, url_host_port, url_path, url_query, url_fragment.

The referrer is split the same way: referrer_prefix, referrer_host_port, referrer_path, referrer_query, referrer_fragment, plus referrer_type and search_word when the visit came from a search engine.

Campaign attribution

ad_campaign, ad_source, ad_medium, ad_term, ad_content — the UTM parameters carried by the landing URL.

Engagement and environment

total_goal_value, total_n_goals — conversions in the session and their value.

page_click, page_right_mouse, page_key_up, page_scroll — interaction counters.

lang_0, lang_1, lang_2 — the browser's preferred languages. screen_width, screen_height, screen_depth — the display.

Select example

One user's sessions, most recent first:

curl 'https://api:FD09908F25BECB09D78EBEA1DADFB618651F612D@app.personyze.com/rest/sessions_archive/where/user_id=123/order_by_desc/session_start_time'

A campaign's landings, with only the columns a report needs:

curl 'https://api:FD09908F25BECB09D78EBEA1DADFB618651F612D@app.personyze.com/rest/sessions_archive/where/ad_campaign=spring-sale/columns/user_id,session_start_time,country_code,city,total_goal_value/limit/1000'

Performance

This is one of the largest tables in the system. Query it by user_id, or by a time range on session_start_time, and page with limit. Filtering on an unindexed column — a city, a UTM term — is a full scan, and will either be refused or return only the first 50 rows; see errors and limits.

Some legacy browser-capability fields (Flash, Silverlight, Java and similar) exist in the underlying storage but are deliberately not exposed.