Get share URL

Get a share url from a short url id

GET /api/v1/share/{nanoId}

Error

A valid request URL is required to generate request examples

200

{
  "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"
}

{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  },
  "status": "error"
}

Path Parameters

nanoId · string · required

the short id for the share url

Response

200

application/json

Ok

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