SharedUrlResult

Share-link metadata returned by sharedUrl, sharedUrls, and share-link mutations.

type SharedUrlResult {
  id: Int
  fullPath: String
  itemId: Int
  itemIdStr: ID
  itemType: SharedUrlType
  userId: Int
  siteId: Int
  status: SharedUrlStatus
  note: String
  title: String
  sharedByUserId: Int
  totalViews: Int
  sharedByUserEmail: String
  sharedByUserName: String
  createdAt: Int
  lastViewedAt: Int
}

Fields

SharedUrlResult.id ● Int scalar

Share-link record id for update/regeneration mutations, distinct from the resource id.

SharedUrlResult.fullPath ● String scalar

Public share URL containing the code accepted by sharedResource.

SharedUrlResult.itemId ● Int scalar

Numeric resource id; null for string-keyed errors, surveys, and CTAs.

SharedUrlResult.itemIdStr ● ID scalar

Resource id as a string, falling back to the numeric id; use with itemType.

SharedUrlResult.itemType ● SharedUrlType enum

Resource type derived from the saved link; UNKNOWN for unrecognized types.

SharedUrlResult.userId ● Int scalar

Owner account id; can be null on legacy links.

SharedUrlResult.siteId ● Int scalar

Site the link is scoped to; null for Heatmap, recording, and A/B test links, and the property id for Google Analytics property links.

SharedUrlResult.status ● SharedUrlStatus enum

ENABLED unless the link was disabled; an enabled link still fails in sharedResource when its resource is gone.

SharedUrlResult.note ● String scalar

Saved management note; null when unset.

SharedUrlResult.title ● String scalar

Title captured from the shared resource when the link is created; null when unavailable.

SharedUrlResult.sharedByUserId ● Int scalar

User who created the link; null for legacy links without a recorded sharer.

SharedUrlResult.totalViews ● Int scalar

Recorded successful share lookups, incremented when at least one second has elapsed since the last counted lookup.

SharedUrlResult.sharedByUserEmail ● String scalar

Email of the user who created the link; set by sharedUrls and for existing links from sharedUrl, else null.

SharedUrlResult.sharedByUserName ● String scalar

Name of the user who created the link; set by sharedUrls and for existing links from sharedUrl, else null.

SharedUrlResult.createdAt ● Int scalar

Share-link creation time in Unix seconds.

SharedUrlResult.lastViewedAt ● Int scalar

Last counted share lookup in Unix seconds; null before a counted lookup.

Returned By

regenerateSharedUrl mutation ● regenerateSharedUrlList mutation ● sharedUrl query ● updateSharedUrl mutation ● updateSharedUrlList mutation

Member Of

SharedUrlListResults object