{"info":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","description":"

CookieScript API Documentation

To get started:

Set your token variable in the environment.
\n
Explore available endpoints grouped by feature.
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"CookieScript API Documentation","slug":"cookiescript-api-documentation"}],"owner":"43553259","collectionId":"288f0651-c964-4115-8f4a-715ba0747985","publishedId":"2sB3QFRXix","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-10-01T06:51:19.000Z"},"item":[{"name":"Banners","item":[{"name":"List","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"0526df9b-c2cb-479d-bec1-45e4380e9582"}}],"id":"2232e82f-3950-4467-8584-774e369f001e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://cookie-script.com/api/open/v1/banners","description":"

Endpoint: List Banners

Method: GET
URL: https://cookie-script.com/api/open/v1/banners

Description

Returns a list of all banners accessible to the user.

Query Parameters

None.

Response

Example of a successful response:

{\n  \"success\": true,\n  \"message\": \"\",\n  \"data\": [\n    {\n      \"id\": \"\",\n      \"domain\": \"\",\n      \"published\": true,\n      \"shared\": true,\n      \"sharedWithMe\": true,\n      \"shareInfo\": []\n    }\n  ]\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}},"urlObject":{"path":["v1","banners"],"host":["https://cookie-script.com/api/open"],"query":[],"variable":[]}},"response":[],"_postman_id":"2232e82f-3950-4467-8584-774e369f001e"},{"name":"Show","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"b5f6a311-c147-4569-a29c-2b976222b6a8"}}],"id":"e8e2eed4-6370-4c7a-9558-333e89ceb683","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://cookie-script.com/api/open/v1/banners/show?id=82a26e9448de35155e909dcdbe1b5633","description":"\n

Method: GET
URL: https://cookie-script.com/api/open/v1/banners/show?id=

🔍 Description

Returns detailed information about a specific banner by ID.

Query Parameters

id (string, required): Banner ID

Response

200 OK
The response will be in JSON format and will have the following structure:

{\n  \"success\": true,\n  \"message\": \"\",\n  \"data\": {\n    \"id\": \"\",\n    \"webSiteUrl\": \"\",\n    \"settings\": [\n      {\n        \"id\": \"\",\n        \"name\": \"\",\n        \"value\": \"\"\n      }\n    ]\n  }\n}\n\n

The response will include a success flag indicating the success status of the request, a message field for any additional information, and a data object containing the detailed information about the specific banner.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}},"urlObject":{"path":["v1","banners","show"],"host":["https://cookie-script.com/api/open"],"query":[{"key":"id","value":"82a26e9448de35155e909dcdbe1b5633"}],"variable":[]}},"response":[],"_postman_id":"e8e2eed4-6370-4c7a-9558-333e89ceb683"},{"name":"Delete","id":"84c2f980-39c5-4581-859a-c61e87f46d74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://cookie-script.com/api/open/v1/banners/delete?id=9b830d978de36b18974031a9a7d31777","description":"\n

Method: DELETE
URL: https://cookie-script.com/api/open/v1/banners/delete?id=

Description

Deletes the banner specified by ID.

Query Parameters

id (string, required): Banner ID

Response

200 OK
The response will be in JSON format and will have the following structure:

{\n  \"success\": true,\n  \"message\": \"Item deleted successfully\",\n  \"data\": {}\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}},"urlObject":{"path":["v1","banners","delete"],"host":["https://cookie-script.com/api/open"],"query":[{"key":"id","value":"9b830d978de36b18974031a9a7d31777"}],"variable":[]}},"response":[],"_postman_id":"84c2f980-39c5-4581-859a-c61e87f46d74"},{"name":"Duplicate","id":"16f3d105-c281-4c8e-b6c3-3dd3ebb36b2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"domain\": \"test-duplicate.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cookie-script.com/api/open/v1/banners/duplicate?id=","description":"\n

Method: POST
URL: https://cookie-script.com/api/open/v1/banners/duplicate?id=

Description

Creates a copy of the banner with the given ID.

Query Parameters

id (string, required): Original banner ID

Request Body

domain (string, required): URL of the website where the banner will be displayed.
\n
withReport(boolean, default: false): If true the banner includes a report.
\n

Request Body

{\n  \"domain\": \"test-duplicate.com\"\n}\n\n

Response

200 OK

{\n  \"success\": true,\n  \"message\": \"Item copied as <strong class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>{{domain from request}}</b>\",\n  \"data\": {\n    \"id\": \"\"\n  }\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}},"urlObject":{"path":["v1","banners","duplicate"],"host":["https://cookie-script.com/api/open"],"query":[{"key":"id","value":""}],"variable":[]}},"response":[],"_postman_id":"16f3d105-c281-4c8e-b6c3-3dd3ebb36b2c"},{"name":"Update","id":"adba5b4b-780a-46d1-ae8f-c426c8c1951c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"position_side\": \"right\",\n \"box_title\": \"Test Api Title 2\",\n \"box_description\": \"Desc test api\",\n \"for_subdomains\": \"no\",\n \"microsoft_clarity\": \"yes\",\n \"catid\": 6\n}","options":{"raw":{"language":"json"}}},"url":"https://cookie-script.com/api/open/v1/banners/update?id=82a26e9448de35155e909dcdbe1b5633","description":"\n

Method: PUT
URL: https://cookie-script.com/api/open/v1/banners/update?id=82a26e9448de35155e909dcdbe1b5633

Description

Updates the specified banner's settings.

Query Parameters

id (string, required): Banner ID

Request Body(show Banner Options)

{\n  \"position_side\": \"right\",\n  \"box_title\": \"Api box title\",\n  \"box_description\": \"Description api\",\n  \"for_subdomains\": \"no\",\n  \"microsoft_clarity\": \"yes\",\n  \"catid\": 1\n}\n\n

Response

200 OK

{\n  \"success\": true,\n  \"message\": \"Changes saved\",\n  \"data\": []\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}},"urlObject":{"path":["v1","banners","update"],"host":["https://cookie-script.com/api/open"],"query":[{"key":"id","value":"82a26e9448de35155e909dcdbe1b5633"}],"variable":[]}},"response":[],"_postman_id":"adba5b4b-780a-46d1-ae8f-c426c8c1951c"},{"name":"Create","id":"6672de9f-fb64-45b3-ab48-7c9bedabbcc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Site create form api\",\n \"webSiteUrl\": \"http://test-site.api\",\n \"customcss\": \"#cookiescript_header { color: red; }\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cookie-script.com/api/open/v1/banners/create","description":"\n

Method: POST
URL: https://cookie-script.com/api/open/v1/banners/create

Description

Creates a new banner with the specified parameters.

Request Body

title (string, required): Title of the banner.
\n
webSiteUrl (string, required): URL of the website where the banner will be displayed.
\n
initScan (boolean, default: false): If true, a website scan will be started after creation.
\n

Request Body

{\n  \"title\": \"Site create form api\",\n  \"webSiteUrl\": \"http://test-site.api\",\n  \"customcss\": \"#cookiescript_header { color:  ...\"\n}\n\n

Response

200 OK

{\n  \"success\": true,\n  \"message\": \"Changes saved\",\n  \"data\": []\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}},"urlObject":{"path":["v1","banners","create"],"host":["https://cookie-script.com/api/open"],"query":[],"variable":[]}},"response":[],"_postman_id":"6672de9f-fb64-45b3-ab48-7c9bedabbcc6"},{"name":"Share","id":"9d11d2af-302c-47fe-b2c1-8048ad59ab6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"share_email\": \"tshare3@share.com\",\n \"allow_editing\": false,\n \"inform_user_by_email\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://cookie-script.com/api/open/v1/banners/share?id=54435d17465b3e8161596c6f073cef06","description":"\n

Method: POST
URL: https://cookie-script.com/api/open/v1/banners/share?id=

Description

Share your banner with other users.

User is registered in the CookieScript: an invitation will appear in his account and the user will be informed by email (optionally)

User is not registered in the CookieScript: a new account will be created automatically and the user will receive an email with a login and password to access the shared banner.

Query Parameters

id (string, required): Banner ID

Request Body

share_email (string, required): Share to email.
\n
allow_editing (boolean, required): If true, allow another user to edit banner settings, cookie settings and block third-party scripts.
\n
inform_user_by_email (boolean, required): If true, let other user know that a new banner was shared with him?.
\n

Request Body

{\n    \"share_email\": \"tshare3@share.com\",\n    \"allow_editing\": false,\n    \"inform_user_by_email\": true\n}\n\n

Response

200 OK

{\n    \"success\": true,\n    \"message\": \"Item has been shared with user tshare3@share.com\",\n    \"data\": []\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}},"urlObject":{"path":["v1","banners","share"],"host":["https://cookie-script.com/api/open"],"query":[{"key":"id","value":"54435d17465b3e8161596c6f073cef06"}],"variable":[]}},"response":[],"_postman_id":"9d11d2af-302c-47fe-b2c1-8048ad59ab6d"},{"name":"Stop Share","id":"8769ba15-e2b0-4b43-b5fc-22b52242e439","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"share_email\": \"tshare3@share.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cookie-script.com/api/open/v1/banners/stop-share?id=54435d17465b3e8161596c6f073cef06","description":"\n

Method: POST
URL: https://cookie-script.com/api/open/v1/banners/stop-share?id=

Description

Stops sharing a specific banner with a user by email.

Query Parameters

id (string, required): Banner ID

Request Body

share_email (string, required): Stop shate banner for email.

Request Body

{\n    \"share_email\": \"tshare3@share.com\"\n}\n\n

Response

200 OK

{\n    \"success\": true,\n    \"message\": \"Item is no longer shared with the provided email\",\n    \"data\": []\n}\n\n

Banners

Endpoints for managing cookie banners, including listing, creating, updating, duplicating, deleting, and sharing banners.

\n","_postman_id":"b8e4be63-cd4a-4fd0-8247-d6c6c5c3547d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}}},{"name":"Banner Options","item":[{"name":"List","id":"8f8c4a61-a81d-4bbb-9800-3b6b214dd87e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://cookie-script.com/api/open/v1/options","description":"\n

Method: GET
URL: https://cookie-script.com/api/open/v1/options

Description

Returns a list of all available configuration options for banners.

Query Parameters

None.

Response

200 OK

{\n  \"success\": true,\n  \"message\": \"Options retrieved successfully\",\n  \"data\": [\n    {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"hint\": \"string\",\n      \"valueType\": \"string\",\n      \"valueValidation\": null,\n      \"valueOptions\": [],\n      \"meanings\": []\n    }\n  ]\n}\n\n

Retrieve metadata and configuration options used when customizing banners.

\n","_postman_id":"1ebf44a4-6002-453a-b1ab-5ec1365b3762","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}}},{"name":"Consents","item":[{"name":"Dowload","id":"fec041fc-c248-4d54-bea0-b7fabaf21a54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"82a26e9448de35155e909dcdbe1b5633\",\n \"combine\": false,\n \"dateFrom\" : \"2025-01-01\",\n \"dateTo\": \"2025-01-02\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cookie-script.com/api/open/v1/consents","description":"

Endpoint: Download Consents

Method: POST
URL: https://cookie-script.com/api/open/v1/consents

Description

Downloads consent data for a specific banner within a specified date range.

Request Body

id (string, required): Banner ID
\n
dateFrom (string, required, format: Y-m-d): Start date range.
\n
dateTo (string, format: Y-m-d): End date range. If not, then dateTo will be equal to dateFrom.
\n
combine (boolean, default: false): If true, inner files combine into one file.
\n

Request Body

{\n  \"id\": \"82a26e9448de35155e909dcdbe1b5633\",\n  \"combine\": false,\n  \"dateFrom\": \"2025-01-01\",\n  \"dateTo\": \"2025-01-02\"\n}\n\n

Response

200 OK
Returns a file with a zip extension (inner files in CSV format).

Consents

Download GDPR/CCPA consent records for a banner within a given time range.

\n","_postman_id":"c33535b7-7d83-4366-b2d0-6f43ca47128a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}}},{"name":"Scans","item":[{"name":"List","id":"95d9e38e-ba75-43b1-8f80-a9ee52cbd690","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://cookie-script.com/api/open/v1/scans?id=82a26e9448de35155e909dcdbe1b5633","description":"

Endpoint: List Scans

Method: GET
URL: https://cookie-script.com/api/open/v1/scans?id=82a26e9448de35155e909dcdbe1b5633

Description

Returns a list of all scans associated with the given banner.

Query Parameters

id (string, required): ID of the banner

Response

200 OK

{\n  \"success\": true,\n  \"message\": \"\",\n  \"data\": [\n    {\n      \"id\": \"\",\n      \"status\": \"\",\n      \"date\": \"\",\n      \"pagesScanned\": \"\",\n      \"cookiesFound\": 0,\n      \"firstPartyCookies\": 0,\n      \"thirdPartyCookies\": 0,\n      \"manuallyAddedCookies\": 0,\n      \"automaticallyDetectedCookies\": 0,\n      \"localStorages\": 0,\n      \"sessionStorages\": 0,\n      \"initiator\": \"\"\n    }\n  ]\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}},"urlObject":{"path":["v1","scans"],"host":["https://cookie-script.com/api/open"],"query":[{"key":"id","value":"82a26e9448de35155e909dcdbe1b5633"}],"variable":[]}},"response":[],"_postman_id":"95d9e38e-ba75-43b1-8f80-a9ee52cbd690"},{"name":"Show","id":"d775c641-ff17-441c-95e8-81d6e7e2f719","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://cookie-script.com/api/open/v1/scans/show?id=0ab33c9ad30183e3256755c98b9de5e1","description":"

Endpoint: Show Scan

Method: GET
URL: https://cookie-script.com/api/open/v1/scans/show?id=

Description

Retrieves detailed information about a specific scan.

Query Parameters

id (string, required): Scan ID

Response

200 OK
Content-Type: application/json

{\n  \"success\": true,\n  \"message\": \"\",\n  \"data\": {\n    \"urlScanned\": \"\",\n    \"totalPagesScanned\": \"\",\n    \"cookies\": [\n      {\n        \"category\": \"\",\n        \"cookieKey\": \"\",\n        \"domain\": \"\",\n        \"path\": \"\",\n        \"cookieType\": \"\",\n        \"expire\": \"\",\n        \"description\": \"\"\n      }\n    ],\n    \"storage\": []\n  }\n}\n\n

Scans

Access scan results performed on your website for cookie detection and compliance checks.

\n","_postman_id":"f0d7a439-9982-4323-bbca-7bc852847fb2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}}},{"name":"Cookies","item":[{"name":"List","id":"7fc39723-b0cf-44f2-98dd-a1bb437b9068","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://cookie-script.com/api/open/v1/cookies?id=82a26e9448de35155e909dcdbe1b5633","description":"

Endpoint: List Cookies

Method: GET
URL: https://cookie-script.com/api/open/v1/cookies?id=

Description

Returns a list of all cookies associated with a specific banner.

Query Parameters

id (string, required): Banner ID

Response

200 OK

{\n  \"success\": true,\n  \"message\": \"\",\n  \"data\": [\n    {\n      \"id\": \"\",\n      \"cookieKey\": \"\",\n      \"domain\": \"\",\n      \"path\": \"\",\n      \"expiration\": \"\",\n      \"manuallyAdded\": \"\",\n      \"type\": \"\",\n      \"description\": \"\",\n      \"descriptionTranslated\": {\n          \"Dutch\": \"\",\n       }\n    }\n  ]\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}},"urlObject":{"path":["v1","cookies"],"host":["https://cookie-script.com/api/open"],"query":[{"key":"id","value":"82a26e9448de35155e909dcdbe1b5633"}],"variable":[]}},"response":[],"_postman_id":"7fc39723-b0cf-44f2-98dd-a1bb437b9068"},{"name":"Remove","id":"f772160f-7c21-4101-98d3-f178dd39c407","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://cookie-script.com/api/open/v1/cookies/delete?id=82a26e9448de35155e909dcdbe1b5633&cookieId=367109","description":"\n

Method: DELETE
URL: https://cookie-script.com/api/open/v1/cookies/delete?id=&cookieId=

Description

Deletes a cookie from the specified banner.

Query Parameters

id (string, required): Banner ID
\n
cookieId (integer, required): Cookie ID
\n

Response

200 OK

{\n  \"success\": true,\n  \"message\": \"Cookie removed successfully\",\n  \"data\": []\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}},"urlObject":{"path":["v1","cookies","delete"],"host":["https://cookie-script.com/api/open"],"query":[{"key":"id","value":"82a26e9448de35155e909dcdbe1b5633"},{"key":"cookieId","value":"367109"}],"variable":[]}},"response":[],"_postman_id":"f772160f-7c21-4101-98d3-f178dd39c407"},{"name":"Update","id":"c7f5f1bb-c0a0-4799-97eb-389cb935a6e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"type\": \"functionality\",\n \"description\": \"Description update from api\",\n \"descriptionTranslated\": {\n \"Dutch\": \"Dutch description update from api\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://cookie-script.com/api/open/v1/cookies/update?id=82a26e9448de35155e909dcdbe1b5633&cookieId=367110","description":"\n

Method: PUT
URL: https://cookie-script.com/api/open/v1/cookies/update?id=&cookieId=

Description

Updates a cookie linked to a specific banner.

Query Parameters

id (string, required): Banner ID
\n
cookieId (integer, required): Cookie ID
\n

Request Body

type (string): Cookie type:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Value	Meaning
`strict`	Strictly Necessary
`performance`	Performance
`targeting`	Targeting
`functionality`	Functionality
`unclassified`	Unclassified

description (string): Description for cookie.
\n
descriptionTranslated (object): An object that contains translated versions of the cookie description.
\n

Request Body

{\n  \"type\": \"functionality\",\n  \"description\": \"Deascription update from api\",\n  \"descriptionTranslated\": {\n        \"Dutch\": \"Dutch description update from api\"\n    }\n}\n\n

Response

200 OK

{\n    \"success\": true,\n    \"message\": \"Cookie updated successfully\",\n    \"data\": []\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}},"urlObject":{"path":["v1","cookies","update"],"host":["https://cookie-script.com/api/open"],"query":[{"key":"id","value":"82a26e9448de35155e909dcdbe1b5633"},{"key":"cookieId","value":"367110"}],"variable":[]}},"response":[],"_postman_id":"c7f5f1bb-c0a0-4799-97eb-389cb935a6e0"},{"name":"Create","id":"f7867dc4-d1ce-4e5e-b38c-cc9610a67611","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cookieName\": \"\",\n \"cookieDomain\": \"\",\n \"cookiePath\": \"\",\n \"expirationTime\": 0,\n \"secure\": false,\n \"httpOnly\": false,\n \"type\" : \"\",\n \"description\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cookie-script.com/api/open/v1/cookies/create?id=82a26e9448de35155e909dcdbe1b5633","description":"\n

Method: POST
URL: https://cookie-script.com/api/open/v1/cookies/create?id=

Description

Creates a new cookie and links it to a banner.

Query Parameters

id (string, required): Banner ID

Request Body

cookieName (string, required): Cookie name.
\n
cookieDomain (string, required): Cookie domain. Examle: \".test.com\"
\n
cookiePath (string, default: /): Cookie path.
\n
expirationTime (integer, default: 1): Expiration time in seconds. Examples: (3 days: 3* 86400)
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Value(in seconds)	Meaning
0	Session
1	Second
60	Minute
3600	Hour
86400	Day
2592000	Month
31536000	Year

secure (boolean, default: false): Is Secure cookie.
\n
httpOnly (boolean, default: false): Is HttpOnly cookie.
\n
type (string, required): Cookie type:
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Value	Meaning
`strict`	Strictly Necessary
`performance`	Performance
`targeting`	Targeting
`functionality`	Functionality
`unclassified`	Unclassified

description (string): Description for cookie.

Request Body

{\n  \"cookieName\": \"\",\n  \"cookieDomain\": \"\",\n  \"cookiePath\": \"\",\n  \"expirationTime\": 0,\n  \"secure\": false,\n  \"httpOnly\": false,\n  \"type\": \"\",\n  \"description\": \"\"\n}\n\n

Response

200 Ok

{\n    \"success\": true,\n    \"message\": \"Cookie created successfully\",\n    \"data\": []\n}\n\n

Cookies

Manage individual cookies associated with a specific banner, including creating, updating, listing, and deleting cookies.

\n","_postman_id":"88d18594-db3a-4f49-aa88-0072cfbd3598","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}}},{"name":"Analytics","item":[{"name":"List","id":"916c3d87-a965-483a-ab69-00aa90b9654c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://cookie-script.com/api/open/v1/analytics?id=937ba5031b95e70d2c1699668644d309&dateFrom=2025-07-01&dateTo=2025-09-08&t=test","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}},"urlObject":{"path":["v1","analytics"],"host":["https://cookie-script.com/api/open"],"query":[{"key":"id","value":"937ba5031b95e70d2c1699668644d309"},{"key":"dateFrom","value":"2025-07-01"},{"key":"dateTo","value":"2025-09-08"},{"key":"t","value":"test"}],"variable":[]}},"response":[],"_postman_id":"916c3d87-a965-483a-ab69-00aa90b9654c"}],"id":"948b0954-1dc8-4bb1-b641-42390c4e187a","_postman_id":"948b0954-1dc8-4bb1-b641-42390c4e187a","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}}},{"name":"Translations","item":[{"name":"List","id":"835a728c-adeb-477a-af21-95d9837fa477","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://cookie-script.com/api/open/v1/translations?id=82a26e9448de35155e909dcdbe1b5633","description":"

Endpoint: List Translations

Method: GET
URL: https://cookie-script.com/api/open/v1/transaltions?id=

Description

This endpoint retrieves translations for a specified identifier. The translations are provided in multiple languages

Query Parameters

id (string, required): Banner ID

Response

200 OK
The response will be in JSON format and will have the following structure:

{\n  \"success\": true,\n  \"message\": \"\",\n  \"data\": {\n    \"Dutch\": [\n      {\n        \"id\": \"\",\n        \"name\": \"\",\n        \"value\": \"\"\n      }\n    ],\n    \"Bulgarian\": [\n      {\n        \"id\": \"\",\n        \"name\": \"\",\n        \"value\": \"\"\n      }\n    ]\n  }\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}},"urlObject":{"path":["v1","translations"],"host":["https://cookie-script.com/api/open"],"query":[{"key":"id","value":"82a26e9448de35155e909dcdbe1b5633"}],"variable":[]}},"response":[],"_postman_id":"835a728c-adeb-477a-af21-95d9837fa477"},{"name":"Create","id":"22289205-2758-4bdf-8ea0-5e13c2db98b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"language\": \"Arabic\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cookie-script.com/api/open/v1/translations/create?id=82a26e9448de35155e909dcdbe1b5633","description":"

Endpoint: Create Translation

Method: POST
URL: https://cookie-script.com/api/open/v1/translations/create?id=

Description

This endpoint allows you to create a new translation for a specified language. The request requires the language to be specified in the request body.

Query Parameters

id (string, required): Banner ID

Request Body

language (string, required): The language for which the translation is being created. See endpoint SupportLanguages.

Request Body

{\n  \"language\": \"Arabic\"\n}\n\n

Response

200 OK

{\n  \"success\": true,\n  \"message\": \"\",\n  \"data\": []\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}},"urlObject":{"path":["v1","translations","create"],"host":["https://cookie-script.com/api/open"],"query":[{"key":"id","value":"82a26e9448de35155e909dcdbe1b5633"}],"variable":[]}},"response":[],"_postman_id":"22289205-2758-4bdf-8ea0-5e13c2db98b4"},{"name":"SupportLanguages","id":"3cdf22fc-96a5-4baf-a892-aa66f902aee6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://cookie-script.com/api/open/v1/translations/options","description":"

Endpoint: Retrieve Translation Options

This endpoint allows clients to fetch available translation options.

Method: GET

URL: https://cookie-script.com/api/open/v1/translations/options

Example Response

{\n  \"success\": true,\n  \"message\": \"\",\n  \"data\": [\n        \"Arabic\",\n        \"Basque\",\n        \"Bulgarian\",\n        \"Catalan\",\n        \"Chinese(Simplified)\",\n        \"Chinese(Traditional)\",\n        \"Croatian\",\n        \"Czech\",\n        \"Danish\",\n        \"Dutch\",\n        \"English\",\n        \"Estonian\",\n        \"Finnish\",\n        \"French\",\n        \"German\",\n        \"Greek\",\n        \"Hindi\",\n        \"Hungarian\",\n        \"Icelandic\",\n        \"Indonesian\",\n        \"Irish\",\n        \"Italian\",\n        \"Japanese\",\n        \"Korean\",\n        \"Latvian\",\n        \"Lithuanian\",\n        \"Malaysian\",\n        \"Maltese\",\n        \"Norwegian\",\n        \"Polish\",\n        \"Portuguese\",\n        \"Romanian\",\n        \"Russian\",\n        \"Serbian\",\n        \"Slovak\",\n        \"Slovenian\",\n        \"Spanish\",\n        \"Swedish\",\n        \"Thai\",\n        \"Turkish\",\n        \"Ukrainian\",\n        \"Vietnamese\"\n    ]\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}},"urlObject":{"path":["v1","translations","options"],"host":["https://cookie-script.com/api/open"],"query":[],"variable":[]}},"response":[],"_postman_id":"3cdf22fc-96a5-4baf-a892-aa66f902aee6"},{"name":"Update","id":"da7efd3c-57cf-4af6-977a-0b5015744e86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"language\": \"Arabic\",\n \"data\": {\n \"box_title\": \"Arabic title\",\n \"box_description\": \"Arabic description\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://cookie-script.com/api/open/v1/translations/update?id=82a26e9448de35155e909dcdbe1b5633","description":"

Endpoint: Update Translation

Method: PUT
URL: https://cookie-script.com/api/open/v1/translations/update?id=

Description

This endpoint allows you to update an existing translation.

Query Parameters

id (string, required): Banner ID

Request Body

language (string, required): The language for which the translation is being updated.
\n
data (object, required): An object containing the content of the translation.
\n

Request Body

{\n  \"language\": \"Arabic\",\n  \"data\": {\n    \"box_title\": \"Arabic title\",\n    \"box_description\": \"Arabic description\"\n  }\n}\n\n

Response

200 OK

{\n    \"success\": true,\n    \"message\": \"Translation updated successfully\",\n    \"data\": []\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}},"urlObject":{"path":["v1","translations","update"],"host":["https://cookie-script.com/api/open"],"query":[{"key":"id","value":"82a26e9448de35155e909dcdbe1b5633"}],"variable":[]}},"response":[],"_postman_id":"da7efd3c-57cf-4af6-977a-0b5015744e86"},{"name":"Delete","id":"5deb2c3a-d5ee-4942-a6a7-421f88f610a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"language\": \"Arabic\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cookie-script.com/api/open/v1/translations/delete?id=82a26e9448de35155e909dcdbe1b5633","description":"

Endpoint: Delete Translation

Method: DELETE
URL: https://cookie-script.com/api/open/v1/translations/delete?id=

Description

This endpoint allows you to delete a specific translation.

Query Parameters

id (string, required): Banner ID

Request Body

language (string, required): The language associated with the translation that is being deleted.

Request Body

{\n  \"language\": \"Arabic\"\n}\n\n

Response

200 OK

{\n    \"success\": true,\n    \"message\": \"Language deleted successfully\",\n    \"data\": []\n}\n\n

Manage translations associated with a specific banner, including creating, updating, listing, and deleting translations.

\n","_postman_id":"f5d5273e-301c-4d6f-9af3-566d7d887acc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"288f0651-c964-4115-8f4a-715ba0747985","id":"288f0651-c964-4115-8f4a-715ba0747985","name":"CookieScript API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"8107dd2f-8376-446a-b006-958163c9eaef"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"requests":{},"exec":[""],"id":"6c168ac5-2a3e-4280-a2bd-21c6f8391f82"}}],"variable":[{"key":"host","value":"https://cookie-script.com"},{"key":"base_url","value":"https://cookie-script.com/api/open"},{"key":"token","value":"","type":"default"}]}

CookieScript API Documentation

Endpoint: List Banners

Description

Query Parameters

Response

Endpoint: Show Banner

🔍 Description

Query Parameters

Response

Endpoint: Delete Banner

Description

Query Parameters

Response

Endpoint: Duplicate Banner

Description

Query Parameters

Request Body

Request Body

Response

Endpoint: Update Banner

Description

Query Parameters

Request Body(show Banner Options)

Response

Endpoint: Create Banner

Description

Request Body

Request Body

Response

Endpoint: Share Banner

Description

Query Parameters

Request Body

Request Body

Response

Endpoint: Stop Share Banner

Description

Query Parameters

Request Body

Request Body

Response

Banners

Endpoint: List Banner Options

Description

Query Parameters

Response

Banner Options

Endpoint: Download Consents

Description

Request Body

Request Body

Response

Consents

Endpoint: List Scans

Description

Query Parameters

Response

Endpoint: Show Scan

Description

Query Parameters

Response

Scans

Endpoint: List Cookies

Description

Query Parameters

Response

Endpoint: Delete Cookie

Description

Query Parameters

Response

Endpoint: Update Cookie

Description

Query Parameters

Request Body

Request Body

Response

Endpoint: Create Cookie

Description

Query Parameters

Request Body