Create share URL

Given a full URL generates a short url id that can be used for sharing

POST /api/v1/share

Error

A valid request URL is required to generate request examples

201

{
  "results": {
    "params": "<string>",
    "path": "<string>",
    "nanoid": "<string>",
    "host": "<string>",
    "url": "<string>",
    "shareUrl": "<string>",
    "organizationUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdByUserUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "status": "ok"
}

Body

application/json

a full URL used to generate a short url id

a full URL used to generate a short url id

path · string · required

The URL path of the full URL

params · string · required

Response

201

application/json

Created

results · object · required

A ShareUrl maps a short shareable id to a full URL in the Lightdash UI. This allows very long URLs to be represented by short ids.

Show child attributes

status · enum<string> · required

Available options: ok