{"openapi":"3.0.3","info":{"title":"Content API","description":"Delivers personalised content via Dotdigital Personalization slots and experiences. Use this API to list the slots configured for a given page, retrieve the content for a single slot or multiple slots in one call, and record click-through events to support attribution and reporting. Designed for server-side rendering and headless personalisation implementations.","version":"1.0.1"},"servers":[{"url":"https://{content_domain}","variables":{"content_domain":{"description":"Your content serving domain for Dotdigital Personalization.","default":"your_fr_content_domain"}}}],"security":[{"ApiKeyAuth":[]}],"paths":{"/{website_id}/campaigns/":{"get":{"tags":["Retrieve content"],"summary":"List slots for a page","description":"Retrieve a list of slots used on a page, which then can be used to perform custom server-side personalization.\n\nExample: ``","operationId":"getCampaigns","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"d","in":"query","description":"Device ID for the site visitor, from the tracking cookies.","required":false,"schema":{"type":"string"}},{"name":"url","in":"query","description":"The full URL for the page the personalization content is served on. **Must be URL encoded!**","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Available slots","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/inline_response_200"},"x-examples":{"Example 1":[{"_id":"5ef5e08646606491920ba7d1","contentconfig":"1726070796203","priority":2,"takeover":false,"name":"Default Experience","dt":"2020-06-26T11:48:22.545Z","archive_dt":"","slug":"joj3uai","archive":false,"activity_in_last_24":"2024-10-04T09:08:44.108Z","users":105,"views":394,"content_config_id":"66e1c00ce8b91d44c0185c15"}]}},"examples":{"Simple example":{"value":[{"_id":"5ef5e08646606491920ba7d1","contentconfig":"1726070796203","priority":2,"takeover":false,"name":"Default Experience","dt":"2020-06-26T11:48:22.545Z","archive_dt":"","slug":"joj3uai","archive":false,"activity_in_last_24":"2024-10-04T09:08:44.108Z","users":105,"views":394,"content_config_id":"66e1c00ce8b91d44c0185c15"}]}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"}}}},"/{website_id}/s/{slotId}":{"get":{"tags":["Retrieve content"],"summary":"Retrieve a slot","description":"Retrieves the content of a slot, which then can be used to perform custom server-side personalization.","operationId":"getSlot","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"slotId","in":"path","description":"The slot's id you want the content for.","required":true,"schema":{"type":"string"}},{"name":"format","in":"query","description":"Required format for the content.","required":false,"schema":{"type":"string","enum":["html","blockimage","dynamichtml","full","compact","appjson"],"default":"html"}},{"name":"e","in":"query","description":"The email address of the site visitor.","required":false,"schema":{"type":"string"}},{"name":"d","in":"query","description":"Device ID for the site visitor, from the tracking cookies.","required":false,"schema":{"type":"string"}},{"name":"cid","in":"query","description":"The shopper's customer ID. This only works if this value is known to Dotdigital Personalization already.","required":false,"schema":{"type":"string"}},{"name":"prid","in":"query","description":"Unique product identifier e.g. _12345_","required":false,"schema":{"type":"string"}},{"name":"sbr","in":"query","description":"Site Brand/Territory for the product (e.g. the product was shown in USD on the US version of the store) e.g. _DEMO_","required":false,"schema":{"type":"string"}},{"name":"curr","in":"query","description":"Currency - ISO 4217 currency code e.g. _USD_","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The slots content in the requested format.","content":{"text/html":{"examples":{"Format html":{"value":"\n \n \n \n
\n \n \"GIF\"\n \n
"},"Format blockimage":{"value":"\n \n \n \n
\n \n \"GIF\"\n \n
"},"Format dynamichtml":{"value":"\n \n \n \n
\n
"}}},"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_1"},"examples":{"Format full":{"value":"{\n \"html\": \"\\n\\n \\n\\n \\n\\n \\n\\n
\\n\\n \\n\\n \\\"GIF\\\"\\n\\n \\n\\n
\",\n \"js\": null,\n \"css\": null,\n \"var\": {\n \"tmclt\": true\n },\n \"meta\": {\n \"tmsl\": \"push2dd\",\n \"tmsb\": \"aa7u9zu\",\n \"tmrl\": \"l0tt40i\",\n \"tmcs\": \"iz2z0mg\",\n \"tmcv\": 0,\n \"tmty\": \"e\",\n \"tmsn\": \"Test LS\",\n \"products\": []\n }\n}"},"Format compact":{"value":"{\n \"html\": null,\n \"js\": null,\n \"css\": null,\n \"var\": {},\n \"meta\": {\n \"tmsl\": \"push2dd\",\n \"tmsb\": \"aa7u9zu\",\n \"tmrl\": \"l0tt40i\",\n \"tmty\": \"e\",\n \"tmsn\": \"Test LS\"\n },\n \"items\": []\n}"},"Format appjson":{"value":"{\n \"html\": \"\\n\\n\\n\\n \\n\\n \\n\\n \\n\\n
\\n\\n \\n\\n \\\"GIF\\\"\\n\\n \\n\\n
\\n\",\n \"js\": null,\n \"css\": null,\n \"var\": {},\n \"meta\": {\n \"tmsl\": \"push2dd\",\n \"tmsb\": \"aa7u9zu\",\n \"tmrl\": \"l0tt40i\",\n \"tmcs\": \"iz2z0mg\",\n \"tmcv\": 0,\n \"tmty\": \"e\",\n \"tmsn\": \"Test LS\",\n \"products\": []\n },\n \"items\": []\n}"}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"}}}},"/{website_id}/multislots/{slotIds}/":{"get":{"tags":["Retrieve content"],"summary":"Retrieve multiple slots","description":"Retrieves the content of multiple slots at once, which then can be used to perform custom server-side personalization at scale.","operationId":"getMultiSlots","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"slotIds","in":"path","description":"The slot's id you want the content for.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"format","in":"query","description":"By default the request will return a JSON list of objects that contain the html in the `html` field. The response can be formatted to return the html separated by a fixed string by setting the format to `sfmc`.","required":false,"schema":{"type":"string","example":"sfmc","enum":["sfmc"]}},{"name":"sfmc_separator","in":"query","description":"The seperator line to use between slot HTML blocks to delimit them when using the `format=sfmc` option.","required":false,"schema":{"type":"string","example":"[slot end]","default":"[sfmcend]"}},{"name":"e","in":"query","description":"The email address of the site visitor.","required":false,"schema":{"type":"string"}},{"name":"response_timeout","in":"query","description":"The max amount of time in seconds to wait for the slots content to be retrieved.","required":false,"schema":{"maximum":180,"minimum":1,"type":"integer","example":25,"default":25}}],"responses":{"200":{"description":"The slots content in the requested format.","content":{"application/json":{"schema":{"type":"array","description":"The requested slot details.","items":{"$ref":"#/components/schemas/slotDetails"}},"example":[{"html":"\n\n \n\n \n\n \n\n
\n\n \n\n \"GIF\"\n\n \n\n
","var":{"tmclt":true},"meta":{"tmsl":"push2dd","tmsb":"aa7u9zu","tmrl":"l0tt40i","tmcs":"iz2z0mg","tmcv":0,"tmty":"e","tmsn":"Test LS","products":[]}},{"html":"\n \n \n \n \n \n \n\n
\n\n \n\n
","var":{"tmclt":true},"meta":{"tmsl":"ls-test-min-width","tmsb":"bpf5d3l","tmrl":"tpckuab","tmcs":"469hr7i","tmty":"e","tmsn":"ls test min width","products":[]}}]},"text/html":{"example":"\n\n \n\n \n\n \n\n
\n\n \n\n \"GIF\"\n\n \n\n
[sfmcend]\n\n \n\n \n\n \n\n
\n\n \n\n
[sfmcend]"}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"}}}},"/{website_id}/tc/":{"post":{"tags":["Track activity"],"summary":"Track a click through","description":"This call is used to track click throughs when using custom HTML in personalization.","operationId":"getTrackClickThrough","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/website_id_tc_body"}}}},"responses":{"200":{"description":"Call successful"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"}}}}},"components":{"schemas":{"slotDetails":{"required":["css","html","js","meta","var"],"type":"object","properties":{"html":{"type":"string","description":"The slots HTML","nullable":true},"js":{"type":"string","description":"The slots JavaScript","nullable":true},"css":{"type":"string","description":"The slots CSS styles","nullable":true},"var":{"type":"object","additionalProperties":true,"description":"Any variables associated with the slot."},"meta":{"type":"object","additionalProperties":true,"description":"Any meta data associated with the slot."},"items":{"type":"array","description":"A list of the products to be displayed by recommendation blocks.","items":{"$ref":"#/components/schemas/Product"}}}},"Product":{"required":["_id"],"type":"object","properties":{"_id":{"type":"string","description":"The Dotdigital Personalization unique identifier for a product.","example":"hK8cs10zbudEoqpkl2IvFQ=="},"related":{"type":"array","description":"The product ids related to this product.","example":["32323211","21324343"],"items":{"type":"string"}},"cat":{"type":"array","description":"The categories the product belongs to.","example":["Skis"],"items":{"type":"string"}},"curr":{"type":"string","description":"Price currency - ISO 4217 currency code.","example":"USD"},"n":{"type":"string","description":"Name of the product.","example":"Ti Xelium Skis DH6"},"u":{"type":"string","description":"Product URL.","format":"url","example":"https://example.com/prd/5354127294631"},"prid":{"type":"string","description":"Your unique product id.","example":"5354127294631"},"sku":{"type":"string","description":"The SKU for the product.","example":"SKI-TI-XELIUM-DH6"},"rid":{"type":"string","description":"Product review ID.","example":"df234a"},"sbr":{"type":"string","description":"Site brand.","example":"AbsoluteSki"},"desc":{"type":"string","description":"Product description.","example":"Power turn skis"},"img":{"type":"string","description":"Product image URL.","format":"url"},"img_tn":{"type":"string","description":"Product thumbnail URL.","format":"url"},"uv":{"type":"number","description":"Unit value, price in numeric format.","example":180},"up":{"type":"string","description":"Unit price, price with currency symbol.","example":"$180.00"},"ruv":{"type":"number","description":"Regular unit value (e.g. price before any sale or offer) numeric value.","example":220},"rup":{"type":"string","description":"Regular unit price (e.g. price before any sale or offer) value with currency symbol.","example":"$220.00"},"qty":{"type":"integer","description":"Quantity sold in e.g. multi packs.","example":1},"stock":{"type":"integer","description":"Quantity in stock.","example":12},"ex":{"type":"object","description":"Extension properties.","example":{"color":"red","width":330,"height":1500,"depth":260}},"opt":{"$ref":"#/components/schemas/Product_opt"},"lang":{"type":"string","description":"Language of the product description using ISO 639 language codes.","example":"en"},"promo":{"type":"array","description":"Promotional flags.","items":{"type":"string"}},"reviews":{"$ref":"#/components/schemas/Product_reviews"},"review_locale":{"type":"string","description":"Language Location using a combination of ISO 639 language codes and ISO 3166-1 alpha-2 format country code.","example":"en-GB"},"vid":{"type":"string","description":"Variant identifier.","example":"5354127294631-1"},"pth":{"type":"string","description":"Path of the product e.g. clothes/jumpers. Should only be used of the path is fixed for one product. Product ID / SKU preferred.","example":"snow/skis/5354127294631"},"variants":{"type":"array","description":"Variants","items":{"type":"object"}},"location_ids":{"type":"array","description":"Location ids for this product.","items":{"type":"string"}},"variant_count":{"type":"integer","description":"How many variants exist.","example":3},"variant_keys":{"type":"array","description":"List of variant ids","items":{"type":"string"}},"dt":{"type":"string","description":"Date last modified in ISO-8601 format.","example":"2024-10-31T05:38:33.878Z"},"edt":{"type":"string","description":"Date last used in an email in ISO-8601 format.","example":"2024-10-31T05:38:33.878Z"},"dtadded":{"type":"string","description":"Date first added in ISO-8601 format.","example":"2024-10-31T05:38:33.878Z"},"ai":{"type":"object","description":"AI details."},"meta":{"type":"object","description":"Meta data."}},"description":"Product details"},"inline_response_200":{"type":"object","properties":{"_id":{"type":"string","description":"The unique id for this experience"},"contentconfig":{"type":"string"},"priority":{"type":"integer","description":"The priority for displaying this experience"},"takeover":{"type":"boolean","description":"Whether this experience should take over all other content or not."},"name":{"type":"string","description":"Name of the experience"},"dt":{"type":"string","description":"Creation date for this experience in ISO 8601 format."},"archive_dt":{"type":"string","description":"The arhive date time in ISO 8601 format, if archived."},"slug":{"type":"string","description":"Unique slug to refer to this experience"},"archive":{"type":"boolean","description":"Has this been archived"},"activity_in_last_24":{"type":"string","description":"The last time in the last 24hrs this experience was used in ISO 8601 format"},"users":{"type":"integer","description":"Number of users who have experienced this"},"views":{"type":"integer","description":"Numbers of views ever"},"content_config_id":{"type":"string"}}},"inline_response_200_1":{"oneOf":[{"allOf":[{"description":"Format `Full`"},{"$ref":"#/components/schemas/slotDetails"}]}]},"website_idtc_meta":{"required":["tmcs","tmcv","tmrl","tmsb","tmsl"],"type":"object","properties":{"tmsl":{"type":"string","description":"Slot id","example":"my-slot-id"},"tmsb":{"type":"string","description":"Smartblock id","example":"abc123"},"tmrl":{"type":"string","description":"Rule id","example":"xyz123"},"tmcs":{"type":"string","description":"Layout id","example":"yyy000"},"tmcv":{"minimum":0,"type":"integer","description":"Layout revision"},"tmty":{"type":"string","description":"Slot type\n- **w** - Web slot\n- **e** - Email slot","enum":["e","w"],"default":"w"}},"description":"The meta data of the slot you are tracking the click for."},"website_id_tc_body":{"required":["c","meta","target"],"type":"object","properties":{"meta":{"$ref":"#/components/schemas/website_idtc_meta"},"oid":{"type":"string","description":"_id value from the item that was clicked (if present)","example":"DtqoVDld2Xcj1sYBySy2xw=="},"vid":{"type":"string","description":"Variant ID value from the item that was clicked","example":"a235235b"},"c":{"type":"string","description":"Cookie ID for the user that clicked","example":"abc123"},"target":{"type":"string","description":"URL of the link (e.g. to the item clicked)","format":"url","example":"https://www.example.com/product1"}},"description":"The tracking identifiers and meta data for the slot."},"Product_opt":{"type":"object","properties":{"img":{"type":"string","description":"Product image URL.","format":"url"},"img_tn":{"type":"string","description":"Product thumbnail URL.","format":"url"},"n":{"type":"string","description":"Name of the product.","example":"Ti Xelium Skis DH6"},"u":{"type":"string","description":"Product URL.","format":"url","example":"https://example.com/prd/5354127294631"},"uv":{"type":"number","description":"Unit value, price in numeric format.","example":180},"up":{"type":"string","description":"Unit price, price with currency symbol.","example":"$180.00"},"ruv":{"type":"number","description":"Regular unit value (e.g. price before any sale or offer) numeric value.","example":220},"rup":{"type":"string","description":"Regular unit price (e.g. price before any sale or offer) value with currency symbol.","example":"$220.00"}},"description":"Options"},"Product_reviews":{"type":"object","properties":{"dt":{"type":"string","description":"Date of last review in ISO-8601 format.","example":"2024-10-31T05:38:33.878Z"}},"description":"Product review details."}},"parameters":{"WebsiteId":{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","name":"k","in":"query"}}},"x-samples-languages":["curl","csharp","java","javascript","node","python","php","ruby"]}