Dossier Sharing

POST dossiers/links

Generates a permalink for the specified dossier which will expire after the set number of days.

Request

curl -X POST 'https://api.pricehubble.com/api/v1/dossiers/links' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer 74126eab0a9048d993bda4b1b55ae074' \
  -d '{
  "dossierId": "2ec6d24e-8587-4ab5-a41e-0c4e4bd4faa7",
  "daysToLive": 14,
  "countryCode": "CH",
  "locale": "en_GB"
}'

Field	Description	Type	Remarks
dossierId	Unique ID of the dossier	string	See Dossier Creation
daysToLive	Number of days for the link to be valid	integer	min: 1, max: 365, default: 365
countryCode	ISO country code	string
locale	User locale	string
canGeneratePdf	Whether a PDF can be printed from the link	boolean	default: true

Response

{
    "id": "6ffce5fe-26bb-43ce-9a6e-56b93f5b351a",
    "url": "https://dash.pricehubble.com/shared/dossier/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzaGFyZUlkIjoiNmZmY2U1ZmUtMjZiYi00M2NlLTlhNmUtNTZiOTNmNWIzNTFhIiwic2hhcmVUeXBlIjoidmFsdWF0aW9uIiwiY3JlYXRlZEJ5IjowLCJjcmVhdGVkQnlPcmciOjAsImxvY2FsZSI6ImVuX0dCIiwiaWF0IjoxNTQyMzczNzM3fQ.MwXyiGud88ogJBAsfaBFLCWTCDO7sh_B6kkiJFWQqoc"
}

Field	Description	Type	Remarks
id	Unique ID of the generated link	string
url	Shareable link to PriceHubble Dash.

Shareable link configuration

There are a few parameters you can configure in your shared link as querystring parameters.

Parameter	Definition	Example
lang	Override UI language of shared link (Supported languages: de, en, fr, it, ja, nl)	lang=en
ga_tracking_id	Custom google analytics tracking id	ga_tracking_id=UA-222222222-1