{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"0cf0f3cf-bd48-42ad-847d-a4726921fdfd","name":"Keak | API","description":"# Keak API Documentation\n\nWelcome to the Keak API documentation! This guide will walk you through the various endpoints available, how to authenticate, and how to interact with our API to enhance your website optimization processes.\n\n## Overview\n\nKeak is a powerful platform designed to automatically optimize your website's conversion rates using AI-driven A/B testing. Our API allows developers to seamlessly integrate and interact with Keak's services, enabling you to automate testing, manage variations, and track performance effortlessly.\n\n### Key Features:\n\n- Automated A/B Testing: Launch and monitor tests directly through the API.\n    \n- Variation Management: Generate and manage content variations programmatically.\n    \n- Event Tracking: Track key user interactions and optimize based on real-time data.\n    \n- Scalable & Flexible: Designed to handle high-traffic websites with ease.\n    \n\n## Authentication\n\nTo interact with the Keak API, you need to authenticate your requests using an API key. This key is unique to your account and should be kept secure.\n\n### How to Authenticate:\n\n- API Key: Include your API key in the `X-Api-Key` header of every request.\n    \n\n## Response Structure\n\nAll endpoints respond with same structure.  \n  \nIf the response is describing an error it looks as following\n\n``` json\n{\n  \"meta\": {\n    \"error\": {\n       \"code\": 1000, // error specific code\n        \"message\": \"Something went wrong\"\n     },\n     \"status\": 401\n  },\n  \"data\": null\n}\n\n ```\n\nIf the request succeeded, the response will look as following\n\n``` json\n{\n  \"meta\": {\n    \"error\": null,\n    \"status\": 200\n  },\n  \"data\": {\n     \"hello\": \"world\"\n  }\n}\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"32223172","team":6065348,"collectionId":"0cf0f3cf-bd48-42ad-847d-a4726921fdfd","publishedId":"2sAXjDfbGK","public":true,"publicUrl":"https://documenter-api.postman.tech/view/32223172/2sAXjDfbGK","privateUrl":"https://go.postman.co/documentation/32223172-0cf0f3cf-bd48-42ad-847d-a4726921fdfd","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"3f83f8"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/b4bf005c-5519-474d-a2ef-ed7e352db950/U2NyZWVuc2hvdCAyMDI0LTA4LTIyIGF0IDIuNTEuMDTigK9QTS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"3f83f8"}},{"name":"light","logo":"https://content.pstmn.io/b4bf005c-5519-474d-a2ef-ed7e352db950/U2NyZWVuc2hvdCAyMDI0LTA4LTIyIGF0IDIuNTEuMDTigK9QTS5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"3f83f8"}}]}},"version":"8.11.4","publishDate":"2024-08-22T23:30:37.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/b4bf005c-5519-474d-a2ef-ed7e352db950/U2NyZWVuc2hvdCAyMDI0LTA4LTIyIGF0IDIuNTEuMDTigK9QTS5wbmc=","logoDark":"https://content.pstmn.io/b4bf005c-5519-474d-a2ef-ed7e352db950/U2NyZWVuc2hvdCAyMDI0LTA4LTIyIGF0IDIuNTEuMDTigK9QTS5wbmc="}},"statusCode":200},"environments":[{"name":"Production","id":"7a5c4301-6cfe-4965-9f01-f97cf7e738e3","owner":"32223172","values":[{"key":"headline-ab-testing-host","value":"https://api.keak.com","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/95c0cae633cfbf902a1c8f72d12e509a4ebcb14fe9a3cbd75c1dcc4bfc98b3b3","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Production","value":"32223172-7a5c4301-6cfe-4965-9f01-f97cf7e738e3"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAXjDfbGK"}