Skip to main content

sharedUrl

Returns the public share link for a resource the caller can access, creating an enabled link when none exists. An existing link is returned as is, even when disabled and regardless of originalUrl; use sharedUrls and the share-link mutations to manage links. Requires sharing create access.

sharedUrl(
  type: SharedUrlType!
  itemId: ID!
  siteId: Int
  originalUrl: String
): SharedUrlResult

Arguments​

sharedUrl.type ● SharedUrlType! non-null enum​

Resource type to share; UNKNOWN is not supported for creation.

sharedUrl.itemId ● ID! non-null scalar​

Resource id from the query named by type: numeric for most types, fingerprint for errors, add-on id for surveys/CTAs. Use recordingsIdsInGroup for numeric recording ids, not hashed player ids.

sharedUrl.siteId ● Int scalar​

Site id from sites; required for errors, surveys and CTAs, optional to scope a funnel lookup.

sharedUrl.originalUrl ● String scalar​

Optional app URL the link opens, a path starting with / or an http(s) Crazy Egg URL. sharedResource redirects to it for most types and keeps only its # fragment for Heatmaps; ignored when the link exists.

Type​

SharedUrlResult object​

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