---
title: "List analytics payment-link scope options"
method: GET
path: "/v3/web-analytics/payment-links"
tags: ["Web Analytics"]
---

# List analytics payment-link scope options

`GET /v3/web-analytics/payment-links`

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.

## Query parameters

- `search` string
- `page_size` integer
- `next_cursor` string
- `previous_cursor` string

## Response `200`

Success

- WebAnalyticsPaymentLinkOptions
  - `data` WebAnalyticsPaymentLinkOption[], required
    - `id` string, required — Protected business-specific reporting identifier; use as entity_id with entity_type=payment_link. It is not a public payment URL or raw payment-link UUID.
    - `store_id` integer, required
    - `created_at` string, date-time, required
    - `label` string, required — Generic UTC creation-time label with an opaque short suffix; contains no order/customer data.
  - `is_paginated` true, required
  - `has_next` boolean, required
  - `has_previous` boolean, required
  - `next_cursor` string, nullable, required
  - `previous_cursor` string, nullable, required
  - `page_size` integer, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests. Storefront public requests using `X-Scalev-Storefront-Api-Key` or `X-Scalev-Guest-Token` are rate-limited as direct client/browser requests. Machine-authenticated business requests are rate-limited per API key or OAuth installation. Rate-limit responses may be plain text instead of the normal JSON error shape.

## Changes

- **2026-09-20** `af4231e0cad9` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/scalev/apis/nexus-commerce-api/changes/v3/web-analytics/payment-links/get.md)

---

[API](https://skmtc.dev/scalev/apis/nexus-commerce-api.md) · [All operations](https://skmtc.dev/scalev/apis/nexus-commerce-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scalev/apis/nexus-commerce-api/revisions/215156c4eee0?raw)