Sign in
Web Analytics

List analytics payment-link scope options

Lists protected payment-link scope identifiers, owning store IDs, creation times and generic labels. Never returns raw payment-link UUIDs, public capabilities, order/customer data, amounts or payment status. Options cover up to five years of operational history. 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/payment-links

Query parameters

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

Example response

{
  "data": [
    {
      "id": "plscope_0198cfa0-283a-7491-850a-48b7f0a1d84e",
      "label": "Payment link · 2026-09-20 01:30:00 UTC · f0a1d84e"
    }
  ]
}

Changes

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