sharedUrls

Returns one page of the account's share links with page metadata, filtered by status (enabled by default) and searchTerm and sorted by order. Links to deleted Heatmaps, A/B tests, goals, funnels, and sites are hidden. Use sharedUrl to get or create the link for one resource. Requires sharing manage access.

sharedUrls(
  searchTerm: String
  order: SharedUrlsOrder!
  limit: Int!
  page: Int!
  status: SharedUrlsStatus!
): SharedUrlListResults

Arguments

sharedUrls.searchTerm ● String scalar

Matches title or resource type as a substring, and sharer id, name, or email, share code, or original URL exactly; % acts as a wildcard.

sharedUrls.order ● SharedUrlsOrder! non-null input

Required sort object; an empty object selects creation time descending.

sharedUrls.limit ● Int! non-null scalar

Page size, an integer of at least 1; no maximum is enforced here.

sharedUrls.page ● Int! non-null scalar

Page number, starting at 1.

sharedUrls.status ● SharedUrlsStatus! non-null enum

Link status to include; defaults to ENABLED.

Type

SharedUrlListResults object

Paginated shared-link results keyed as meta plus shared_urls, rather than a bare list.