Get navigation around a page surface

get

https://api.scalev.com/v3/web-analytics/entity-journey

Requires entity_type, legacy page_id, or page_path. entity_type alone is a valid focus; entity_id optionally narrows its owner. Entity and page_path focus combine. Returns immediate inbound and outbound neighbours without deleting them from the session. Requires web_analytics:read. The authenticated credential determines the business; no business_id override is accepted. Reporting and scope-option calls share a 600-request/hour limit per API key or OAuth installation, in addition to the normal burst and hourly limits. Responses contain recorded analytics, which may be lower than actual traffic because of consent choices, self-traffic exclusion, blockers, and unavailable attribution.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

from

date

required

Inclusive start date in the requested timezone. from must be on or before to; the inclusive range cannot exceed 180 days.

date

required

Inclusive end date in the requested timezone. Raw event history is retained for 180 days; expired data is not reconstructed.

timezone

string

Defaults to Asia/Jakarta

Recognized IANA timezone used for date boundaries and daily buckets.

store_id

integer

≥ 1

Optional store owner filter within the authenticated business. Use /v3/web-analytics/stores to obtain IDs without operational store permissions.

entity_type

string

enum

Optional surface filter. A type alone selects every owner of that surface. Supply entity_id to narrow to one owner; invalid types are errors.

entity_id

string

Requires entity_type. Positive numeric owning IDs are sent as text; store_home/cart/checkout/order_detail/order_success/order_invoice use store IDs. For payment_link use the opaque plscope_ identifier from /v3/web-analytics/payment-links. A malformed nonempty ID is an error, not an unfiltered report.

entity_path

string

Optional sanitized fallback path for records without a stored entity identity. Requires entity_type (or legacy page_id); use with entity_id. It does not replace the independent page_path filter. Payment-link scope ignores fallback paths.

page_id

integer

≥ 1

Legacy alias for entity_type=landing_page and entity_id. Cannot be combined with entity_type or entity_id.

page_host

string

Optional hostname filter. Host, path and entity compose independently; host also restricts the navigation universe for journeys.

page_path

string

Optional exact sanitized path filter across hosts. Use / for the homepage. An explicitly empty value does not mean unfiltered. For journeys/funnels this selects the focus while retaining neighbouring pages.

ad_click

string

enum

Filter by recorded ad-click evidence or network, independent of UTM labels. organic means no captured click ID, not proof of unpaid acquisition. Unrecognized values are ignored by the server; use one of the documented values.

Allowed:

limit

integer

1 to 100

Defaults to 25

Maximum ranked rows for reports that return ranked lists. Values above 100 are capped at 100; absent or invalid/non-positive values use 25. This is not cursor pagination and does not cap range totals or the fixed audience-location caps.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200Success

400Bad Request

401Unauthorized

403Forbidden