Share - Storefront GraphQL API

mutation

createShortLink

Creates a shortened version of a given URL for easier sharing.

Arguments

shortLinkReqInput

Request schema for creation of short link that includes original link, meta data, hash of url, campaign attributes, redirect attributes and social media attributes of short link to be created.

Response

String

Key used to uniquely identify document that contains shortlink details.

active

Boolean

Status of the shortlink.

app_redirect

Boolean

Application redirection flag of shortlink.

application

String

The ID of the sales channel associated with the shortlink.

attribution

Attribution

Additional attributes of shortlink.

campaign

CampaignShortLink

Campaign attributes of shortlink.

count

Int

Click count of shortlink.

created_at

String

The timestamp indicating when a record was initially created.

created_by

String

Reference of the creator of the shortlink.

enable_tracking

Boolean

Flag to enable tracking of a short link.

expire_at

String

Expiry of the shortlink.

fallback

RedirectType

Fallback attributes of shortlink.

meta

JSON

Additional attributes of shortlink.

personalized

Boolean

To create personalized short links.

redirects

Redirects

Redirection attributes of shortlink.

social_media_tags

SocialMediaTags

Social media attributes of shortlink.

title

String

Name reference of the shortlink.

updated_at

String

The timestamp indicating when a record was last modified or updated.

url

UrlInfo

Original web address which will be converted to shortlink.

user_id

String

Identifier which can uniquely identify the user.

Mutation

1mutation createShortLink($shortLinkReqInput: ShortLinkReqInput) {
2  createShortLink(shortLinkReqInput: $shortLinkReqInput) {
3    id
4    active
5    app_redirect
6    application
7    attribution {
8      campaign_cookie_expiry
9    }
10    campaign {
11      medium
12      source
13    }
14    count
15    created_at
16    created_by
17    enable_tracking
18    expire_at
19    fallback
20    meta
21    personalized
22    redirects {
23      force_web
24    }
25    social_media_tags {
26      description
27      image
28      title
29    }
30    title
31    updated_at
32    url {
33      hash
34      original
35      short_url
36    }
37    user_id
38  }
39}

Try it

Input Variables

1{
2  "shortLinkReqInput": {
3    "active": true,
4    "attribution": {
5      "campaign_cookie_expiry": "campaign_cookie_expiry"
6    },
7    "campaign": {
8      "medium": "medium",
9      "source": "source"
10    },
11    "count": 42,
12    "enable_tracking": true,
13    "expire_at": "expire_at",
14    "hash": "hash",
15    "personalized": true,
16    "redirects": {
17      "android": {
18        "link": "link",
19        "type": "web"
20      },
21      "force_web": true,
22      "ios": {
23        "link": "link",
24        "type": "web"
25      },
26      "web": {
27        "link": "link",
28        "type": "web"
29      }
30    },
31    "social_media_tags": {
32      "description": "A description",
33      "image": "image",
34      "title": "title"
35    },
36    "title": "title",
37    "url": "https://website.com"
38  }
39}

Response

1{
2  "createShortLink": {
3    "id": "08a16b83-9094-4e89-8c05-2ccadd5c1c7e",
4    "active": true,
5    "app_redirect": true,
6    "application": "application",
7    "attribution": {
8      "campaign_cookie_expiry": "campaign_cookie_expiry"
9    },
10    "campaign": {
11      "medium": "medium",
12      "source": "source"
13    },
14    "count": 42,
15    "created_at": "created_at",
16    "created_by": "created_by",
17    "enable_tracking": true,
18    "expire_at": "expire_at",
19    "fallback": "web",
20    "meta": {},
21    "personalized": true,
22    "redirects": {
23      "force_web": true
24    },
25    "social_media_tags": {
26      "description": "A description",
27      "image": "image",
28      "title": "title"
29    },
30    "title": "title",
31    "updated_at": "updated_at",
32    "url": {
33      "hash": "hash",
34      "original": "original",
35      "short_url": "short_url"
36    },
37    "user_id": "user_id"
38  }
39}

Was this section helpful?

« WalletResponse

shortLink »