Web Analytics

List analytics entity scope options

Lists flat IDs and names for landing pages, products or bundle price options, including inactive records with retained history. No operational page/product/bundle-list permission is required. Uses real keyset pagination, newest first, with at most 25 rows per page. Cursors bind the business, resource, type where applicable, and normalized search. Legacy page, cursor, last_id and anchor_id parameters are unsupported. 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.

get/v3/web-analytics/entities

Query parameters

entity_type'landing_page' | 'product' | 'bundle_price_option' required

Owning resource type to list; repeat on all cursor requests.

searchstring

Optional case-insensitive literal substring search, trimmed and whitespace-normalized. At most 200 characters (and 800 input bytes). Repeat it with cursor requests. Payment links search only their generic UTC date/time label, not protected IDs or suffixes.

page_sizeinteger

Number of scope options per page; numeric values are clamped to 1–25.

next_cursorstring

Opaque next-page cursor returned by this endpoint. Mutually exclusive with previous_cursor; repeat the same resource/type and normalized search.

previous_cursorstring

Opaque previous-page cursor returned by this endpoint. Mutually exclusive with next_cursor; repeat the same resource/type and normalized search.

Response

Success

is_paginatedtrue required
has_nextboolean required
has_previousboolean required
next_cursorstring nullable required
previous_cursorstring nullable required
page_sizeinteger required

Changes

Changed in 1 of the 7 revisions of this API.1