response = Unirest.post(\"https://api.synerise.com/v4/clients\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"+48111222333\\\",\\\"customId\\\":\\\"string\\\",\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"displayName\\\":\\\"string\\\",\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"avatarUrl\\\":\\\"string\\\",\\\"birthDate\\\":\\\"1987-10-24\\\",\\\"company\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"address\\\":\\\"string\\\",\\\"zipCode\\\":\\\"string\\\",\\\"province\\\":\\\"string\\\",\\\"countryCode\\\":\\\"PL\\\",\\\"sex\\\":\\\"FEMALE\\\",\\\"whatsAppId\\\":\\\"TestWhatsappId\\\",\\\"agreements\\\":{\\\"email\\\":false,\\\"sms\\\":false,\\\"push\\\":false,\\\"webPush\\\":false,\\\"whatsApp\\\":false,\\\"bluetooth\\\":false,\\\"rfid\\\":false,\\\"wifi\\\":false},\\\"attributes\\\":{\\\"property1\\\":null,\\\"property2\\\":null},\\\"tags\\\":[\\\"string\\\"]}\")\n .asString();"}]}},"/v4/clients/merge/from/custom-ids/{sourceCustomIDs}/to/custom-id/{targetCustomID}":{"post":{"summary":"Merge profiles by customId","description":"Moves profile UUIDs to a single profile (which must already exist) and removes the profiles that were merged. \n\nThe event history of the source profiles is moved to the target profile.\n\nThe attributes (data from the `attributes` object) that don't exist in the target profile are copied to the target profile. If an attribute already exists in the target profile, the value from the source profile is lost.\n\nThe properties and tags of the source profiles are lost, even if they don't have a value in the target profile.\n\n WARNING: This operation is irreversible. Use it carefully.
\n WARNING: You should not try to merge more than 10-20 profiles at once.
\n\n For more details, see the [Developer Guide](https://hub.synerise.com/developers/api/clients/profiles/merging-profiles/).\n\n\n---\n\n**API consumer:** Workspace (Business Profile)\n\n**API key permission required:** `API_MERGEBYCUSTOMID_CLIENT_UPDATE`\n","operationId":"MergeClientsByCustomId","parameters":[{"$ref":"#/components/parameters/api-service-pathClientCustomIds-apiv4"},{"$ref":"#/components/parameters/api-service-pathTargetCustomId-apiv4"},{"$ref":"#/components/parameters/api-service-acceptHeader-apiv4"},{"$ref":"#/components/parameters/api-service-contentTypeHeader-apiv4"},{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"responses":{"200":{"description":"Request completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-inResponseClientDetails-apiv4"}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"404":{"description":"Source and/or target profile(s) not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"}}}}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Profile management"],"x-snr-doc-urls":["/api-reference/data-management#tag/Profile-management/operation/MergeClientsByCustomId"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url 'https://api.synerise.com/v4/clients/merge/from/custom-ids/customIdExample,customIdExample2,customIdExample3,customIdExample4,customIdExample5/to/custom-id/customIdExample' \\\n --header 'Accept: SOME_STRING_VALUE' \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'Content-Type: SOME_STRING_VALUE'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = {\n 'Accept': \"SOME_STRING_VALUE\",\n 'Content-Type': \"SOME_STRING_VALUE\",\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\"\n }\n\nconn.request(\"POST\", \"/v4/clients/merge/from/custom-ids/customIdExample,customIdExample2,customIdExample3,customIdExample4,customIdExample5/to/custom-id/customIdExample\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/clients/merge/from/custom-ids/customIdExample,customIdExample2,customIdExample3,customIdExample4,customIdExample5/to/custom-id/customIdExample\");\nxhr.setRequestHeader(\"Accept\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Content-Type\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/clients/merge/from/custom-ids/customIdExample,customIdExample2,customIdExample3,customIdExample4,customIdExample5/to/custom-id/customIdExample\",\n \"headers\": {\n \"Accept\": \"SOME_STRING_VALUE\",\n \"Content-Type\": \"SOME_STRING_VALUE\",\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/clients/merge/from/custom-ids/customIdExample,customIdExample2,customIdExample3,customIdExample4,customIdExample5/to/custom-id/customIdExample');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Accept' => 'SOME_STRING_VALUE',\n 'Content-Type' => 'SOME_STRING_VALUE',\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/clients/merge/from/custom-ids/customIdExample,customIdExample2,customIdExample3,customIdExample4,customIdExample5/to/custom-id/customIdExample\")\n .header(\"Accept\", \"SOME_STRING_VALUE\")\n .header(\"Content-Type\", \"SOME_STRING_VALUE\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/v4/clients/merge/from/ids/{fromClientIds}/to/id/{toClientId}":{"post":{"summary":"Merge profiles by clientId","description":"Moves profile UUIDs to a single profile (which must already exist) and removes the profiles that were merged. \n\nThe event history of the source profiles is moved to the target profile.\n\nThe attributes (data from the `attributes` object) that don't exist in the target profile are copied to the target profile. If an attribute already exists in the target profile, the value from the source profile is lost.\n\nThe properties and tags of the source profiles are lost, even if they don't have a value in the target profile.\n\n WARNING: This operation is irreversible. Use it carefully.
\n WARNING: You should not try to merge more than 10-20 profiles at once.
\n\n For more details, see the [Developer Guide](https://hub.synerise.com/developers/api/clients/profiles/merging-profiles/).\n\n\n---\n\n**API consumer:** Workspace (Business Profile)\n\n**API key permission required:** `API_MERGE_BY_ID_CLIENT_UPDATE`\n","operationId":"MergeClientsByClientId","parameters":[{"$ref":"#/components/parameters/api-service-pathFromClientIds-apiv4"},{"$ref":"#/components/parameters/api-service-pathToClientId-apiv4"},{"$ref":"#/components/parameters/api-service-acceptHeader-apiv4"},{"$ref":"#/components/parameters/api-service-contentTypeHeader-apiv4"},{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"responses":{"200":{"description":"Request completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-inResponseClientDetails-apiv4"}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"404":{"description":"Source and/or target profile(s) not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"}}}}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Profile management"],"x-snr-doc-urls":["/api-reference/data-management#tag/Profile-management/operation/MergeClientsByClientId"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url 'https://api.synerise.com/v4/clients/merge/from/ids/434428563,33322211,232212342/to/id/434428563' \\\n --header 'Accept: SOME_STRING_VALUE' \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'Content-Type: SOME_STRING_VALUE'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = {\n 'Accept': \"SOME_STRING_VALUE\",\n 'Content-Type': \"SOME_STRING_VALUE\",\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\"\n }\n\nconn.request(\"POST\", \"/v4/clients/merge/from/ids/434428563,33322211,232212342/to/id/434428563\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/clients/merge/from/ids/434428563,33322211,232212342/to/id/434428563\");\nxhr.setRequestHeader(\"Accept\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Content-Type\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/clients/merge/from/ids/434428563,33322211,232212342/to/id/434428563\",\n \"headers\": {\n \"Accept\": \"SOME_STRING_VALUE\",\n \"Content-Type\": \"SOME_STRING_VALUE\",\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/clients/merge/from/ids/434428563,33322211,232212342/to/id/434428563');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Accept' => 'SOME_STRING_VALUE',\n 'Content-Type' => 'SOME_STRING_VALUE',\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/clients/merge/from/ids/434428563,33322211,232212342/to/id/434428563\")\n .header(\"Accept\", \"SOME_STRING_VALUE\")\n .header(\"Content-Type\", \"SOME_STRING_VALUE\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/v4/clients/batch":{"post":{"summary":"Batch add or update profiles","description":" Enqueue a number of add/update operations in the Synerise application database.
If you don't have some information about a profile, don't insert a null-value parameter - omit the parameter entirely. Sending a null value deletes an attribute (if it's a custom attribute) or sets it to null/default value (if the attribute is Synerise-native).\n\n\nThe body contains an array of objects to update. The objects are the same as in the *Create a Profile* and *Update a Profile* endpoints.\n\nIMPORTANT: The request body cannot contain more than 1000 items or exceed 1 MB in size.\n\nThis is an asynchronous operation. After the request body is validated, the request is added to the queue (HTTP 202).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_BATCH_CLIENT_CREATE`\n\n**User role permission required:** `client_management: create`\n","operationId":"BatchAddOrUpdateClients","parameters":[{"$ref":"#/components/parameters/api-service-acceptHeader-apiv4"},{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"\nEach profile must have at least one of the following identifiers:\n- `email` \n If [non-unique emails](https://hub.synerise.com/docs/settings/configuration/non-unique-emails/) are enabled, email is NOT an identifier.\n- `phone` \n Phone number is treated as an identifier only if no other identifier is provided. Then, if a profile with this phone number does not exist and non-unique emails are disabled, an anonymous profile is created.\n- `customId`\n- `uuid`\n- `clientId` (can be used only when updating an existing profile)\n","content":{"application/json":{"schema":{"type":"array","minItems":1,"maxItems":1000,"items":{"type":"object","properties":{"clientId":{"type":"integer","format":"int64","description":"This ID can be used only for updating an existing profile.\n\n\nIf a profile does not exist and `clientId` is the only provided identifier, the operation returns HTTP 202 and **a profile is not created**. If another identifier is provided, a profile is created with that identifier and a `clientId` generated by the system.\n"}},"allOf":[{"$ref":"#/components/schemas/api-service-CreateClientRequestBody-apiv4"}]}}}},"required":true},"responses":{"202":{"description":"Request accepted. IMPORTANT: this does not mean that all profiles were created/updated successfully. The data is sent for further processing in other elements of the infrastructure."},"207":{"description":"Invalid data in some entries. Correct entries are sent for further processing, the invalid ones are rejected.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/api-service-Error-apiv4"}},"example":[{"rejectedValue":"de73b3490c4-bb8c0d8","field":"list[0].uuid","status":400,"message":"UUID must be well-formed value as per RFC 4122"}]}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Profile management"],"x-snr-doc-urls":["/api-reference/data-management#tag/Profile-management/operation/BatchAddOrUpdateClients"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/clients/batch \\\n --header 'Accept: SOME_STRING_VALUE' \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '[{\"clientId\":0,\"email\":\"string\",\"phone\":\"+48111222333\",\"customId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"displayName\":\"string\",\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"avatarUrl\":\"string\",\"birthDate\":\"1987-10-24\",\"company\":\"string\",\"city\":\"string\",\"address\":\"string\",\"zipCode\":\"string\",\"province\":\"string\",\"countryCode\":\"PL\",\"sex\":\"FEMALE\",\"whatsAppId\":\"TestWhatsappId\",\"agreements\":{\"email\":false,\"sms\":false,\"push\":false,\"webPush\":false,\"whatsApp\":false,\"bluetooth\":false,\"rfid\":false,\"wifi\":false},\"attributes\":{\"property1\":null,\"property2\":null},\"tags\":[\"string\"]}]'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"[{\\\"clientId\\\":0,\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"+48111222333\\\",\\\"customId\\\":\\\"string\\\",\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"displayName\\\":\\\"string\\\",\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"avatarUrl\\\":\\\"string\\\",\\\"birthDate\\\":\\\"1987-10-24\\\",\\\"company\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"address\\\":\\\"string\\\",\\\"zipCode\\\":\\\"string\\\",\\\"province\\\":\\\"string\\\",\\\"countryCode\\\":\\\"PL\\\",\\\"sex\\\":\\\"FEMALE\\\",\\\"whatsAppId\\\":\\\"TestWhatsappId\\\",\\\"agreements\\\":{\\\"email\\\":false,\\\"sms\\\":false,\\\"push\\\":false,\\\"webPush\\\":false,\\\"whatsApp\\\":false,\\\"bluetooth\\\":false,\\\"rfid\\\":false,\\\"wifi\\\":false},\\\"attributes\\\":{\\\"property1\\\":null,\\\"property2\\\":null},\\\"tags\\\":[\\\"string\\\"]}]\"\n\nheaders = {\n 'Accept': \"SOME_STRING_VALUE\",\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/clients/batch\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify([\n {\n \"clientId\": 0,\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"FEMALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": false,\n \"sms\": false,\n \"push\": false,\n \"webPush\": false,\n \"whatsApp\": false,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"property1\": null,\n \"property2\": null\n },\n \"tags\": [\n \"string\"\n ]\n }\n]);\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/clients/batch\");\nxhr.setRequestHeader(\"Accept\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/clients/batch\",\n \"headers\": {\n \"Accept\": \"SOME_STRING_VALUE\",\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify([\n {\n clientId: 0,\n email: 'string',\n phone: '+48111222333',\n customId: 'string',\n firstName: 'string',\n lastName: 'string',\n displayName: 'string',\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n avatarUrl: 'string',\n birthDate: '1987-10-24',\n company: 'string',\n city: 'string',\n address: 'string',\n zipCode: 'string',\n province: 'string',\n countryCode: 'PL',\n sex: 'FEMALE',\n whatsAppId: 'TestWhatsappId',\n agreements: {\n email: false,\n sms: false,\n push: false,\n webPush: false,\n whatsApp: false,\n bluetooth: false,\n rfid: false,\n wifi: false\n },\n attributes: {property1: null, property2: null},\n tags: ['string']\n }\n]));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/clients/batch');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Accept' => 'SOME_STRING_VALUE',\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('[{\"clientId\":0,\"email\":\"string\",\"phone\":\"+48111222333\",\"customId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"displayName\":\"string\",\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"avatarUrl\":\"string\",\"birthDate\":\"1987-10-24\",\"company\":\"string\",\"city\":\"string\",\"address\":\"string\",\"zipCode\":\"string\",\"province\":\"string\",\"countryCode\":\"PL\",\"sex\":\"FEMALE\",\"whatsAppId\":\"TestWhatsappId\",\"agreements\":{\"email\":false,\"sms\":false,\"push\":false,\"webPush\":false,\"whatsApp\":false,\"bluetooth\":false,\"rfid\":false,\"wifi\":false},\"attributes\":{\"property1\":null,\"property2\":null},\"tags\":[\"string\"]}]');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/clients/batch\")\n .header(\"Accept\", \"SOME_STRING_VALUE\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"[{\\\"clientId\\\":0,\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"+48111222333\\\",\\\"customId\\\":\\\"string\\\",\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"displayName\\\":\\\"string\\\",\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"avatarUrl\\\":\\\"string\\\",\\\"birthDate\\\":\\\"1987-10-24\\\",\\\"company\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"address\\\":\\\"string\\\",\\\"zipCode\\\":\\\"string\\\",\\\"province\\\":\\\"string\\\",\\\"countryCode\\\":\\\"PL\\\",\\\"sex\\\":\\\"FEMALE\\\",\\\"whatsAppId\\\":\\\"TestWhatsappId\\\",\\\"agreements\\\":{\\\"email\\\":false,\\\"sms\\\":false,\\\"push\\\":false,\\\"webPush\\\":false,\\\"whatsApp\\\":false,\\\"bluetooth\\\":false,\\\"rfid\\\":false,\\\"wifi\\\":false},\\\"attributes\\\":{\\\"property1\\\":null,\\\"property2\\\":null},\\\"tags\\\":[\\\"string\\\"]}]\")\n .asString();"}]}},"/v4/clients/tags":{"get":{"summary":"Get all tags","description":"\nRetrieve all tags that can be assigned to profiles.\n\nThis endpoint is available from version 4.1.0\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_TAGS_CLIENT_READ`\n\n**User role permission required:** `client_tags: read`\n","operationId":"GetAllTags","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"responses":{"200":{"description":"A list of tags","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/api-service-Tag-apiv4"}}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Tags"],"x-snr-doc-urls":["/api-reference/data-management#tag/Tags/operation/GetAllTags"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url https://api.synerise.com/v4/clients/tags \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\"\n }\n\nconn.request(\"GET\", \"/v4/clients/tags\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/v4/clients/tags\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/clients/tags\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/clients/tags');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/v4/clients/tags\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/v4/clients/{clientId}":{"get":{"summary":"Get profile data","description":"Retrieve profile data by profile ID. If PII protection is enabled and your API key/user doesn't have the required permissions, this endpoint can only return test profiles; other profiles return error 404.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_BY_ID_CLIENT_READ`\n\n**User role permission required:** `client_info: read`\n","operationId":"GetClientData","parameters":[{"$ref":"#/components/parameters/api-service-pathClientId-apiv4"},{"$ref":"#/components/parameters/api-service-contentTypeHeader-apiv4"},{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"responses":{"200":{"description":"Details of a single profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-inResponseClientDetails-apiv4"}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"404":{"$ref":"#/components/responses/api-service-404-pii"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Profile management"],"x-snr-doc-urls":["/api-reference/data-management#tag/Profile-management/operation/GetClientData"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url https://api.synerise.com/v4/clients/434428563 \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'Content-Type: SOME_STRING_VALUE'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = {\n 'Content-Type': \"SOME_STRING_VALUE\",\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\"\n }\n\nconn.request(\"GET\", \"/v4/clients/434428563\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/v4/clients/434428563\");\nxhr.setRequestHeader(\"Content-Type\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/clients/434428563\",\n \"headers\": {\n \"Content-Type\": \"SOME_STRING_VALUE\",\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/clients/434428563');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n 'Content-Type' => 'SOME_STRING_VALUE',\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/v4/clients/434428563\")\n .header(\"Content-Type\", \"SOME_STRING_VALUE\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]},"post":{"summary":"Update a profile (identify by ID)","description":"Change the details of a profile in the Synerise application database.
Sending a null value deletes an attribute (if it's a custom attribute) or sets it to null/default value (if the attribute is Synerise-native).\n\nThe `attributes` object can be used to add custom attributes of your choice. For example, `\"hasDog\":true`.\n\nThe `tags` array contains custom tags of your choice.\n\nThis is an asynchronous operation. After the request body is validated, the request is added to the queue (HTTP 202).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_BY_ID_CLIENT_UPDATE`\n\n**User role permission required:** `client_info: update`\n","operationId":"UpdateAClient","parameters":[{"$ref":"#/components/parameters/api-service-pathClientId-apiv4"},{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-CreateClientRequestBody-apiv4"}}},"required":true},"responses":{"202":{"description":"Accepted, queued for processing"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"},"example":{"error":"Bad Request","status":400,"timestamp":"2019-03-21T08:37:34.526Z","path":"/clients/1234","message":"Some fields did not pass validation","errors":[{"code":12053,"field":"uuid","message":"UUID must be well-formed value as per RFC 4122","rejectedValue":"4321"}]}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"404":{"description":"Profile not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"},"example":{"timestamp":"2018-06-07T09:48:56.522+00:00","status":404,"error":"Not Found","message":"Client 525446575 not found","path":"/clients/525446575"}}}},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Profile management"],"x-snr-doc-urls":["/api-reference/data-management#tag/Profile-management/operation/UpdateAClient"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/clients/434428563 \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"email\":\"string\",\"phone\":\"+48111222333\",\"customId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"displayName\":\"string\",\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"avatarUrl\":\"string\",\"birthDate\":\"1987-10-24\",\"company\":\"string\",\"city\":\"string\",\"address\":\"string\",\"zipCode\":\"string\",\"province\":\"string\",\"countryCode\":\"PL\",\"sex\":\"FEMALE\",\"whatsAppId\":\"TestWhatsappId\",\"agreements\":{\"email\":false,\"sms\":false,\"push\":false,\"webPush\":false,\"whatsApp\":false,\"bluetooth\":false,\"rfid\":false,\"wifi\":false},\"attributes\":{\"property1\":null,\"property2\":null},\"tags\":[\"string\"]}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"+48111222333\\\",\\\"customId\\\":\\\"string\\\",\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"displayName\\\":\\\"string\\\",\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"avatarUrl\\\":\\\"string\\\",\\\"birthDate\\\":\\\"1987-10-24\\\",\\\"company\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"address\\\":\\\"string\\\",\\\"zipCode\\\":\\\"string\\\",\\\"province\\\":\\\"string\\\",\\\"countryCode\\\":\\\"PL\\\",\\\"sex\\\":\\\"FEMALE\\\",\\\"whatsAppId\\\":\\\"TestWhatsappId\\\",\\\"agreements\\\":{\\\"email\\\":false,\\\"sms\\\":false,\\\"push\\\":false,\\\"webPush\\\":false,\\\"whatsApp\\\":false,\\\"bluetooth\\\":false,\\\"rfid\\\":false,\\\"wifi\\\":false},\\\"attributes\\\":{\\\"property1\\\":null,\\\"property2\\\":null},\\\"tags\\\":[\\\"string\\\"]}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/clients/434428563\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"FEMALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": false,\n \"sms\": false,\n \"push\": false,\n \"webPush\": false,\n \"whatsApp\": false,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"property1\": null,\n \"property2\": null\n },\n \"tags\": [\n \"string\"\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/clients/434428563\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/clients/434428563\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n email: 'string',\n phone: '+48111222333',\n customId: 'string',\n firstName: 'string',\n lastName: 'string',\n displayName: 'string',\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n avatarUrl: 'string',\n birthDate: '1987-10-24',\n company: 'string',\n city: 'string',\n address: 'string',\n zipCode: 'string',\n province: 'string',\n countryCode: 'PL',\n sex: 'FEMALE',\n whatsAppId: 'TestWhatsappId',\n agreements: {\n email: false,\n sms: false,\n push: false,\n webPush: false,\n whatsApp: false,\n bluetooth: false,\n rfid: false,\n wifi: false\n },\n attributes: {property1: null, property2: null},\n tags: ['string']\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/clients/434428563');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"email\":\"string\",\"phone\":\"+48111222333\",\"customId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"displayName\":\"string\",\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"avatarUrl\":\"string\",\"birthDate\":\"1987-10-24\",\"company\":\"string\",\"city\":\"string\",\"address\":\"string\",\"zipCode\":\"string\",\"province\":\"string\",\"countryCode\":\"PL\",\"sex\":\"FEMALE\",\"whatsAppId\":\"TestWhatsappId\",\"agreements\":{\"email\":false,\"sms\":false,\"push\":false,\"webPush\":false,\"whatsApp\":false,\"bluetooth\":false,\"rfid\":false,\"wifi\":false},\"attributes\":{\"property1\":null,\"property2\":null},\"tags\":[\"string\"]}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/clients/434428563\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"+48111222333\\\",\\\"customId\\\":\\\"string\\\",\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"displayName\\\":\\\"string\\\",\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"avatarUrl\\\":\\\"string\\\",\\\"birthDate\\\":\\\"1987-10-24\\\",\\\"company\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"address\\\":\\\"string\\\",\\\"zipCode\\\":\\\"string\\\",\\\"province\\\":\\\"string\\\",\\\"countryCode\\\":\\\"PL\\\",\\\"sex\\\":\\\"FEMALE\\\",\\\"whatsAppId\\\":\\\"TestWhatsappId\\\",\\\"agreements\\\":{\\\"email\\\":false,\\\"sms\\\":false,\\\"push\\\":false,\\\"webPush\\\":false,\\\"whatsApp\\\":false,\\\"bluetooth\\\":false,\\\"rfid\\\":false,\\\"wifi\\\":false},\\\"attributes\\\":{\\\"property1\\\":null,\\\"property2\\\":null},\\\"tags\\\":[\\\"string\\\"]}\")\n .asString();"}]},"delete":{"summary":"Delete a profile","description":"Delete a profile from the database.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_BY_ID_CLIENT_DELETE`\n\n**User role permission required:** `client_info: delete`\n","operationId":"DeleteAClient","parameters":[{"$ref":"#/components/parameters/api-service-pathClientId-apiv4"},{"$ref":"#/components/parameters/api-service-acceptHeader-apiv4"},{"$ref":"#/components/parameters/api-service-contentTypeHeader-apiv4"},{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"responses":{"202":{"description":"Accepted"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"404":{"description":"Profile not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"},"example":{"timestamp":"2018-06-07T09:48:56.522+00:00","status":404,"error":"Not Found","message":"Client 525446575 not found","path":"/clients/525446575"}}}}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Profile management"],"x-snr-doc-urls":["/api-reference/data-management#tag/Profile-management/operation/DeleteAClient"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request DELETE \\\n --url https://api.synerise.com/v4/clients/434428563 \\\n --header 'Accept: SOME_STRING_VALUE' \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'Content-Type: SOME_STRING_VALUE'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = {\n 'Accept': \"SOME_STRING_VALUE\",\n 'Content-Type': \"SOME_STRING_VALUE\",\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\"\n }\n\nconn.request(\"DELETE\", \"/v4/clients/434428563\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.synerise.com/v4/clients/434428563\");\nxhr.setRequestHeader(\"Accept\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Content-Type\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/clients/434428563\",\n \"headers\": {\n \"Accept\": \"SOME_STRING_VALUE\",\n \"Content-Type\": \"SOME_STRING_VALUE\",\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/clients/434428563');\n$request->setMethod(HTTP_METH_DELETE);\n\n$request->setHeaders([\n 'Accept' => 'SOME_STRING_VALUE',\n 'Content-Type' => 'SOME_STRING_VALUE',\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.delete(\"https://api.synerise.com/v4/clients/434428563\")\n .header(\"Accept\", \"SOME_STRING_VALUE\")\n .header(\"Content-Type\", \"SOME_STRING_VALUE\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/v4/clients/by-email/{clientEmail}":{"post":{"summary":"Update a profile (identify by email)","description":"Change the details of a profile in the Synerise application database.
Sending a null value deletes an attribute (if it's a custom attribute) or sets it to null/default value (if the attribute is Synerise-native).\n\nThe `attributes` object can be used to add custom attributes of your choice. For example, `\"hasDog\":true`.\n\nThe `tags` array contains custom tags of your choice.\n\nThis is an asynchronous operation. After the request body is validated, the request is added to the queue (HTTP 202).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_BY_EMAIL_CLIENT_UPDATE`\n\n**User role permission required:** `client_info: update`\n","operationId":"UpdateAClientByEmail","parameters":[{"$ref":"#/components/parameters/api-service-pathClientEmail-apiv4"},{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-CreateClientRequestBody-apiv4"}}},"required":true},"responses":{"202":{"description":"Accepted, queued for processing"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"},"example":{"error":"Bad Request","status":400,"timestamp":"2019-03-21T08:37:34.526Z","path":"/clients/by-email/client@synerise.com","message":"Some fields did not pass validation","errors":[{"code":12053,"field":"uuid","message":"UUID must be well-formed value as per RFC 4122","rejectedValue":"4321"}]}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"404":{"description":"Profile not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"},"example":{"timestamp":"2018-06-07T09:48:56.522+00:00","status":404,"error":"Not Found","message":"No client record found for email: client@synerise.com","path":"/clients/by-email/client@synerise.com"}}}},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Profile management"],"x-snr-doc-urls":["/api-reference/data-management#tag/Profile-management/operation/UpdateAClientByEmail"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/clients/by-email/clientemail@synerise.com \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"email\":\"string\",\"phone\":\"+48111222333\",\"customId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"displayName\":\"string\",\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"avatarUrl\":\"string\",\"birthDate\":\"1987-10-24\",\"company\":\"string\",\"city\":\"string\",\"address\":\"string\",\"zipCode\":\"string\",\"province\":\"string\",\"countryCode\":\"PL\",\"sex\":\"FEMALE\",\"whatsAppId\":\"TestWhatsappId\",\"agreements\":{\"email\":false,\"sms\":false,\"push\":false,\"webPush\":false,\"whatsApp\":false,\"bluetooth\":false,\"rfid\":false,\"wifi\":false},\"attributes\":{\"property1\":null,\"property2\":null},\"tags\":[\"string\"]}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"+48111222333\\\",\\\"customId\\\":\\\"string\\\",\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"displayName\\\":\\\"string\\\",\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"avatarUrl\\\":\\\"string\\\",\\\"birthDate\\\":\\\"1987-10-24\\\",\\\"company\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"address\\\":\\\"string\\\",\\\"zipCode\\\":\\\"string\\\",\\\"province\\\":\\\"string\\\",\\\"countryCode\\\":\\\"PL\\\",\\\"sex\\\":\\\"FEMALE\\\",\\\"whatsAppId\\\":\\\"TestWhatsappId\\\",\\\"agreements\\\":{\\\"email\\\":false,\\\"sms\\\":false,\\\"push\\\":false,\\\"webPush\\\":false,\\\"whatsApp\\\":false,\\\"bluetooth\\\":false,\\\"rfid\\\":false,\\\"wifi\\\":false},\\\"attributes\\\":{\\\"property1\\\":null,\\\"property2\\\":null},\\\"tags\\\":[\\\"string\\\"]}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/clients/by-email/clientemail@synerise.com\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"FEMALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": false,\n \"sms\": false,\n \"push\": false,\n \"webPush\": false,\n \"whatsApp\": false,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"property1\": null,\n \"property2\": null\n },\n \"tags\": [\n \"string\"\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/clients/by-email/clientemail@synerise.com\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/clients/by-email/clientemail@synerise.com\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n email: 'string',\n phone: '+48111222333',\n customId: 'string',\n firstName: 'string',\n lastName: 'string',\n displayName: 'string',\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n avatarUrl: 'string',\n birthDate: '1987-10-24',\n company: 'string',\n city: 'string',\n address: 'string',\n zipCode: 'string',\n province: 'string',\n countryCode: 'PL',\n sex: 'FEMALE',\n whatsAppId: 'TestWhatsappId',\n agreements: {\n email: false,\n sms: false,\n push: false,\n webPush: false,\n whatsApp: false,\n bluetooth: false,\n rfid: false,\n wifi: false\n },\n attributes: {property1: null, property2: null},\n tags: ['string']\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/clients/by-email/clientemail@synerise.com');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"email\":\"string\",\"phone\":\"+48111222333\",\"customId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"displayName\":\"string\",\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"avatarUrl\":\"string\",\"birthDate\":\"1987-10-24\",\"company\":\"string\",\"city\":\"string\",\"address\":\"string\",\"zipCode\":\"string\",\"province\":\"string\",\"countryCode\":\"PL\",\"sex\":\"FEMALE\",\"whatsAppId\":\"TestWhatsappId\",\"agreements\":{\"email\":false,\"sms\":false,\"push\":false,\"webPush\":false,\"whatsApp\":false,\"bluetooth\":false,\"rfid\":false,\"wifi\":false},\"attributes\":{\"property1\":null,\"property2\":null},\"tags\":[\"string\"]}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/clients/by-email/clientemail@synerise.com\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"+48111222333\\\",\\\"customId\\\":\\\"string\\\",\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"displayName\\\":\\\"string\\\",\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"avatarUrl\\\":\\\"string\\\",\\\"birthDate\\\":\\\"1987-10-24\\\",\\\"company\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"address\\\":\\\"string\\\",\\\"zipCode\\\":\\\"string\\\",\\\"province\\\":\\\"string\\\",\\\"countryCode\\\":\\\"PL\\\",\\\"sex\\\":\\\"FEMALE\\\",\\\"whatsAppId\\\":\\\"TestWhatsappId\\\",\\\"agreements\\\":{\\\"email\\\":false,\\\"sms\\\":false,\\\"push\\\":false,\\\"webPush\\\":false,\\\"whatsApp\\\":false,\\\"bluetooth\\\":false,\\\"rfid\\\":false,\\\"wifi\\\":false},\\\"attributes\\\":{\\\"property1\\\":null,\\\"property2\\\":null},\\\"tags\\\":[\\\"string\\\"]}\")\n .asString();"}]}},"/v4/clients/by-customid/{customId}":{"post":{"summary":"Update a profile (identify by customId)","description":"Change the details of a profile in the Synerise application database.
Sending a null value deletes an attribute (if it's a custom attribute) or sets it to null/default value (if the attribute is Synerise-native).\n \nThe `attributes` object can be used to add custom attributes of your choice. For example, `\"hasDog\":true`.\n\nThe `tags` array contains custom tags of your choice.\n\nThis is an asynchronous operation. After the request body is validated, the request is added to the queue (HTTP 202).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_BY_CUSTOM_ID_CLIENT_UPDATE`\n\n**User role permission required:** `client_info: update`\n","operationId":"UpdateAClientByCustomId","parameters":[{"$ref":"#/components/parameters/api-service-pathClientCustomId-apiv4"},{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-CreateClientRequestBody-apiv4"}}},"required":true},"responses":{"202":{"description":"Accepted, queued for processing"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"},"example":{"error":"Bad Request","status":400,"timestamp":"2019-03-21T08:37:34.526Z","path":"/clients/by-customid/customId1234","message":"Some fields did not pass validation","errors":[{"code":12053,"field":"uuid","message":"UUID must be well-formed value as per RFC 4122","rejectedValue":"4321"}]}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"404":{"description":"Profile not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"},"example":{"timestamp":"2018-06-07T09:48:56.522+00:00","status":404,"error":"Not Found","message":"No client record found for customId: customId1234","path":"/clients/by-customid/customId1234"}}}},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Profile management"],"x-snr-doc-urls":["/api-reference/data-management#tag/Profile-management/operation/UpdateAClientByCustomId"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/clients/by-customid/customIdExample \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"email\":\"string\",\"phone\":\"+48111222333\",\"customId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"displayName\":\"string\",\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"avatarUrl\":\"string\",\"birthDate\":\"1987-10-24\",\"company\":\"string\",\"city\":\"string\",\"address\":\"string\",\"zipCode\":\"string\",\"province\":\"string\",\"countryCode\":\"PL\",\"sex\":\"FEMALE\",\"whatsAppId\":\"TestWhatsappId\",\"agreements\":{\"email\":false,\"sms\":false,\"push\":false,\"webPush\":false,\"whatsApp\":false,\"bluetooth\":false,\"rfid\":false,\"wifi\":false},\"attributes\":{\"property1\":null,\"property2\":null},\"tags\":[\"string\"]}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"+48111222333\\\",\\\"customId\\\":\\\"string\\\",\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"displayName\\\":\\\"string\\\",\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"avatarUrl\\\":\\\"string\\\",\\\"birthDate\\\":\\\"1987-10-24\\\",\\\"company\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"address\\\":\\\"string\\\",\\\"zipCode\\\":\\\"string\\\",\\\"province\\\":\\\"string\\\",\\\"countryCode\\\":\\\"PL\\\",\\\"sex\\\":\\\"FEMALE\\\",\\\"whatsAppId\\\":\\\"TestWhatsappId\\\",\\\"agreements\\\":{\\\"email\\\":false,\\\"sms\\\":false,\\\"push\\\":false,\\\"webPush\\\":false,\\\"whatsApp\\\":false,\\\"bluetooth\\\":false,\\\"rfid\\\":false,\\\"wifi\\\":false},\\\"attributes\\\":{\\\"property1\\\":null,\\\"property2\\\":null},\\\"tags\\\":[\\\"string\\\"]}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/clients/by-customid/customIdExample\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"email\": \"string\",\n \"phone\": \"+48111222333\",\n \"customId\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"displayName\": \"string\",\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"company\": \"string\",\n \"city\": \"string\",\n \"address\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"countryCode\": \"PL\",\n \"sex\": \"FEMALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"agreements\": {\n \"email\": false,\n \"sms\": false,\n \"push\": false,\n \"webPush\": false,\n \"whatsApp\": false,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"property1\": null,\n \"property2\": null\n },\n \"tags\": [\n \"string\"\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/clients/by-customid/customIdExample\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/clients/by-customid/customIdExample\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n email: 'string',\n phone: '+48111222333',\n customId: 'string',\n firstName: 'string',\n lastName: 'string',\n displayName: 'string',\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n avatarUrl: 'string',\n birthDate: '1987-10-24',\n company: 'string',\n city: 'string',\n address: 'string',\n zipCode: 'string',\n province: 'string',\n countryCode: 'PL',\n sex: 'FEMALE',\n whatsAppId: 'TestWhatsappId',\n agreements: {\n email: false,\n sms: false,\n push: false,\n webPush: false,\n whatsApp: false,\n bluetooth: false,\n rfid: false,\n wifi: false\n },\n attributes: {property1: null, property2: null},\n tags: ['string']\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/clients/by-customid/customIdExample');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"email\":\"string\",\"phone\":\"+48111222333\",\"customId\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"displayName\":\"string\",\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"avatarUrl\":\"string\",\"birthDate\":\"1987-10-24\",\"company\":\"string\",\"city\":\"string\",\"address\":\"string\",\"zipCode\":\"string\",\"province\":\"string\",\"countryCode\":\"PL\",\"sex\":\"FEMALE\",\"whatsAppId\":\"TestWhatsappId\",\"agreements\":{\"email\":false,\"sms\":false,\"push\":false,\"webPush\":false,\"whatsApp\":false,\"bluetooth\":false,\"rfid\":false,\"wifi\":false},\"attributes\":{\"property1\":null,\"property2\":null},\"tags\":[\"string\"]}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/clients/by-customid/customIdExample\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"email\\\":\\\"string\\\",\\\"phone\\\":\\\"+48111222333\\\",\\\"customId\\\":\\\"string\\\",\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"displayName\\\":\\\"string\\\",\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"avatarUrl\\\":\\\"string\\\",\\\"birthDate\\\":\\\"1987-10-24\\\",\\\"company\\\":\\\"string\\\",\\\"city\\\":\\\"string\\\",\\\"address\\\":\\\"string\\\",\\\"zipCode\\\":\\\"string\\\",\\\"province\\\":\\\"string\\\",\\\"countryCode\\\":\\\"PL\\\",\\\"sex\\\":\\\"FEMALE\\\",\\\"whatsAppId\\\":\\\"TestWhatsappId\\\",\\\"agreements\\\":{\\\"email\\\":false,\\\"sms\\\":false,\\\"push\\\":false,\\\"webPush\\\":false,\\\"whatsApp\\\":false,\\\"bluetooth\\\":false,\\\"rfid\\\":false,\\\"wifi\\\":false},\\\"attributes\\\":{\\\"property1\\\":null,\\\"property2\\\":null},\\\"tags\\\":[\\\"string\\\"]}\")\n .asString();"}]}},"/v4/clients/by-custom-id/{customId}":{"delete":{"summary":"Delete a profile (identify by customId)","description":"Delete a profile from the database.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_BY_ID_CLIENT_DELETE`\n\n**User role permission required:** `client_info: delete`\n","operationId":"DeleteAClientByCustomId","parameters":[{"$ref":"#/components/parameters/api-service-pathClientCustomId-apiv4"},{"$ref":"#/components/parameters/api-service-contentTypeHeader-apiv4"},{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"responses":{"202":{"description":"Accepted"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"404":{"description":"Profile not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"},"example":{"timestamp":"2018-06-07T09:48:56.522+00:00","status":404,"error":"Not Found","message":"No client record found for customId: customId1234","path":"/clients/by-customid/customId1234"}}}}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Profile management"],"x-snr-doc-urls":["/api-reference/data-management#tag/Profile-management/operation/DeleteAClientByCustomId"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request DELETE \\\n --url https://api.synerise.com/v4/clients/by-custom-id/customIdExample \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'Content-Type: SOME_STRING_VALUE'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = {\n 'Content-Type': \"SOME_STRING_VALUE\",\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\"\n }\n\nconn.request(\"DELETE\", \"/v4/clients/by-custom-id/customIdExample\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.synerise.com/v4/clients/by-custom-id/customIdExample\");\nxhr.setRequestHeader(\"Content-Type\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/clients/by-custom-id/customIdExample\",\n \"headers\": {\n \"Content-Type\": \"SOME_STRING_VALUE\",\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/clients/by-custom-id/customIdExample');\n$request->setMethod(HTTP_METH_DELETE);\n\n$request->setHeaders([\n 'Content-Type' => 'SOME_STRING_VALUE',\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.delete(\"https://api.synerise.com/v4/clients/by-custom-id/customIdExample\")\n .header(\"Content-Type\", \"SOME_STRING_VALUE\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/v4/clients/{clientId}/linked-devices":{"post":{"summary":"Link a device by profile ID","description":" Assign a device to a profile ID. A profile may have many devices assigned.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_DEVICE_CLIENT_UPDATE`\n\n**User role permission required:** `client_info: update`\n","operationId":"LinkAClientDeviceByClientId","parameters":[{"$ref":"#/components/parameters/api-service-pathClientId-apiv4"},{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-LinkaClientdeviceRequest-apiv4"}}},"required":true},"responses":{"200":{"description":"Request accepted","headers":{}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"},"example":{"error":"Bad Request","status":400,"timestamp":"2020-10-29T12:34:02.222Z","path":"/clients/1245757/linked-devices","message":"Some fields did not pass validation","errors":[{"code":12301,"field":"deviceId","message":"12301"}]}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"404":{"description":"Profile not found"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Profile devices"],"x-snr-doc-urls":["/api-reference/profile-management#tag/Profile-devices/operation/LinkAClientDeviceByClientId"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/clients/434428563/linked-devices \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"deviceId\":\"string\",\"registrationId\":\"string\",\"type\":\"android\",\"bluetoothAddress\":\"string\",\"macAddress\":\"string\",\"manufacturer\":\"string\",\"model\":\"string\",\"osVersion\":\"string\",\"product\":\"a51ul_htc_europe\",\"screenHeight\":0,\"screenWidth\":0,\"publicKey\":\"string\"}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"deviceId\\\":\\\"string\\\",\\\"registrationId\\\":\\\"string\\\",\\\"type\\\":\\\"android\\\",\\\"bluetoothAddress\\\":\\\"string\\\",\\\"macAddress\\\":\\\"string\\\",\\\"manufacturer\\\":\\\"string\\\",\\\"model\\\":\\\"string\\\",\\\"osVersion\\\":\\\"string\\\",\\\"product\\\":\\\"a51ul_htc_europe\\\",\\\"screenHeight\\\":0,\\\"screenWidth\\\":0,\\\"publicKey\\\":\\\"string\\\"}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/clients/434428563/linked-devices\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"deviceId\": \"string\",\n \"registrationId\": \"string\",\n \"type\": \"android\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 0,\n \"screenWidth\": 0,\n \"publicKey\": \"string\"\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/clients/434428563/linked-devices\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/clients/434428563/linked-devices\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n deviceId: 'string',\n registrationId: 'string',\n type: 'android',\n bluetoothAddress: 'string',\n macAddress: 'string',\n manufacturer: 'string',\n model: 'string',\n osVersion: 'string',\n product: 'a51ul_htc_europe',\n screenHeight: 0,\n screenWidth: 0,\n publicKey: 'string'\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/clients/434428563/linked-devices');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"deviceId\":\"string\",\"registrationId\":\"string\",\"type\":\"android\",\"bluetoothAddress\":\"string\",\"macAddress\":\"string\",\"manufacturer\":\"string\",\"model\":\"string\",\"osVersion\":\"string\",\"product\":\"a51ul_htc_europe\",\"screenHeight\":0,\"screenWidth\":0,\"publicKey\":\"string\"}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/clients/434428563/linked-devices\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"deviceId\\\":\\\"string\\\",\\\"registrationId\\\":\\\"string\\\",\\\"type\\\":\\\"android\\\",\\\"bluetoothAddress\\\":\\\"string\\\",\\\"macAddress\\\":\\\"string\\\",\\\"manufacturer\\\":\\\"string\\\",\\\"model\\\":\\\"string\\\",\\\"osVersion\\\":\\\"string\\\",\\\"product\\\":\\\"a51ul_htc_europe\\\",\\\"screenHeight\\\":0,\\\"screenWidth\\\":0,\\\"publicKey\\\":\\\"string\\\"}\")\n .asString();"}]}},"/v4/clients/{identifierType}/{identifierValue}":{"get":{"summary":"Fetch profile data","description":" Get the details of a single profile. If PII protection is enabled and your API key/user doesn't have the required permissions, this endpoint can only return test profiles; other profiles return error 404.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_BY_IDENTIFIER_CLIENT_READ`\n\n**User role permission required:** `client_info: read`\n","operationId":"FindAClient","parameters":[{"name":"identifierType","in":"path","description":"The type of profile identifier to use for the request","required":true,"schema":{"type":"string","example":"by-email","enum":["by-custom-id","by-phone","by-uuid","by-email"]}},{"name":"identifierValue","in":"path","description":"The value of the selected identifier. The value must be URL-encoded.","required":true,"schema":{"type":"string","example":"address@domain.com"}},{"$ref":"#/components/parameters/api-service-contentTypeHeader-apiv4"},{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"responses":{"200":{"description":"Details of a single profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-inResponseClientDetails-apiv4"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"},"example":{"path":"/clients/by-custom-id/444555","message":"Api-Version header is required","error":"Bad Request","timestamp":"2018-06-07T09:33:59.183Z","status":400}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"404":{"$ref":"#/components/responses/api-service-404-pii"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Profile management"],"x-snr-doc-urls":["/api-reference/data-management#tag/Profile-management/operation/FindAClient"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url https://api.synerise.com/v4/clients/by-email/address@domain.com \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'Content-Type: SOME_STRING_VALUE'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = {\n 'Content-Type': \"SOME_STRING_VALUE\",\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\"\n }\n\nconn.request(\"GET\", \"/v4/clients/by-email/address@domain.com\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/v4/clients/by-email/address@domain.com\");\nxhr.setRequestHeader(\"Content-Type\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/clients/by-email/address@domain.com\",\n \"headers\": {\n \"Content-Type\": \"SOME_STRING_VALUE\",\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/clients/by-email/address@domain.com');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n 'Content-Type' => 'SOME_STRING_VALUE',\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/v4/clients/by-email/address@domain.com\")\n .header(\"Content-Type\", \"SOME_STRING_VALUE\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/v4/clients/batch/by-phone/{phoneNumber}":{"get":{"summary":"Batch fetch profiles by phone number","description":" Returns a detailed list of profiles associated with the provided phone number. The number saved in the profile must exactly match the number from the request. If no profiles match the criteria, an empty list is returned.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `API_BY_IDENTIFIER_CLIENT_READ`\n\n**User role permission required:** `client_info: read`\n","operationId":"FindClientsByPhone","parameters":[{"name":"phoneNumber","in":"path","description":"The phone number to search for in profiles. Must be an exact match. The value must be URL-encoded.\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n","required":true,"schema":{"type":"string","example":12065550100}},{"$ref":"#/components/parameters/api-service-contentTypeHeader-apiv4"},{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"responses":{"200":{"description":"Returns an array of profile details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-inResponseClientDetailsArray-apiv4"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"},"example":{"path":"/clients/by-phone/+12065550100/batch","message":"Api-Version header is required","error":"Bad Request","timestamp":"2018-06-07T09:33:59.183Z","status":400}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"404":{"$ref":"#/components/responses/api-service-404-pii"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Profile management"],"x-snr-doc-urls":["/api-reference/data-management#tag/Profile-management/operation/FindClientsByPhone"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url https://api.synerise.com/v4/clients/batch/by-phone/12065550100 \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'Content-Type: SOME_STRING_VALUE'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = {\n 'Content-Type': \"SOME_STRING_VALUE\",\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\"\n }\n\nconn.request(\"GET\", \"/v4/clients/batch/by-phone/12065550100\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/v4/clients/batch/by-phone/12065550100\");\nxhr.setRequestHeader(\"Content-Type\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/clients/batch/by-phone/12065550100\",\n \"headers\": {\n \"Content-Type\": \"SOME_STRING_VALUE\",\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/clients/batch/by-phone/12065550100');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n 'Content-Type' => 'SOME_STRING_VALUE',\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/v4/clients/batch/by-phone/12065550100\")\n .header(\"Content-Type\", \"SOME_STRING_VALUE\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/v4/clients/{identifierType}/{identifierValue}/linked-devices":{"post":{"summary":"Link a device by other parameters","description":" Assign a device to a profile UUID. A profile may have many devices assigned.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_BY_IDENTIFY_DEVICE_CLIENT_UPDATE`\n\n**User role permission required:** `client_info: update`\n","operationId":"LinkAClientDeviceByClientUuid","parameters":[{"name":"identifierType","in":"path","required":true,"description":"The profile identifier to use for the request","schema":{"type":"string","enum":["by-customId","by-uuid"]}},{"$ref":"#/components/parameters/api-service-pathIdentifierValue-apiv4"},{"$ref":"#/components/parameters/api-service-acceptHeader-apiv4"},{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-LinkaClientdeviceRequest-apiv4"}}},"required":true},"responses":{"200":{"description":"Request accepted","headers":{}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"},"example":{"error":"Bad Request","status":400,"timestamp":"2020-10-29T12:34:02.222Z","path":"/clients/by-uuid/779465fc-a0c5-41e5-9be2-51c00b2588b4/linked-devices","message":"Some fields did not pass validation","errors":[{"code":12301,"field":"deviceId","message":"12301"}]}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"404":{"description":"Profile not found"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Profile devices"],"x-snr-doc-urls":["/api-reference/profile-management#tag/Profile-devices/operation/LinkAClientDeviceByClientUuid"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/clients/%7BidentifierType%7D/%7BidentifierValue%7D/linked-devices \\\n --header 'Accept: SOME_STRING_VALUE' \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"deviceId\":\"string\",\"registrationId\":\"string\",\"type\":\"android\",\"bluetoothAddress\":\"string\",\"macAddress\":\"string\",\"manufacturer\":\"string\",\"model\":\"string\",\"osVersion\":\"string\",\"product\":\"a51ul_htc_europe\",\"screenHeight\":0,\"screenWidth\":0,\"publicKey\":\"string\"}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"deviceId\\\":\\\"string\\\",\\\"registrationId\\\":\\\"string\\\",\\\"type\\\":\\\"android\\\",\\\"bluetoothAddress\\\":\\\"string\\\",\\\"macAddress\\\":\\\"string\\\",\\\"manufacturer\\\":\\\"string\\\",\\\"model\\\":\\\"string\\\",\\\"osVersion\\\":\\\"string\\\",\\\"product\\\":\\\"a51ul_htc_europe\\\",\\\"screenHeight\\\":0,\\\"screenWidth\\\":0,\\\"publicKey\\\":\\\"string\\\"}\"\n\nheaders = {\n 'Accept': \"SOME_STRING_VALUE\",\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/clients/%7BidentifierType%7D/%7BidentifierValue%7D/linked-devices\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"deviceId\": \"string\",\n \"registrationId\": \"string\",\n \"type\": \"android\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 0,\n \"screenWidth\": 0,\n \"publicKey\": \"string\"\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/clients/%7BidentifierType%7D/%7BidentifierValue%7D/linked-devices\");\nxhr.setRequestHeader(\"Accept\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/clients/%7BidentifierType%7D/%7BidentifierValue%7D/linked-devices\",\n \"headers\": {\n \"Accept\": \"SOME_STRING_VALUE\",\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n deviceId: 'string',\n registrationId: 'string',\n type: 'android',\n bluetoothAddress: 'string',\n macAddress: 'string',\n manufacturer: 'string',\n model: 'string',\n osVersion: 'string',\n product: 'a51ul_htc_europe',\n screenHeight: 0,\n screenWidth: 0,\n publicKey: 'string'\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/clients/%7BidentifierType%7D/%7BidentifierValue%7D/linked-devices');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Accept' => 'SOME_STRING_VALUE',\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"deviceId\":\"string\",\"registrationId\":\"string\",\"type\":\"android\",\"bluetoothAddress\":\"string\",\"macAddress\":\"string\",\"manufacturer\":\"string\",\"model\":\"string\",\"osVersion\":\"string\",\"product\":\"a51ul_htc_europe\",\"screenHeight\":0,\"screenWidth\":0,\"publicKey\":\"string\"}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/clients/%7BidentifierType%7D/%7BidentifierValue%7D/linked-devices\")\n .header(\"Accept\", \"SOME_STRING_VALUE\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"deviceId\\\":\\\"string\\\",\\\"registrationId\\\":\\\"string\\\",\\\"type\\\":\\\"android\\\",\\\"bluetoothAddress\\\":\\\"string\\\",\\\"macAddress\\\":\\\"string\\\",\\\"manufacturer\\\":\\\"string\\\",\\\"model\\\":\\\"string\\\",\\\"osVersion\\\":\\\"string\\\",\\\"product\\\":\\\"a51ul_htc_europe\\\",\\\"screenHeight\\\":0,\\\"screenWidth\\\":0,\\\"publicKey\\\":\\\"string\\\"}\")\n .asString();"}]}},"/v4/my-account/linked-devices":{"post":{"summary":"Link a device to currently logged in profile","description":" Assign a device to the profile that is currently logged in. A Profile may have many devices assigned.\n\n---\n\n**API consumer:** Profile (Client)\n","operationId":"LinkAClientDeviceToCurrentlyLoggedInClient","parameters":[{"$ref":"#/components/parameters/api-service-acceptHeader-apiv4"},{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-LinkaClientdeviceRequest-apiv4"}}},"required":true},"responses":{"200":{"description":"Request accepted","headers":{}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Profile devices"],"x-snr-doc-urls":["/api-reference/profile-management#tag/Profile-devices/operation/LinkAClientDeviceToCurrentlyLoggedInClient"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/my-account/linked-devices \\\n --header 'Accept: SOME_STRING_VALUE' \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"deviceId\":\"string\",\"registrationId\":\"string\",\"type\":\"android\",\"bluetoothAddress\":\"string\",\"macAddress\":\"string\",\"manufacturer\":\"string\",\"model\":\"string\",\"osVersion\":\"string\",\"product\":\"a51ul_htc_europe\",\"screenHeight\":0,\"screenWidth\":0,\"publicKey\":\"string\"}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"deviceId\\\":\\\"string\\\",\\\"registrationId\\\":\\\"string\\\",\\\"type\\\":\\\"android\\\",\\\"bluetoothAddress\\\":\\\"string\\\",\\\"macAddress\\\":\\\"string\\\",\\\"manufacturer\\\":\\\"string\\\",\\\"model\\\":\\\"string\\\",\\\"osVersion\\\":\\\"string\\\",\\\"product\\\":\\\"a51ul_htc_europe\\\",\\\"screenHeight\\\":0,\\\"screenWidth\\\":0,\\\"publicKey\\\":\\\"string\\\"}\"\n\nheaders = {\n 'Accept': \"SOME_STRING_VALUE\",\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/my-account/linked-devices\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"deviceId\": \"string\",\n \"registrationId\": \"string\",\n \"type\": \"android\",\n \"bluetoothAddress\": \"string\",\n \"macAddress\": \"string\",\n \"manufacturer\": \"string\",\n \"model\": \"string\",\n \"osVersion\": \"string\",\n \"product\": \"a51ul_htc_europe\",\n \"screenHeight\": 0,\n \"screenWidth\": 0,\n \"publicKey\": \"string\"\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/my-account/linked-devices\");\nxhr.setRequestHeader(\"Accept\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/my-account/linked-devices\",\n \"headers\": {\n \"Accept\": \"SOME_STRING_VALUE\",\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n deviceId: 'string',\n registrationId: 'string',\n type: 'android',\n bluetoothAddress: 'string',\n macAddress: 'string',\n manufacturer: 'string',\n model: 'string',\n osVersion: 'string',\n product: 'a51ul_htc_europe',\n screenHeight: 0,\n screenWidth: 0,\n publicKey: 'string'\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/my-account/linked-devices');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Accept' => 'SOME_STRING_VALUE',\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"deviceId\":\"string\",\"registrationId\":\"string\",\"type\":\"android\",\"bluetoothAddress\":\"string\",\"macAddress\":\"string\",\"manufacturer\":\"string\",\"model\":\"string\",\"osVersion\":\"string\",\"product\":\"a51ul_htc_europe\",\"screenHeight\":0,\"screenWidth\":0,\"publicKey\":\"string\"}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/my-account/linked-devices\")\n .header(\"Accept\", \"SOME_STRING_VALUE\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"deviceId\\\":\\\"string\\\",\\\"registrationId\\\":\\\"string\\\",\\\"type\\\":\\\"android\\\",\\\"bluetoothAddress\\\":\\\"string\\\",\\\"macAddress\\\":\\\"string\\\",\\\"manufacturer\\\":\\\"string\\\",\\\"model\\\":\\\"string\\\",\\\"osVersion\\\":\\\"string\\\",\\\"product\\\":\\\"a51ul_htc_europe\\\",\\\"screenHeight\\\":0,\\\"screenWidth\\\":0,\\\"publicKey\\\":\\\"string\\\"}\")\n .asString();"}]}},"/v4/my-account/personal-information":{"get":{"tags":["Profile account management"],"summary":"Get Profile's own data","description":"A Profile can retrieve its details from the database.\n\n---\n\n**API consumers:** Profile (Client), ANONYMOUS_CLIENT_CONDITIONAL\n","operationId":"getAccountDataGET","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"},{"$ref":"#/components/parameters/api-service-contentTypeHeader-apiv4"}],"responses":{"200":{"description":"Profile information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-inResponseClientDetails-apiv4"}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"security":[{"JWT":[]}],"x-snr-doc-urls":["/api-reference/profile-management#tag/Profile-account-management/operation/getAccountDataGET"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url https://api.synerise.com/v4/my-account/personal-information \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'Content-Type: SOME_STRING_VALUE'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Content-Type': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\"\n }\n\nconn.request(\"GET\", \"/v4/my-account/personal-information\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/v4/my-account/personal-information\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Content-Type\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/my-account/personal-information\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Content-Type\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/my-account/personal-information');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Content-Type' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/v4/my-account/personal-information\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Content-Type\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]},"post":{"tags":["Profile account management"],"summary":"Update Profile's own data","description":"A Profile can update its own details.\n\n---\n\n**API consumer:** Profile (Client)\n","operationId":"updateAccountDataUsingPOST","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-ClientChangeset-apiv4"}}}},"responses":{"202":{"description":"Accepted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"},"example":{"error":"Bad Request","status":400,"timestamp":"2020-10-29T13:08:16.235Z","path":"/my-account/personal-information","message":"Some fields did not pass validation","errors":[{"code":120,"field":"avatarUrl","message":"120","rejectedValue":"548869"}]}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"security":[{"JWT":[]}],"x-snr-doc-urls":["/api-reference/profile-management#tag/Profile-account-management/operation/updateAccountDataUsingPOST"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/my-account/personal-information \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"address\":\"string\",\"agreements\":{\"email\":false,\"sms\":false,\"push\":false,\"webPush\":false,\"whatsApp\":false,\"bluetooth\":false,\"rfid\":false,\"wifi\":false},\"attributes\":{\"property1\":null,\"property2\":null},\"avatarUrl\":\"string\",\"birthDate\":\"1987-10-24\",\"city\":\"string\",\"company\":\"string\",\"countryCode\":\"PL\",\"customId\":\"string\",\"displayName\":\"string\",\"email\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"phone\":\"+48111222333\",\"province\":\"string\",\"sex\":\"FEMALE\",\"whatsAppId\":\"TestWhatsappId\",\"zipCode\":\"string\"}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"address\\\":\\\"string\\\",\\\"agreements\\\":{\\\"email\\\":false,\\\"sms\\\":false,\\\"push\\\":false,\\\"webPush\\\":false,\\\"whatsApp\\\":false,\\\"bluetooth\\\":false,\\\"rfid\\\":false,\\\"wifi\\\":false},\\\"attributes\\\":{\\\"property1\\\":null,\\\"property2\\\":null},\\\"avatarUrl\\\":\\\"string\\\",\\\"birthDate\\\":\\\"1987-10-24\\\",\\\"city\\\":\\\"string\\\",\\\"company\\\":\\\"string\\\",\\\"countryCode\\\":\\\"PL\\\",\\\"customId\\\":\\\"string\\\",\\\"displayName\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"phone\\\":\\\"+48111222333\\\",\\\"province\\\":\\\"string\\\",\\\"sex\\\":\\\"FEMALE\\\",\\\"whatsAppId\\\":\\\"TestWhatsappId\\\",\\\"zipCode\\\":\\\"string\\\"}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/my-account/personal-information\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"address\": \"string\",\n \"agreements\": {\n \"email\": false,\n \"sms\": false,\n \"push\": false,\n \"webPush\": false,\n \"whatsApp\": false,\n \"bluetooth\": false,\n \"rfid\": false,\n \"wifi\": false\n },\n \"attributes\": {\n \"property1\": null,\n \"property2\": null\n },\n \"avatarUrl\": \"string\",\n \"birthDate\": \"1987-10-24\",\n \"city\": \"string\",\n \"company\": \"string\",\n \"countryCode\": \"PL\",\n \"customId\": \"string\",\n \"displayName\": \"string\",\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"phone\": \"+48111222333\",\n \"province\": \"string\",\n \"sex\": \"FEMALE\",\n \"whatsAppId\": \"TestWhatsappId\",\n \"zipCode\": \"string\"\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/my-account/personal-information\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/my-account/personal-information\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n address: 'string',\n agreements: {\n email: false,\n sms: false,\n push: false,\n webPush: false,\n whatsApp: false,\n bluetooth: false,\n rfid: false,\n wifi: false\n },\n attributes: {property1: null, property2: null},\n avatarUrl: 'string',\n birthDate: '1987-10-24',\n city: 'string',\n company: 'string',\n countryCode: 'PL',\n customId: 'string',\n displayName: 'string',\n email: 'string',\n firstName: 'string',\n lastName: 'string',\n phone: '+48111222333',\n province: 'string',\n sex: 'FEMALE',\n whatsAppId: 'TestWhatsappId',\n zipCode: 'string'\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/my-account/personal-information');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"address\":\"string\",\"agreements\":{\"email\":false,\"sms\":false,\"push\":false,\"webPush\":false,\"whatsApp\":false,\"bluetooth\":false,\"rfid\":false,\"wifi\":false},\"attributes\":{\"property1\":null,\"property2\":null},\"avatarUrl\":\"string\",\"birthDate\":\"1987-10-24\",\"city\":\"string\",\"company\":\"string\",\"countryCode\":\"PL\",\"customId\":\"string\",\"displayName\":\"string\",\"email\":\"string\",\"firstName\":\"string\",\"lastName\":\"string\",\"phone\":\"+48111222333\",\"province\":\"string\",\"sex\":\"FEMALE\",\"whatsAppId\":\"TestWhatsappId\",\"zipCode\":\"string\"}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/my-account/personal-information\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"address\\\":\\\"string\\\",\\\"agreements\\\":{\\\"email\\\":false,\\\"sms\\\":false,\\\"push\\\":false,\\\"webPush\\\":false,\\\"whatsApp\\\":false,\\\"bluetooth\\\":false,\\\"rfid\\\":false,\\\"wifi\\\":false},\\\"attributes\\\":{\\\"property1\\\":null,\\\"property2\\\":null},\\\"avatarUrl\\\":\\\"string\\\",\\\"birthDate\\\":\\\"1987-10-24\\\",\\\"city\\\":\\\"string\\\",\\\"company\\\":\\\"string\\\",\\\"countryCode\\\":\\\"PL\\\",\\\"customId\\\":\\\"string\\\",\\\"displayName\\\":\\\"string\\\",\\\"email\\\":\\\"string\\\",\\\"firstName\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"phone\\\":\\\"+48111222333\\\",\\\"province\\\":\\\"string\\\",\\\"sex\\\":\\\"FEMALE\\\",\\\"whatsAppId\\\":\\\"TestWhatsappId\\\",\\\"zipCode\\\":\\\"string\\\"}\")\n .asString();"}]}},"/v4/my-account/phone-update/request":{"post":{"summary":"Request profile phone number change","description":"A Profile can request a phone number update. The confirmation code is sent in a text message.\n\n---\n\n**API consumer:** Profile (Client)\n","operationId":"RequestClientPhoneNumberChange","parameters":[{"$ref":"#/components/parameters/api-service-acceptHeader-apiv4"},{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"required":["phone"],"type":"object","properties":{"phone":{"type":"string","description":"Current phone number of the profile. \n\nMust match the pattern (ECMA flavor): `/(^\\+[0-9 \\-()/]{6,19}$)|(^[0-9 \\-()/]{6,20}$)/`\n","example":"+48111222333"}}}}},"required":true},"responses":{"202":{"description":"Request accepted'"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Profile account management"],"x-snr-doc-urls":["/api-reference/profile-management#tag/Profile-account-management/operation/RequestClientPhoneNumberChange"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/my-account/phone-update/request \\\n --header 'Accept: SOME_STRING_VALUE' \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"phone\":\"+48111222333\"}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"phone\\\":\\\"+48111222333\\\"}\"\n\nheaders = {\n 'Accept': \"SOME_STRING_VALUE\",\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/my-account/phone-update/request\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"phone\": \"+48111222333\"\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/my-account/phone-update/request\");\nxhr.setRequestHeader(\"Accept\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/my-account/phone-update/request\",\n \"headers\": {\n \"Accept\": \"SOME_STRING_VALUE\",\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({phone: '+48111222333'}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/my-account/phone-update/request');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Accept' => 'SOME_STRING_VALUE',\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"phone\":\"+48111222333\"}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/my-account/phone-update/request\")\n .header(\"Accept\", \"SOME_STRING_VALUE\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"phone\\\":\\\"+48111222333\\\"}\")\n .asString();"}]}},"/v4/my-account/phone-update/confirmation":{"post":{"summary":"Confirm profile phone number change","description":"Use a code to confirm the phone number change and provide the new number.\n\n---\n\n**API consumer:** Profile (Client)\n","operationId":"ConfirmClientPhoneNumberChange","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"required":["phone","confirmationCode"],"type":"object","properties":{"phone":{"type":"string","description":"New phone number\n\nMust match the pattern (ECMA flavor): `/(^\\+[0-9 \\-()/]{6,19}$)|(^[0-9 \\-()/]{6,20}$)/`\n\n**Upcoming breaking change (effective July 6, 2026):** Synerise is introducing changes to how user identifiers and UUIDs are handled. These changes may affect profiles with accented or diacritical characters in identifiers, profiles with leading or trailing whitespace in identifiers, and profiles with duplicate UUIDs. For details and recommended actions, see [Upcoming changes to identifier and UUID handling](https://hub.synerise.com/docs/settings/configuration/identifier-standardization/).\n","example":"+48111222333"},"confirmationCode":{"description":"Confirmation code received by text message","type":"string","example":"73AC1"},"deviceId":{"$ref":"#/components/schemas/api-service-inBodyClientDeviceId-apiv4"},"smsAgreement":{"type":"boolean","description":"Permission to receive marketing information by SMS"}}}}},"required":true},"responses":{"202":{"description":"Request accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Profile account management"],"x-snr-doc-urls":["/api-reference/profile-management#tag/Profile-account-management/operation/ConfirmClientPhoneNumberChange"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/my-account/phone-update/confirmation \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"phone\":\"+48111222333\",\"confirmationCode\":\"73AC1\",\"deviceId\":\"string\",\"smsAgreement\":true}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"phone\\\":\\\"+48111222333\\\",\\\"confirmationCode\\\":\\\"73AC1\\\",\\\"deviceId\\\":\\\"string\\\",\\\"smsAgreement\\\":true}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/my-account/phone-update/confirmation\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"phone\": \"+48111222333\",\n \"confirmationCode\": \"73AC1\",\n \"deviceId\": \"string\",\n \"smsAgreement\": true\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/my-account/phone-update/confirmation\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/my-account/phone-update/confirmation\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n phone: '+48111222333',\n confirmationCode: '73AC1',\n deviceId: 'string',\n smsAgreement: true\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/my-account/phone-update/confirmation');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"phone\":\"+48111222333\",\"confirmationCode\":\"73AC1\",\"deviceId\":\"string\",\"smsAgreement\":true}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/my-account/phone-update/confirmation\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"phone\\\":\\\"+48111222333\\\",\\\"confirmationCode\\\":\\\"73AC1\\\",\\\"deviceId\\\":\\\"string\\\",\\\"smsAgreement\\\":true}\")\n .asString();"}]}},"/v4/tags":{"post":{"tags":["Tags"],"summary":"Create a tag","description":"Create a new tag that can be assigned to profiles. If you try to create a tag that already exists, the response is the existing tag.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `API_TAGS_CREATE`\n\n**User role permission required:** `client_tags: create`\n","operationId":"createTagUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-TagCreate-apiv4"}}}},"responses":{"200":{"description":"Tag created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-TagResponse-apiv4"}}}},"400":{"description":"Invalid or incomplete data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"},"example":{"error":"Bad Request","status":400,"timestamp":"2020-10-29T11:02:25.939Z","path":"/tags","message":"Some fields did not pass validation","errors":[{"code":16213,"field":"name","message":"Scripts are not allowed"}]}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"security":[{"JWT":[]}],"x-snr-doc-urls":["/api-reference/data-management#tag/Tags/operation/createTagUsingPOST"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/tags \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"name\":\"nice tag\",\"color\":\"#0768ff\"}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"name\\\":\\\"nice tag\\\",\\\"color\\\":\\\"#0768ff\\\"}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/tags\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"name\": \"nice tag\",\n \"color\": \"#0768ff\"\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/tags\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/tags\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({name: 'nice tag', color: '#0768ff'}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/tags');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"name\":\"nice tag\",\"color\":\"#0768ff\"}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/tags\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"name\\\":\\\"nice tag\\\",\\\"color\\\":\\\"#0768ff\\\"}\")\n .asString();"}]}},"/v4/tags/{tagID}":{"put":{"tags":["Tags"],"summary":"Update a tag","description":"Update a tag. This method currently only allows modifying the `color` field.\n\nIf the tag has been already deleted, the response is a 404 error.\n\n**Important**: This method doesn't update global tags (not related to any workspace). If you try to update a global tag, the response is a 404 error.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `API_TAGS_CREATE`\n\n**User role permission required:** `client_tags: create`\n","operationId":"updateTagPUT","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-TagUpdate-apiv4"}}}},"parameters":[{"$ref":"#/components/parameters/api-service-pathTagId-apiv4"}],"responses":{"200":{"description":"Tag updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-TagResponse-apiv4"}}}},"400":{"description":"Invalid or incomplete data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"404":{"description":"Tag doesn't exist or it is a global tag (not related to any workspace).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"}}}},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"security":[{"JWT":[]}],"x-snr-doc-urls":["/api-reference/data-management#tag/Tags/operation/updateTagPUT"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request PUT \\\n --url https://api.synerise.com/v4/tags/645 \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"color\":\"#0768ff\"}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"color\\\":\\\"#0768ff\\\"}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"PUT\", \"/v4/tags/645\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"color\": \"#0768ff\"\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.synerise.com/v4/tags/645\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/tags/645\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({color: '#0768ff'}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/tags/645');\n$request->setMethod(HTTP_METH_PUT);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"color\":\"#0768ff\"}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.put(\"https://api.synerise.com/v4/tags/645\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"color\\\":\\\"#0768ff\\\"}\")\n .asString();"}]},"delete":{"tags":["Tags"],"summary":"Remove a tag","description":"Remove a tag definition from the workspace.\n\nIf the tag has been already deleted, the response is a 404 error.\n\n**Important**: This method does not remove global tag (not related to any workspace). In this case, the response is a 404 error.\n\n**Note**: After removing a tag definition, the tag is still cached for a while. In that time, it is still possible for a while to remove or add this tag in profiles.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `API_TAGS_CREATE`\n\n**User role permission required:** `client_tags: create`\n","operationId":"deleteTagDELETE","parameters":[{"$ref":"#/components/parameters/api-service-pathTagId-apiv4"}],"responses":{"202":{"description":"Tag removed"},"400":{"description":"Invalid or incomplete data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"404":{"description":"Tag doesn't exist, was already deleted, or is a global tag (not related to any workspace).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"}}}},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"security":[{"JWT":[]}],"x-snr-doc-urls":["/api-reference/data-management#tag/Tags/operation/deleteTagDELETE"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request DELETE \\\n --url https://api.synerise.com/v4/tags/645 \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"DELETE\", \"/v4/tags/645\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.synerise.com/v4/tags/645\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/tags/645\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/tags/645');\n$request->setMethod(HTTP_METH_DELETE);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.delete(\"https://api.synerise.com/v4/tags/645\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/v4/clients/{clientId}/tags":{"get":{"tags":["Tags"],"summary":"Get profile tags","description":"Retrieve a list of tags assigned to a profile.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `API_TAGS_READ`\n\n**User role permission required:** `client_tags: read`\n","operationId":"getClientTagsUsingGET","parameters":[{"$ref":"#/components/parameters/api-service-pathClientId-apiv4"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/api-service-Tag-apiv4"}}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"}},"security":[{"JWT":[]}],"x-snr-doc-urls":["/api-reference/data-management#tag/Tags/operation/getClientTagsUsingGET"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url https://api.synerise.com/v4/clients/434428563/tags \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/v4/clients/434428563/tags\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/v4/clients/434428563/tags\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/clients/434428563/tags\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/clients/434428563/tags');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/v4/clients/434428563/tags\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/v4/clients/{clientId}/tags/{tagID}":{"post":{"tags":["Tags"],"summary":"Assign tag to profile","description":"Assign a tag to a profile.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `API_ASSIGN_TAGS_EXECUTE`\n\n**User role permission required:** `client_tags: execute`\n","operationId":"assignTagPOST","parameters":[{"$ref":"#/components/parameters/api-service-pathClientId-apiv4"},{"$ref":"#/components/parameters/api-service-pathTagId-apiv4"}],"responses":{"200":{"description":"Tag assigned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-TagAssociation-apiv4"}}}},"400":{"description":"Profile not found or data malformed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"404":{"description":"Tag not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"}}}},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Tags/operation/assignTagPOST"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/clients/434428563/tags/645"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nconn.request(\"POST\", \"/v4/clients/434428563/tags/645\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/clients/434428563/tags/645\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/clients/434428563/tags/645\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/clients/434428563/tags/645');\n$request->setMethod(HTTP_METH_POST);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/clients/434428563/tags/645\")\n .asString();"}]},"delete":{"tags":["Tags"],"summary":"Remove tag from profile","operationId":"removeClientTagDELETE","parameters":[{"$ref":"#/components/parameters/api-service-pathClientId-apiv4"},{"$ref":"#/components/parameters/api-service-pathTagId-apiv4"}],"responses":{"202":{"description":"Tag removed"},"400":{"description":"Profile not found or data malformed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"404":{"description":"Tag not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"}}}}},"x-snr-doc-urls":["/api-reference/data-management#tag/Tags/operation/removeClientTagDELETE"],"description":"\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `API_ASSIGN_TAGS_EXECUTE`\n\n**User role permission required:** `client_tags: execute`\n","x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request DELETE \\\n --url https://api.synerise.com/v4/clients/434428563/tags/645"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nconn.request(\"DELETE\", \"/v4/clients/434428563/tags/645\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.synerise.com/v4/clients/434428563/tags/645\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/clients/434428563/tags/645\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/clients/434428563/tags/645');\n$request->setMethod(HTTP_METH_DELETE);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.delete(\"https://api.synerise.com/v4/clients/434428563/tags/645\")\n .asString();"}]}},"/v4/events/by-client/{clientId}":{"get":{"deprecated":true,"summary":"Get Profile events as Workspace","description":"**This endpoint is deprecated. Use [/activities-api/events/by/{identifierType}](https://developers.synerise.com/DataManagement/DataManagement.html#operation/getEventsByIdentifier) instead.** \n\nRetrieve a list of events saved in a Profile.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `API_LISTING_BY_CLIENT_EVENTS_READ`\n\n**User role permission required:** `client_activities: read`\n","operationId":"GetClientEvents","parameters":[{"$ref":"#/components/parameters/api-service-pathClientId-apiv4"},{"$ref":"#/components/parameters/api-service-contentTypeHeader-apiv4"},{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"},{"$ref":"#/components/parameters/api-service-queryDateFrom-apiv4"},{"$ref":"#/components/parameters/api-service-queryDateTo-apiv4"},{"$ref":"#/components/parameters/api-service-queryAction-apiv4"},{"$ref":"#/components/parameters/api-service-queryEventsLimit-apiv4"}],"responses":{"200":{"description":"A list of events","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/api-service-GetClientevents-HTTP200-apiv4"}}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"}},"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/GetClientEvents"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/v4/events/by-client/434428563?time%5Bfrom%5D=SOME_STRING_VALUE&time%5Bto%5D=SOME_STRING_VALUE&action=transaction.charge&limit=SOME_INTEGER_VALUE' \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'Content-Type: SOME_STRING_VALUE'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = {\n 'Content-Type': \"SOME_STRING_VALUE\",\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\"\n }\n\nconn.request(\"GET\", \"/v4/events/by-client/434428563?time%5Bfrom%5D=SOME_STRING_VALUE&time%5Bto%5D=SOME_STRING_VALUE&action=transaction.charge&limit=SOME_INTEGER_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/v4/events/by-client/434428563?time%5Bfrom%5D=SOME_STRING_VALUE&time%5Bto%5D=SOME_STRING_VALUE&action=transaction.charge&limit=SOME_INTEGER_VALUE\");\nxhr.setRequestHeader(\"Content-Type\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/by-client/434428563?time%5Bfrom%5D=SOME_STRING_VALUE&time%5Bto%5D=SOME_STRING_VALUE&action=transaction.charge&limit=SOME_INTEGER_VALUE\",\n \"headers\": {\n \"Content-Type\": \"SOME_STRING_VALUE\",\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/by-client/434428563');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'time[from]' => 'SOME_STRING_VALUE',\n 'time[to]' => 'SOME_STRING_VALUE',\n 'action' => 'transaction.charge',\n 'limit' => 'SOME_INTEGER_VALUE'\n]);\n\n$request->setHeaders([\n 'Content-Type' => 'SOME_STRING_VALUE',\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/v4/events/by-client/434428563?time%5Bfrom%5D=SOME_STRING_VALUE&time%5Bto%5D=SOME_STRING_VALUE&action=transaction.charge&limit=SOME_INTEGER_VALUE\")\n .header(\"Content-Type\", \"SOME_STRING_VALUE\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/v4/events":{"get":{"deprecated":true,"summary":"Get Profile's own events","description":"**This endpoint is deprecated. Use [/activities-api/events](https://developers.synerise.com/DataManagement/DataManagement.html#operation/getEvents) instead.** \n\nA Profile can retrieve a list of its own events saved in the database.\n\n\n---\n\n**API consumer:** Profile (Client)\n","operationId":"GetClientOwnEvents","parameters":[{"$ref":"#/components/parameters/api-service-contentTypeHeader-apiv4"},{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"},{"$ref":"#/components/parameters/api-service-queryDateFrom-apiv4"},{"$ref":"#/components/parameters/api-service-queryDateTo-apiv4"},{"$ref":"#/components/parameters/api-service-queryAction-apiv4"},{"$ref":"#/components/parameters/api-service-queryEventsLimit-apiv4"}],"responses":{"200":{"description":"A list of events","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/api-service-GetClientevents-HTTP200-apiv4"}}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"},"example":{"timestamp":"2018-06-07T09:50:43.947+00:00","status":500,"error":"Internal Server Error","message":"Duration between time[from] and time[to] cannot be greater than 7 days","path":"/events/by-client/525446574"}}}}},"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/GetClientOwnEvents"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/v4/events?time%5Bfrom%5D=SOME_STRING_VALUE&time%5Bto%5D=SOME_STRING_VALUE&action=transaction.charge&limit=SOME_INTEGER_VALUE' \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'Content-Type: SOME_STRING_VALUE'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = {\n 'Content-Type': \"SOME_STRING_VALUE\",\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\"\n }\n\nconn.request(\"GET\", \"/v4/events?time%5Bfrom%5D=SOME_STRING_VALUE&time%5Bto%5D=SOME_STRING_VALUE&action=transaction.charge&limit=SOME_INTEGER_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/v4/events?time%5Bfrom%5D=SOME_STRING_VALUE&time%5Bto%5D=SOME_STRING_VALUE&action=transaction.charge&limit=SOME_INTEGER_VALUE\");\nxhr.setRequestHeader(\"Content-Type\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events?time%5Bfrom%5D=SOME_STRING_VALUE&time%5Bto%5D=SOME_STRING_VALUE&action=transaction.charge&limit=SOME_INTEGER_VALUE\",\n \"headers\": {\n \"Content-Type\": \"SOME_STRING_VALUE\",\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'time[from]' => 'SOME_STRING_VALUE',\n 'time[to]' => 'SOME_STRING_VALUE',\n 'action' => 'transaction.charge',\n 'limit' => 'SOME_INTEGER_VALUE'\n]);\n\n$request->setHeaders([\n 'Content-Type' => 'SOME_STRING_VALUE',\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/v4/events?time%5Bfrom%5D=SOME_STRING_VALUE&time%5Bto%5D=SOME_STRING_VALUE&action=transaction.charge&limit=SOME_INTEGER_VALUE\")\n .header(\"Content-Type\", \"SOME_STRING_VALUE\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/v4/events/application-started":{"post":{"summary":"Application started","description":"Send a 'client application started' event.\n\nThis endpoint is available from API version 4.1.2.\n\nWhen you send an event to this endpoint, the `action` field is set to `client.applicationStarted` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_APPLICATION_STARTED_EVENTS_CREATE`\n","operationId":"ApplicationStarted","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-ApplicationstartedRequest-apiv4"}}},"required":true},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"},"example":{"timestamp":"2018-06-07T09:53:56.999+00:00","status":500,"error":"Internal Server Error","message":"Error occurred during event publication","path":"/events/application-started"}}}}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/ApplicationStarted"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/application-started \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{\"applicationName\":\"string\",\"version\":\"string\"}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{\\\"applicationName\\\":\\\"string\\\",\\\"version\\\":\\\"string\\\"}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/application-started\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"params\": {\n \"applicationName\": \"string\",\n \"version\": \"string\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/application-started\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/application-started\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n params: {applicationName: 'string', version: 'string'}\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/application-started');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{\"applicationName\":\"string\",\"version\":\"string\"}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/application-started\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{\\\"applicationName\\\":\\\"string\\\",\\\"version\\\":\\\"string\\\"}}\")\n .asString();"}]}},"/v4/events/registered":{"post":{"summary":"Profile account registered","description":"Send a 'profile account registered' event.
If you don't have a value for a field, omit that field. Do not send null values.\n\nWhen you send an event to this endpoint, the `action` field is set to `client.register` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_REGISTERED_EVENTS_CREATE`\n","operationId":"ClientRegistered","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-service-EventBase-apiv4"},{"type":"object","properties":{"params":{"$ref":"#/components/schemas/api-service-DefaultParamSource-apiv4"}}}]}}}},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/ClientRegistered"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/registered \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/registered\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"params\": {}\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/registered\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/registered\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n params: {}\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/registered');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/registered\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\")\n .asString();"}]}},"/v4/events/logged-in":{"post":{"summary":"Profile logged in","description":"Send a 'profile logged in' event.
If you don't have a value for a field, omit that field. Do not send null values.\n\nWhen you send an event to this endpoint, the `action` field is set to `client.login` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_LOGGED_IN_EVENTS_CREATE`\n","operationId":"ClientLoggedIn","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-service-EventBase-apiv4"},{"type":"object","properties":{"params":{"$ref":"#/components/schemas/api-service-DefaultParamSource-apiv4"}}}]}}}},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/ClientLoggedIn"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/logged-in \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/logged-in\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"params\": {}\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/logged-in\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/logged-in\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n params: {}\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/logged-in');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/logged-in\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\")\n .asString();"}]}},"/v4/events/logged-out":{"post":{"summary":"Profile logged out","description":"Send a 'profile logged out' event.
If you don't have a value for a field, omit that field. Do not send null values.\n\nWhen you send an event to this endpoint, the `action` field is set to `client.logout` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_LOGGED_OUT_EVENTS_CREATE`\n","operationId":"ClientLoggedOut","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-service-EventBase-apiv4"},{"type":"object","properties":{"params":{"$ref":"#/components/schemas/api-service-DefaultParamSource-apiv4"}}}]}}}},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/ClientLoggedOut"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/logged-out \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/logged-out\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"params\": {}\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/logged-out\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/logged-out\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n params: {}\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/logged-out');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/logged-out\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\")\n .asString();"}]}},"/v4/events/added-to-cart":{"post":{"summary":"Item added to cart","description":"Send an 'item added to cart' event.
If you don't have a value for a field, omit that field. Do not send null values.\n\n\nWhen you send an event to this endpoint, the `action` field is set to `product.addToCart` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_ADDED_TO_CART_EVENTS_CREATE`\n","operationId":"ClientAddedProductToCart","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-ClientCartEventRequest-apiv4"}}},"required":true},"responses":{"202":{"description":"Accepted"},"400":{"description":"Bad request: input data missing or malformed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"},"example":{"error":"Bad Request","status":400,"timestamp":"2018-06-07T09:55:20.563Z","message":"Some fields did not pass validation","path":"/events/added-to-cart","errors":[{"path":"label","message":"cannot be empty","rejectedValue":""},{"path":"label","message":"length must be between 1 and 64","rejectedValue":""}]}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/ClientAddedProductToCart"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/added-to-cart \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{\"sku\":\"189784563455\",\"name\":\"Soft drink\",\"category\":\"Beverages\",\"categories\":[\"string\"],\"offline\":true,\"source\":\"MOBILE\",\"regularUnitPrice\":{\"amount\":0,\"currency\":\"USD\"},\"discountedUnitPrice\":{\"amount\":0,\"currency\":\"USD\"},\"finalUnitPrice\":{\"amount\":3.25,\"currency\":\"USD\"},\"ItemUrlAddress\":\"string\",\"producer\":\"string\",\"quantity\":0}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{\\\"sku\\\":\\\"189784563455\\\",\\\"name\\\":\\\"Soft drink\\\",\\\"category\\\":\\\"Beverages\\\",\\\"categories\\\":[\\\"string\\\"],\\\"offline\\\":true,\\\"source\\\":\\\"MOBILE\\\",\\\"regularUnitPrice\\\":{\\\"amount\\\":0,\\\"currency\\\":\\\"USD\\\"},\\\"discountedUnitPrice\\\":{\\\"amount\\\":0,\\\"currency\\\":\\\"USD\\\"},\\\"finalUnitPrice\\\":{\\\"amount\\\":3.25,\\\"currency\\\":\\\"USD\\\"},\\\"ItemUrlAddress\\\":\\\"string\\\",\\\"producer\\\":\\\"string\\\",\\\"quantity\\\":0}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/added-to-cart\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"params\": {\n \"sku\": \"189784563455\",\n \"name\": \"Soft drink\",\n \"category\": \"Beverages\",\n \"categories\": [\n \"string\"\n ],\n \"offline\": true,\n \"source\": \"MOBILE\",\n \"regularUnitPrice\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"discountedUnitPrice\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"finalUnitPrice\": {\n \"amount\": 3.25,\n \"currency\": \"USD\"\n },\n \"ItemUrlAddress\": \"string\",\n \"producer\": \"string\",\n \"quantity\": 0\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/added-to-cart\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/added-to-cart\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n params: {\n sku: '189784563455',\n name: 'Soft drink',\n category: 'Beverages',\n categories: ['string'],\n offline: true,\n source: 'MOBILE',\n regularUnitPrice: {amount: 0, currency: 'USD'},\n discountedUnitPrice: {amount: 0, currency: 'USD'},\n finalUnitPrice: {amount: 3.25, currency: 'USD'},\n ItemUrlAddress: 'string',\n producer: 'string',\n quantity: 0\n }\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/added-to-cart');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{\"sku\":\"189784563455\",\"name\":\"Soft drink\",\"category\":\"Beverages\",\"categories\":[\"string\"],\"offline\":true,\"source\":\"MOBILE\",\"regularUnitPrice\":{\"amount\":0,\"currency\":\"USD\"},\"discountedUnitPrice\":{\"amount\":0,\"currency\":\"USD\"},\"finalUnitPrice\":{\"amount\":3.25,\"currency\":\"USD\"},\"ItemUrlAddress\":\"string\",\"producer\":\"string\",\"quantity\":0}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/added-to-cart\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{\\\"sku\\\":\\\"189784563455\\\",\\\"name\\\":\\\"Soft drink\\\",\\\"category\\\":\\\"Beverages\\\",\\\"categories\\\":[\\\"string\\\"],\\\"offline\\\":true,\\\"source\\\":\\\"MOBILE\\\",\\\"regularUnitPrice\\\":{\\\"amount\\\":0,\\\"currency\\\":\\\"USD\\\"},\\\"discountedUnitPrice\\\":{\\\"amount\\\":0,\\\"currency\\\":\\\"USD\\\"},\\\"finalUnitPrice\\\":{\\\"amount\\\":3.25,\\\"currency\\\":\\\"USD\\\"},\\\"ItemUrlAddress\\\":\\\"string\\\",\\\"producer\\\":\\\"string\\\",\\\"quantity\\\":0}}\")\n .asString();"}]}},"/v4/events/removed-from-cart":{"post":{"summary":"Item removed from cart","description":"Send an 'item removed from cart' event.
If you don't have a value for a field, omit that field. Do not send null values.\n\n\nWhen you send an event to this endpoint, the `action` field is set to `product.removeFromCart` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_REMOVED_FROM_CART_EVENTS_CREATE`\n","operationId":"ClientRemovedProductFromCart","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-ClientCartEventRequest-apiv4"}}},"required":true},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/ClientRemovedProductFromCart"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/removed-from-cart \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{\"sku\":\"189784563455\",\"name\":\"Soft drink\",\"category\":\"Beverages\",\"categories\":[\"string\"],\"offline\":true,\"source\":\"MOBILE\",\"regularUnitPrice\":{\"amount\":0,\"currency\":\"USD\"},\"discountedUnitPrice\":{\"amount\":0,\"currency\":\"USD\"},\"finalUnitPrice\":{\"amount\":3.25,\"currency\":\"USD\"},\"ItemUrlAddress\":\"string\",\"producer\":\"string\",\"quantity\":0}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{\\\"sku\\\":\\\"189784563455\\\",\\\"name\\\":\\\"Soft drink\\\",\\\"category\\\":\\\"Beverages\\\",\\\"categories\\\":[\\\"string\\\"],\\\"offline\\\":true,\\\"source\\\":\\\"MOBILE\\\",\\\"regularUnitPrice\\\":{\\\"amount\\\":0,\\\"currency\\\":\\\"USD\\\"},\\\"discountedUnitPrice\\\":{\\\"amount\\\":0,\\\"currency\\\":\\\"USD\\\"},\\\"finalUnitPrice\\\":{\\\"amount\\\":3.25,\\\"currency\\\":\\\"USD\\\"},\\\"ItemUrlAddress\\\":\\\"string\\\",\\\"producer\\\":\\\"string\\\",\\\"quantity\\\":0}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/removed-from-cart\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"params\": {\n \"sku\": \"189784563455\",\n \"name\": \"Soft drink\",\n \"category\": \"Beverages\",\n \"categories\": [\n \"string\"\n ],\n \"offline\": true,\n \"source\": \"MOBILE\",\n \"regularUnitPrice\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"discountedUnitPrice\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"finalUnitPrice\": {\n \"amount\": 3.25,\n \"currency\": \"USD\"\n },\n \"ItemUrlAddress\": \"string\",\n \"producer\": \"string\",\n \"quantity\": 0\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/removed-from-cart\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/removed-from-cart\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n params: {\n sku: '189784563455',\n name: 'Soft drink',\n category: 'Beverages',\n categories: ['string'],\n offline: true,\n source: 'MOBILE',\n regularUnitPrice: {amount: 0, currency: 'USD'},\n discountedUnitPrice: {amount: 0, currency: 'USD'},\n finalUnitPrice: {amount: 3.25, currency: 'USD'},\n ItemUrlAddress: 'string',\n producer: 'string',\n quantity: 0\n }\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/removed-from-cart');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{\"sku\":\"189784563455\",\"name\":\"Soft drink\",\"category\":\"Beverages\",\"categories\":[\"string\"],\"offline\":true,\"source\":\"MOBILE\",\"regularUnitPrice\":{\"amount\":0,\"currency\":\"USD\"},\"discountedUnitPrice\":{\"amount\":0,\"currency\":\"USD\"},\"finalUnitPrice\":{\"amount\":3.25,\"currency\":\"USD\"},\"ItemUrlAddress\":\"string\",\"producer\":\"string\",\"quantity\":0}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/removed-from-cart\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{\\\"sku\\\":\\\"189784563455\\\",\\\"name\\\":\\\"Soft drink\\\",\\\"category\\\":\\\"Beverages\\\",\\\"categories\\\":[\\\"string\\\"],\\\"offline\\\":true,\\\"source\\\":\\\"MOBILE\\\",\\\"regularUnitPrice\\\":{\\\"amount\\\":0,\\\"currency\\\":\\\"USD\\\"},\\\"discountedUnitPrice\\\":{\\\"amount\\\":0,\\\"currency\\\":\\\"USD\\\"},\\\"finalUnitPrice\\\":{\\\"amount\\\":3.25,\\\"currency\\\":\\\"USD\\\"},\\\"ItemUrlAddress\\\":\\\"string\\\",\\\"producer\\\":\\\"string\\\",\\\"quantity\\\":0}}\")\n .asString();"}]}},"/v4/events/added-to-favorites":{"post":{"summary":"Product added to favorites","description":"Send an 'item added to favorites' event.
If you don't have a value for a field, omit that field. Do not send null values.\n\n\nWhen you send an event to this endpoint, the `action` field is set to `product.addToFavorite` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_ADDED_TO_FAVORITES_EVENTS_CREATE`\n","operationId":"ClientAddedProductToFavorites","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-service-EventBase-apiv4"},{"type":"object","properties":{"params":{"$ref":"#/components/schemas/api-service-DefaultParamSource-apiv4"}}}]}}},"required":true},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/ClientAddedProductToFavorites"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/added-to-favorites \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/added-to-favorites\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"params\": {}\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/added-to-favorites\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/added-to-favorites\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n params: {}\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/added-to-favorites');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/added-to-favorites\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\")\n .asString();"}]}},"/v4/events/product-view":{"post":{"summary":"Item viewed","description":"Send an 'item viewed' event.\n\nWhen you send an event to this endpoint, the `action` field is set to `product.view` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_PRODUCT_VIEW_EVENTS_CREATE`\n","operationId":"ClientViewedProduct","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-service-EventBase-apiv4"},{"type":"object","properties":{"params":{"type":"object","additionalProperties":true,"description":"Additional parameters. Remember that you can use [event enrichment](https://hub.synerise.com/docs/assets/events/adding-event-parameters/) to add the data automatically from a catalog.\n\nAside from the required parameters (if any exist), all events accept custom, free-form parameters, with the following restrictions:\n\n WARNING:\n - If you want to send the `email` param, it must be exactly the same as the email of the profile which generated the event.\n - Some params are reserved for system use. If you send them in the `params` object, they are ignored or overwritten with system-assigned values:
\n modifiedBy
\n apiKey
\n eventUUID
\n ip
\n time
\n businessProfileId\n","properties":{"productId":{"$ref":"#/components/schemas/api-service-ItemSku-apiv4"},"name":{"$ref":"#/components/schemas/api-service-ItemName-apiv4"},"fromRecommendation":{"$ref":"#/components/schemas/api-service-FromRecommendation-apiv4"},"source":{"$ref":"#/components/schemas/api-service-eventSource-apiv4"},"category":{"$ref":"#/components/schemas/api-service-ItemCategory-apiv4"},"url":{"$ref":"#/components/schemas/api-service-ItemUrlAddress-apiv4"},"campaignHash":{"$ref":"#/components/schemas/api-service-CampaignHash-apiv4"}}}}}]}}},"required":true},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/ClientViewedProduct"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/product-view \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{\"productId\":\"189784563455\",\"name\":\"Soft drink\",\"fromRecommendation\":true,\"source\":\"MOBILE\",\"category\":\"Beverages\",\"url\":\"string\",\"campaignHash\":\"21e0d4b0-bd4e-497b-817b-4fr660284918\"}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{\\\"productId\\\":\\\"189784563455\\\",\\\"name\\\":\\\"Soft drink\\\",\\\"fromRecommendation\\\":true,\\\"source\\\":\\\"MOBILE\\\",\\\"category\\\":\\\"Beverages\\\",\\\"url\\\":\\\"string\\\",\\\"campaignHash\\\":\\\"21e0d4b0-bd4e-497b-817b-4fr660284918\\\"}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/product-view\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"params\": {\n \"productId\": \"189784563455\",\n \"name\": \"Soft drink\",\n \"fromRecommendation\": true,\n \"source\": \"MOBILE\",\n \"category\": \"Beverages\",\n \"url\": \"string\",\n \"campaignHash\": \"21e0d4b0-bd4e-497b-817b-4fr660284918\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/product-view\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/product-view\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n params: {\n productId: '189784563455',\n name: 'Soft drink',\n fromRecommendation: true,\n source: 'MOBILE',\n category: 'Beverages',\n url: 'string',\n campaignHash: '21e0d4b0-bd4e-497b-817b-4fr660284918'\n }\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/product-view');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{\"productId\":\"189784563455\",\"name\":\"Soft drink\",\"fromRecommendation\":true,\"source\":\"MOBILE\",\"category\":\"Beverages\",\"url\":\"string\",\"campaignHash\":\"21e0d4b0-bd4e-497b-817b-4fr660284918\"}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/product-view\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{\\\"productId\\\":\\\"189784563455\\\",\\\"name\\\":\\\"Soft drink\\\",\\\"fromRecommendation\\\":true,\\\"source\\\":\\\"MOBILE\\\",\\\"category\\\":\\\"Beverages\\\",\\\"url\\\":\\\"string\\\",\\\"campaignHash\\\":\\\"21e0d4b0-bd4e-497b-817b-4fr660284918\\\"}}\")\n .asString();"}]}},"/v4/events/assigned-to-company":{"post":{"summary":"Profile assigned to company","description":"Send a 'profile assigned to company' event.\n\nWhen you send an event to this endpoint, the `action` field is set to `client.assignToCompany` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User, Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_ASSIGNED_TO_COMPANY_EVENTS_CREATE`\n\n**User role permission required:** `client_activities: create`\n","operationId":"ClientAssignedToCompany","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-service-EventBase-apiv4"},{"type":"object","required":["params"],"properties":{"params":{"type":"object","additionalProperties":true,"description":"Additional parameters. Remember that you can use [event enrichment](https://hub.synerise.com/docs/assets/events/adding-event-parameters/) to add the data automatically from a catalog.\n\nAside from the required parameters (if any exist), all events accept custom, free-form parameters, with the following restrictions:\n\n WARNING:\n - If you want to send the `email` param, it must be exactly the same as the email of the profile which generated the event.\n - Some params are reserved for system use. If you send them in the `params` object, they are ignored or overwritten with system-assigned values:
\n modifiedBy
\n apiKey
\n eventUUID
\n ip
\n time
\n businessProfileId\n","properties":{"companyId":{"type":"number","description":"Company ID"}}}}}]}}}},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/ClientAssignedToCompany"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/assigned-to-company \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{\"companyId\":0}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{\\\"companyId\\\":0}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/assigned-to-company\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"params\": {\n \"companyId\": 0\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/assigned-to-company\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/assigned-to-company\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n params: {companyId: 0}\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/assigned-to-company');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{\"companyId\":0}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/assigned-to-company\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{\\\"companyId\\\":0}}\")\n .asString();"}]}},"/v4/events/appeared-in-location":{"post":{"summary":"Profile logged location","description":"Send an event when a profile submits its location.
If you don't have a value for a field, omit that field. Do not send null values.\n\nWhen you send an event to this endpoint, the `action` field is set to `client.location` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_APPEARED_IN_LOCATION_EVENTS_CREATE`\n","operationId":"ClientAppearedInLocation","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-service-EventBase-apiv4"},{"type":"object","properties":{"params":{"type":"object","additionalProperties":true,"description":"Additional parameters. Remember that you can use [event enrichment](https://hub.synerise.com/docs/assets/events/adding-event-parameters/) to add the data automatically from a catalog.\n\nAside from the required parameters (if any exist), all events accept custom, free-form parameters, with the following restrictions:\n\n WARNING:\n - If you want to send the `email` param, it must be exactly the same as the email of the profile which generated the event.\n - Some params are reserved for system use. If you send them in the `params` object, they are ignored or overwritten with system-assigned values:
\n modifiedBy
\n apiKey
\n eventUUID
\n ip
\n time
\n businessProfileId\n","required":["lat","lon"],"properties":{"lat":{"type":"number","description":"Latitude","example":50.021102},"lon":{"type":"number","description":"Longitude","example":19.886218}}}}}]}}}},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/ClientAppearedInLocation"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/appeared-in-location \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{\"lat\":50.021102,\"lon\":19.886218}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{\\\"lat\\\":50.021102,\\\"lon\\\":19.886218}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/appeared-in-location\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"params\": {\n \"lat\": 50.021102,\n \"lon\": 19.886218\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/appeared-in-location\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/appeared-in-location\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n params: {lat: 50.021102, lon: 19.886218}\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/appeared-in-location');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{\"lat\":50.021102,\"lon\":19.886218}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/appeared-in-location\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{\\\"lat\\\":50.021102,\\\"lon\\\":19.886218}}\")\n .asString();"}]}},"/v4/events/push/received":{"post":{"summary":"Push notification received","description":"Record a 'push notification was received' event. It is used for push message interaction tracking.\n\nThis endpoint is available from API version 4.1.2.\n\nWhen you send an event to this endpoint, the `action` field is set to `push.receiveInBackground` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_PUSH_RECIVED_EVENTS_CREATE`\n","operationId":"ClientReceivedPushNotification","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-service-EventBase-apiv4"},{"type":"object","properties":{"params":{"$ref":"#/components/schemas/api-service-DefaultParamSource-apiv4"}}}]}}}},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/ClientReceivedPushNotification"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/push/received \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/push/received\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"params\": {}\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/push/received\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/push/received\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n params: {}\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/push/received');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/push/received\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\")\n .asString();"}]}},"/v4/events/push/viewed":{"post":{"summary":"Push notification viewed","description":"Record a 'push notification was viewed' event. It is used for push message interaction tracking.\n\nWhen you send an event to this endpoint, the `action` field is set to `push.view` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_PUSH_VIEWED_EVENTS_CREATE`\n","operationId":"ClientViewedPushNotification","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-service-EventBase-apiv4"},{"type":"object","properties":{"params":{"$ref":"#/components/schemas/api-service-DefaultParamSource-apiv4"}}}]}}}},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/ClientViewedPushNotification"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/push/viewed \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/push/viewed\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"params\": {}\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/push/viewed\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/push/viewed\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n params: {}\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/push/viewed');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/push/viewed\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\")\n .asString();"}]}},"/v4/events/push/clicked":{"post":{"summary":"Push notification clicked","description":"Send a 'Push notification was clicked' event. It's used for push message interaction tracking.\n\nWhen you send an event to this endpoint, the `action` field is set to `push.click` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_PUSH_CLICKED_EVENTS_CREATE`\n","operationId":"ClientClickedPushNotification","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-service-EventBase-apiv4"},{"type":"object","properties":{"params":{"$ref":"#/components/schemas/api-service-DefaultParamSource-apiv4"}}}]}}}},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/ClientClickedPushNotification"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/push/clicked \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/push/clicked\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"params\": {}\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/push/clicked\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/push/clicked\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n params: {}\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/push/clicked');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/push/clicked\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\")\n .asString();"}]}},"/v4/events/push/cancelled":{"post":{"summary":"Push notifications cancelled","description":"Send a 'push notifications cancelled' event. It's used for push message interaction tracking.\n\nWhen you send an event to this endpoint, the `action` field is set to `push.cancel` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_PUSH_CANCELLED_EVENTS_CREATE`\n","operationId":"ClientCancelledPushNotifications","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-service-EventBase-apiv4"},{"type":"object","properties":{"params":{"$ref":"#/components/schemas/api-service-DefaultParamSource-apiv4"}}}]}}}},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/ClientCancelledPushNotifications"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/push/cancelled \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/push/cancelled\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"params\": {}\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/push/cancelled\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/push/cancelled\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n params: {}\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/push/cancelled');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/push/cancelled\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\")\n .asString();"}]}},"/v4/events/cancelled-transaction":{"post":{"summary":"Transaction cancelled","description":"Send a 'transaction cancelled' event.
If you don't have a value for a field, omit that field. Do not send null values.\n\nWhen you send an event to this endpoint, the `action` field is set to `transaction.cancel` by the backend.\n\n---\n\n**API consumer:** Workspace (Business Profile)\n\n**API key permission required:** `API_CANCELLED_TRANSACTION_EVENTS_CREATE`\n","operationId":"ClientCancelledTransaction","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-service-EventBase-apiv4"},{"type":"object","properties":{"params":{"type":"object","description":"Additional parameters. Remember that you can use [event enrichment](https://hub.synerise.com/docs/assets/events/adding-event-parameters/) to add the data automatically from a catalog.\n\nAside from the required parameters (if any exist), all events accept custom, free-form parameters, with the following restrictions:\n\n WARNING:\n - If you want to send the `email` param, it must be exactly the same as the email of the profile which generated the event.\n - Some params are reserved for system use. If you send them in the `params` object, they are ignored or overwritten with system-assigned values:
\n modifiedBy
\n apiKey
\n eventUUID
\n ip
\n time
\n businessProfileId\n","additionalProperties":true,"properties":{"orderId":{"$ref":"#/components/schemas/api-service-OrderId-apiv4"},"orderStatus":{"$ref":"#/components/schemas/api-service-OrderStatus-apiv4"},"discountAmount":{"$ref":"#/components/schemas/api-service-DiscountAmount-apiv4"},"discountPercent":{"$ref":"#/components/schemas/api-service-DiscountPercent-apiv4"},"discountCode":{"$ref":"#/components/schemas/api-service-DiscountCode-apiv4"},"value":{"$ref":"#/components/schemas/api-service-Value-apiv4"},"revenue":{"$ref":"#/components/schemas/api-service-Revenue-apiv4"},"products":{"$ref":"#/components/schemas/api-service-Products-apiv4"},"source":{"$ref":"#/components/schemas/api-service-eventSource-apiv4"},"paymentInfo":{"$ref":"#/components/schemas/api-service-PaymentInfo-apiv4"}}}}}]}}}},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/ClientCancelledTransaction"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/cancelled-transaction \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{\"orderId\":\"be466362-71e9-4bdd-ad11-bfacead5276b\",\"orderStatus\":\"string\",\"discountAmount\":{\"amount\":0,\"currency\":\"USD\"},\"discountPercent\":0.1,\"discountCode\":\"string\",\"value\":{\"amount\":112.25,\"currency\":\"USD\"},\"revenue\":{\"amount\":64.25,\"currency\":\"USD\"},\"products\":[{\"finalUnitPrice\":{\"amount\":3.25,\"currency\":\"USD\"},\"name\":\"Soft drink\",\"sku\":\"189784563455\",\"categories\":[\"string\"],\"image\":\"string\",\"url\":\"string\",\"netUnitPrice\":{\"amount\":3.25,\"currency\":\"USD\"},\"tax\":0.1,\"quantity\":2.5,\"regularPrice\":{\"amount\":3.25,\"currency\":\"USD\"},\"discountPrice\":{\"amount\":15.5,\"currency\":\"USD\"},\"discountPercent\":0.1,\"property1\":null,\"property2\":null}],\"source\":\"MOBILE\",\"paymentInfo\":{\"method\":\"CASH\"}}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{\\\"orderId\\\":\\\"be466362-71e9-4bdd-ad11-bfacead5276b\\\",\\\"orderStatus\\\":\\\"string\\\",\\\"discountAmount\\\":{\\\"amount\\\":0,\\\"currency\\\":\\\"USD\\\"},\\\"discountPercent\\\":0.1,\\\"discountCode\\\":\\\"string\\\",\\\"value\\\":{\\\"amount\\\":112.25,\\\"currency\\\":\\\"USD\\\"},\\\"revenue\\\":{\\\"amount\\\":64.25,\\\"currency\\\":\\\"USD\\\"},\\\"products\\\":[{\\\"finalUnitPrice\\\":{\\\"amount\\\":3.25,\\\"currency\\\":\\\"USD\\\"},\\\"name\\\":\\\"Soft drink\\\",\\\"sku\\\":\\\"189784563455\\\",\\\"categories\\\":[\\\"string\\\"],\\\"image\\\":\\\"string\\\",\\\"url\\\":\\\"string\\\",\\\"netUnitPrice\\\":{\\\"amount\\\":3.25,\\\"currency\\\":\\\"USD\\\"},\\\"tax\\\":0.1,\\\"quantity\\\":2.5,\\\"regularPrice\\\":{\\\"amount\\\":3.25,\\\"currency\\\":\\\"USD\\\"},\\\"discountPrice\\\":{\\\"amount\\\":15.5,\\\"currency\\\":\\\"USD\\\"},\\\"discountPercent\\\":0.1,\\\"property1\\\":null,\\\"property2\\\":null}],\\\"source\\\":\\\"MOBILE\\\",\\\"paymentInfo\\\":{\\\"method\\\":\\\"CASH\\\"}}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/cancelled-transaction\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"params\": {\n \"orderId\": \"be466362-71e9-4bdd-ad11-bfacead5276b\",\n \"orderStatus\": \"string\",\n \"discountAmount\": {\n \"amount\": 0,\n \"currency\": \"USD\"\n },\n \"discountPercent\": 0.1,\n \"discountCode\": \"string\",\n \"value\": {\n \"amount\": 112.25,\n \"currency\": \"USD\"\n },\n \"revenue\": {\n \"amount\": 64.25,\n \"currency\": \"USD\"\n },\n \"products\": [\n {\n \"finalUnitPrice\": {\n \"amount\": 3.25,\n \"currency\": \"USD\"\n },\n \"name\": \"Soft drink\",\n \"sku\": \"189784563455\",\n \"categories\": [\n \"string\"\n ],\n \"image\": \"string\",\n \"url\": \"string\",\n \"netUnitPrice\": {\n \"amount\": 3.25,\n \"currency\": \"USD\"\n },\n \"tax\": 0.1,\n \"quantity\": 2.5,\n \"regularPrice\": {\n \"amount\": 3.25,\n \"currency\": \"USD\"\n },\n \"discountPrice\": {\n \"amount\": 15.5,\n \"currency\": \"USD\"\n },\n \"discountPercent\": 0.1,\n \"property1\": null,\n \"property2\": null\n }\n ],\n \"source\": \"MOBILE\",\n \"paymentInfo\": {\n \"method\": \"CASH\"\n }\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/cancelled-transaction\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/cancelled-transaction\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n params: {\n orderId: 'be466362-71e9-4bdd-ad11-bfacead5276b',\n orderStatus: 'string',\n discountAmount: {amount: 0, currency: 'USD'},\n discountPercent: 0.1,\n discountCode: 'string',\n value: {amount: 112.25, currency: 'USD'},\n revenue: {amount: 64.25, currency: 'USD'},\n products: [\n {\n finalUnitPrice: {amount: 3.25, currency: 'USD'},\n name: 'Soft drink',\n sku: '189784563455',\n categories: ['string'],\n image: 'string',\n url: 'string',\n netUnitPrice: {amount: 3.25, currency: 'USD'},\n tax: 0.1,\n quantity: 2.5,\n regularPrice: {amount: 3.25, currency: 'USD'},\n discountPrice: {amount: 15.5, currency: 'USD'},\n discountPercent: 0.1,\n property1: null,\n property2: null\n }\n ],\n source: 'MOBILE',\n paymentInfo: {method: 'CASH'}\n }\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/cancelled-transaction');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{\"orderId\":\"be466362-71e9-4bdd-ad11-bfacead5276b\",\"orderStatus\":\"string\",\"discountAmount\":{\"amount\":0,\"currency\":\"USD\"},\"discountPercent\":0.1,\"discountCode\":\"string\",\"value\":{\"amount\":112.25,\"currency\":\"USD\"},\"revenue\":{\"amount\":64.25,\"currency\":\"USD\"},\"products\":[{\"finalUnitPrice\":{\"amount\":3.25,\"currency\":\"USD\"},\"name\":\"Soft drink\",\"sku\":\"189784563455\",\"categories\":[\"string\"],\"image\":\"string\",\"url\":\"string\",\"netUnitPrice\":{\"amount\":3.25,\"currency\":\"USD\"},\"tax\":0.1,\"quantity\":2.5,\"regularPrice\":{\"amount\":3.25,\"currency\":\"USD\"},\"discountPrice\":{\"amount\":15.5,\"currency\":\"USD\"},\"discountPercent\":0.1,\"property1\":null,\"property2\":null}],\"source\":\"MOBILE\",\"paymentInfo\":{\"method\":\"CASH\"}}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/cancelled-transaction\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{\\\"orderId\\\":\\\"be466362-71e9-4bdd-ad11-bfacead5276b\\\",\\\"orderStatus\\\":\\\"string\\\",\\\"discountAmount\\\":{\\\"amount\\\":0,\\\"currency\\\":\\\"USD\\\"},\\\"discountPercent\\\":0.1,\\\"discountCode\\\":\\\"string\\\",\\\"value\\\":{\\\"amount\\\":112.25,\\\"currency\\\":\\\"USD\\\"},\\\"revenue\\\":{\\\"amount\\\":64.25,\\\"currency\\\":\\\"USD\\\"},\\\"products\\\":[{\\\"finalUnitPrice\\\":{\\\"amount\\\":3.25,\\\"currency\\\":\\\"USD\\\"},\\\"name\\\":\\\"Soft drink\\\",\\\"sku\\\":\\\"189784563455\\\",\\\"categories\\\":[\\\"string\\\"],\\\"image\\\":\\\"string\\\",\\\"url\\\":\\\"string\\\",\\\"netUnitPrice\\\":{\\\"amount\\\":3.25,\\\"currency\\\":\\\"USD\\\"},\\\"tax\\\":0.1,\\\"quantity\\\":2.5,\\\"regularPrice\\\":{\\\"amount\\\":3.25,\\\"currency\\\":\\\"USD\\\"},\\\"discountPrice\\\":{\\\"amount\\\":15.5,\\\"currency\\\":\\\"USD\\\"},\\\"discountPercent\\\":0.1,\\\"property1\\\":null,\\\"property2\\\":null}],\\\"source\\\":\\\"MOBILE\\\",\\\"paymentInfo\\\":{\\\"method\\\":\\\"CASH\\\"}}}\")\n .asString();"}]}},"/v4/events/hit-timer":{"post":{"summary":"Timer hit","description":"Send a 'timer' event.\n\n\nTimers are used for analytics. For example, if you send a event when a profiles starts doing something and another one when they finish, you can collect data about average activity time.
If you don't have a value for a field, omit that field. Do not send null values.\n\n\nWhen you send an event to this endpoint, the `action` field is set to `client.hitTimer` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_HIT_TIMER_EVENTS_CREATE`\n","operationId":"ClientHitTimer","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-service-EventBase-apiv4"},{"type":"object","properties":{"params":{"$ref":"#/components/schemas/api-service-DefaultParamSource-apiv4"}}}]}}},"required":true},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/ClientHitTimer"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/hit-timer \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/hit-timer\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"params\": {}\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/hit-timer\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/hit-timer\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n params: {}\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/hit-timer');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/hit-timer\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\")\n .asString();"}]}},"/v4/events/searched":{"post":{"summary":"Search requested","description":"Send a 'search requested' event.
If you don't have a value for a field, omit that field. Do not send null values.\n\n\nWhen you send an event to this endpoint, the `action` field is set to `client.search` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_SEARCHED_EVENTS_CREATE`\n","operationId":"ClientSearched","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-service-EventBase-apiv4"},{"type":"object","properties":{"params":{"$ref":"#/components/schemas/api-service-DefaultParamSource-apiv4"}}}]}}},"required":true},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/ClientSearched"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/searched \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/searched\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"params\": {}\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/searched\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/searched\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n params: {}\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/searched');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/searched\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\")\n .asString();"}]}},"/v4/events/shared":{"post":{"summary":"Content shared","description":"Send a 'content shared' event.
If you don't have a value for a field, omit that field. Do not send null values.\n\n\nWhen you send an event to this endpoint, the `action` field is set to `client.shared` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_SHARED_EVENTS_CREATE`\n","operationId":"ClientShared","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-service-EventBase-apiv4"},{"type":"object","properties":{"params":{"$ref":"#/components/schemas/api-service-DefaultParamSource-apiv4"}}}]}}}},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/ClientShared"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/shared \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/shared\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"params\": {}\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/shared\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/shared\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n params: {}\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/shared');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/shared\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\")\n .asString();"}]}},"/v4/events/recommendation-seen":{"post":{"summary":"Recommendation viewed","deprecated":true,"description":"This endpoint is deprecated. Use the [AI Events](https://developers.synerise.com/DataManagement/DataManagement.html#tag/AI-Events) endpoints instead.\n\nSend a 'recommendation was viewed' event.\n\n\nWhen you send an event to this endpoint, the `action` field is set to `recommendation.view` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Web SDK Tracker, AI API key (legacy)\n\n**API key permission required:** `API_RECOMENDATION_SEEN_EVENTS_CREATE`\n","operationId":"RecommendationSeen","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-service-EventBase-apiv4"},{"type":"object","properties":{"params":{"$ref":"#/components/schemas/api-service-recommendationEventParams-apiv4"}}}]}}},"required":true},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/RecommendationSeen"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/recommendation-seen \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{\"productId\":\"189784563455\",\"name\":\"Soft drink\",\"source\":\"MOBILE\",\"campaignHash\":\"21e0d4b0-bd4e-497b-817b-4fr660284918\",\"url\":\"string\",\"category\":\"Beverages\"}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{\\\"productId\\\":\\\"189784563455\\\",\\\"name\\\":\\\"Soft drink\\\",\\\"source\\\":\\\"MOBILE\\\",\\\"campaignHash\\\":\\\"21e0d4b0-bd4e-497b-817b-4fr660284918\\\",\\\"url\\\":\\\"string\\\",\\\"category\\\":\\\"Beverages\\\"}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/recommendation-seen\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"params\": {\n \"productId\": \"189784563455\",\n \"name\": \"Soft drink\",\n \"source\": \"MOBILE\",\n \"campaignHash\": \"21e0d4b0-bd4e-497b-817b-4fr660284918\",\n \"url\": \"string\",\n \"category\": \"Beverages\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/recommendation-seen\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/recommendation-seen\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n params: {\n productId: '189784563455',\n name: 'Soft drink',\n source: 'MOBILE',\n campaignHash: '21e0d4b0-bd4e-497b-817b-4fr660284918',\n url: 'string',\n category: 'Beverages'\n }\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/recommendation-seen');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{\"productId\":\"189784563455\",\"name\":\"Soft drink\",\"source\":\"MOBILE\",\"campaignHash\":\"21e0d4b0-bd4e-497b-817b-4fr660284918\",\"url\":\"string\",\"category\":\"Beverages\"}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/recommendation-seen\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{\\\"productId\\\":\\\"189784563455\\\",\\\"name\\\":\\\"Soft drink\\\",\\\"source\\\":\\\"MOBILE\\\",\\\"campaignHash\\\":\\\"21e0d4b0-bd4e-497b-817b-4fr660284918\\\",\\\"url\\\":\\\"string\\\",\\\"category\\\":\\\"Beverages\\\"}}\")\n .asString();"}]}},"/v4/events/recommendation-click":{"post":{"summary":"Recommendation clicked","deprecated":true,"description":"Send a 'recommendation clicked' event.\nThis endpoint is deprecated. Use the [AI Events](https://developers.synerise.com/DataManagement/DataManagement.html#tag/AI-Events) endpoints instead.\n\n\nWhen you send an event to this endpoint, the `action` field is set to `recommendation.click` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Web SDK Tracker, AI API key (legacy)\n\n**API key permission required:** `API_RECOMMENDATION_CLICK_EVENTS_CREATE`\n","operationId":"RecommendationClicked","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-service-EventBase-apiv4"},{"type":"object","properties":{"params":{"$ref":"#/components/schemas/api-service-recommendationEventParams-apiv4"}}}]}}},"required":true},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/RecommendationClicked"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/recommendation-click \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{\"productId\":\"189784563455\",\"name\":\"Soft drink\",\"source\":\"MOBILE\",\"campaignHash\":\"21e0d4b0-bd4e-497b-817b-4fr660284918\",\"url\":\"string\",\"category\":\"Beverages\"}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{\\\"productId\\\":\\\"189784563455\\\",\\\"name\\\":\\\"Soft drink\\\",\\\"source\\\":\\\"MOBILE\\\",\\\"campaignHash\\\":\\\"21e0d4b0-bd4e-497b-817b-4fr660284918\\\",\\\"url\\\":\\\"string\\\",\\\"category\\\":\\\"Beverages\\\"}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/recommendation-click\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"params\": {\n \"productId\": \"189784563455\",\n \"name\": \"Soft drink\",\n \"source\": \"MOBILE\",\n \"campaignHash\": \"21e0d4b0-bd4e-497b-817b-4fr660284918\",\n \"url\": \"string\",\n \"category\": \"Beverages\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/recommendation-click\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/recommendation-click\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n params: {\n productId: '189784563455',\n name: 'Soft drink',\n source: 'MOBILE',\n campaignHash: '21e0d4b0-bd4e-497b-817b-4fr660284918',\n url: 'string',\n category: 'Beverages'\n }\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/recommendation-click');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{\"productId\":\"189784563455\",\"name\":\"Soft drink\",\"source\":\"MOBILE\",\"campaignHash\":\"21e0d4b0-bd4e-497b-817b-4fr660284918\",\"url\":\"string\",\"category\":\"Beverages\"}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/recommendation-click\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{\\\"productId\\\":\\\"189784563455\\\",\\\"name\\\":\\\"Soft drink\\\",\\\"source\\\":\\\"MOBILE\\\",\\\"campaignHash\\\":\\\"21e0d4b0-bd4e-497b-817b-4fr660284918\\\",\\\"url\\\":\\\"string\\\",\\\"category\\\":\\\"Beverages\\\"}}\")\n .asString();"}]}},"/v4/events/visited-screen":{"post":{"summary":"Mobile app screen visited","description":"Send a 'screen in a mobile app was visited' event. This can be used for mobile screen usage tracking.
If you don't have a value for a field, omit that field. Do not send null values.\n\nWhen you send an event to this endpoint, the `action` field is set to `screen.view` by the backend.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_VISITED_SCREEN_EVENTS_CREATE`\n","operationId":"ClientVisitedScreen","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-service-EventBase-apiv4"},{"type":"object","properties":{"params":{"$ref":"#/components/schemas/api-service-DefaultParamSource-apiv4"}}}]}}}},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/ClientVisitedScreen"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/visited-screen \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/visited-screen\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"params\": {}\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/visited-screen\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/visited-screen\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n params: {}\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/visited-screen');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"params\":{}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/visited-screen\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"params\\\":{}}\")\n .asString();"}]}},"/v4/events/custom":{"post":{"summary":"Custom event","description":"Send a custom event.\n\nWARNING: This endpoint doesn't create `product.buy` events from `transaction.charge` events! Use [Create a transaction](#operation/CreateATransaction) or [Batch add or update transactions](#operation/BatchAddOrUpdateTransactions) instead.\n\nIf you don't have a value for a field, omit that field. Do not send null values.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Synerise User\n\n**API key permission required:** `API_CUSTOM_EVENTS_CREATE`\n\n**User role permission required:** `client_activities: create`\n","operationId":"CustomEvent","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-service-EventBase-apiv4"},{"type":"object","required":["action"],"properties":{"action":{"$ref":"#/components/schemas/api-service-EventAction-apiv4"},"params":{"$ref":"#/components/schemas/api-service-DefaultParamSource-apiv4"}}}]}}}},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/CustomEvent"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/custom \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"action\":\"context.action\",\"params\":{}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"action\\\":\\\"context.action\\\",\\\"params\\\":{}}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/custom\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"action\": \"context.action\",\n \"params\": {}\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/custom\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/custom\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n action: 'context.action',\n params: {}\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/custom');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"action\":\"context.action\",\"params\":{}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/custom\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"action\\\":\\\"context.action\\\",\\\"params\\\":{}}\")\n .asString();"}]}},"/v4/events/batch":{"post":{"summary":"Batch send events","description":"Send a batch of events as an array of objects. You can send up to a 1000 events and the size of the request can't be more than 1 MB.\n\nWARNING: This endpoint doesn't create `product.buy` events from `transaction.charge` events! Use [Create a transaction](#operation/CreateATransaction) or [Batch add or update transactions](#operation/BatchAddOrUpdateTransactions) instead.\n\nIf you don't have a value for a field, omit that field. Do not\nsend null values.\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `API_BATCH_EVENTS_CREATE`\n","operationId":"BatchSendEvents","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"IMPORTANT: In a request, all events must use the same type of profile identifier. For example, if you want to send some events identified by email and others by customId, you must send them in separate batches.","content":{"application/json":{"schema":{"type":"array","maxItems":1000,"items":{"anyOf":[{"title":"Custom event","allOf":[{"$ref":"#/components/schemas/api-service-EventBase-apiv4"},{"type":"object","required":["action","type"],"properties":{"type":{"$ref":"#/components/schemas/api-service-EventType-apiv4"},"action":{"$ref":"#/components/schemas/api-service-EventAction-apiv4"},"params":{"$ref":"#/components/schemas/api-service-DefaultParamSource-apiv4"}}}]},{"title":"Pre-defined event","allOf":[{"$ref":"#/components/schemas/api-service-EventBase-apiv4"},{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/api-service-EventType-apiv4"},"params":{"$ref":"#/components/schemas/api-service-DefaultParamSource-apiv4"}}}]}]}}}},"required":true},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/BatchSendEvents"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/batch \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '[{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"type\":\"string\",\"action\":\"context.action\",\"params\":{}}]'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"[{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"type\\\":\\\"string\\\",\\\"action\\\":\\\"context.action\\\",\\\"params\\\":{}}]\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/batch\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify([\n {\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\",\n \"type\": \"string\",\n \"action\": \"context.action\",\n \"params\": {}\n }\n]);\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/batch\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/batch\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify([\n {\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00',\n type: 'string',\n action: 'context.action',\n params: {}\n }\n]));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/batch');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('[{\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\",\"type\":\"string\",\"action\":\"context.action\",\"params\":{}}]');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/batch\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"[{\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\",\\\"type\\\":\\\"string\\\",\\\"action\\\":\\\"context.action\\\",\\\"params\\\":{}}]\")\n .asString();"}]}},"/v4/server/time":{"get":{"summary":"Get server time","description":"Get current server time, needed to send events with a correct timestamp.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**Authentication:** Not required\n","operationId":"getServerTime","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"serverTime":{"type":"string","format":"date-time","description":"Current server time in ISO 8601"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-HTTP400-apiv4"}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"}},"deprecated":false,"security":[{"JWT":[]}],"tags":["Events"],"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/getServerTime"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url https://api.synerise.com/v4/server/time \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\"\n }\n\nconn.request(\"GET\", \"/v4/server/time\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/v4/server/time\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/server/time\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/server/time');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/v4/server/time\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/v4/auth/refresh/profile":{"get":{"summary":"Refresh a Workspace token","description":"Retrieve a refreshed JWT Token to prolong the Workspace session.\n\n---\n\n**API consumer:** Workspace (Business Profile)\n\n**Authentication:** Not required\n","operationId":"RefreshABusinessProfileToken","parameters":[{"$ref":"#/components/parameters/api-service-contentTypeHeader-apiv4"},{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"responses":{"200":{"description":"New authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-JWTtoken-apiv4"}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"}},"deprecated":true,"security":[{"JWT":[]}],"tags":["Authorization (deprecated)"],"x-snr-doc-urls":["/api-reference/authorization#tag/Authorization-(deprecated)/operation/RefreshABusinessProfileToken"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url https://api.synerise.com/v4/auth/refresh/profile \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'Content-Type: SOME_STRING_VALUE'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = {\n 'Content-Type': \"SOME_STRING_VALUE\",\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\"\n }\n\nconn.request(\"GET\", \"/v4/auth/refresh/profile\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/v4/auth/refresh/profile\");\nxhr.setRequestHeader(\"Content-Type\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/auth/refresh/profile\",\n \"headers\": {\n \"Content-Type\": \"SOME_STRING_VALUE\",\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/auth/refresh/profile');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n 'Content-Type' => 'SOME_STRING_VALUE',\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/v4/auth/refresh/profile\")\n .header(\"Content-Type\", \"SOME_STRING_VALUE\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/v4/auth/login/profile":{"post":{"summary":"Log in as Workspace","description":"This endpoint is deprecated. Use [this endpoint](#operation/profileLogin) instead.\n\n---\n\n**Authentication:** Not required\n","operationId":"LogInAsBusinessProfile","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"description":"","content":{"application/json":{"schema":{"required":["apiKey"],"type":"object","properties":{"apiKey":{"type":"string","description":"Workspace (formerly Business Profile) API key","example":"64c09614-1b2a-42f7-804d-f647243eb1ab"}}}}},"required":true},"responses":{"200":{"description":"Workspace authorization token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-JWTtoken-apiv4"}}}},"401":{"$ref":"#/components/responses/api-service-401-apiv4"}},"deprecated":true,"tags":["Authorization (deprecated)"],"x-snr-doc-urls":["/api-reference/authorization#tag/Authorization-(deprecated)/operation/LogInAsBusinessProfile"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/auth/login/profile \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"apiKey\":\"64c09614-1b2a-42f7-804d-f647243eb1ab\"}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"apiKey\\\":\\\"64c09614-1b2a-42f7-804d-f647243eb1ab\\\"}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/auth/login/profile\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"apiKey\": \"64c09614-1b2a-42f7-804d-f647243eb1ab\"\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/auth/login/profile\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/auth/login/profile\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({apiKey: '64c09614-1b2a-42f7-804d-f647243eb1ab'}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/auth/login/profile');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"apiKey\":\"64c09614-1b2a-42f7-804d-f647243eb1ab\"}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/auth/login/profile\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"apiKey\\\":\\\"64c09614-1b2a-42f7-804d-f647243eb1ab\\\"}\")\n .asString();"}]}},"/v4/events/ai-compat/batch":{"post":{"security":[{"JWT":[]},{"TrackerKey":[]}],"tags":["AI Events"],"summary":"Batch upload AI events","description":"Upload a batch of events to the AI engine. A request can only include events of one type.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Web SDK Tracker, AI API key (legacy)\n\n**API key permission required:** `API_BATCH_EVENTS_CREATE`\n","operationId":"publishAiCompatBatchUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-AiCompatBatchEventRequest-apiv4"}}}},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"x-snr-doc-urls":["/api-reference/data-management#tag/AI-Events/operation/publishAiCompatBatchUsingPOST"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/ai-compat/batch \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"eventType\":\"item.search.click\",\"items\":[{\"correlationId\":\"string\",\"clientUUID\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"position\":0,\"searchType\":\"full-text-search\",\"item\":\"string\",\"EventTimestamp\":\"2019-02-07T09:53:56.999+00:00\",\"property1\":null,\"property2\":null}]}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"eventType\\\":\\\"item.search.click\\\",\\\"items\\\":[{\\\"correlationId\\\":\\\"string\\\",\\\"clientUUID\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"position\\\":0,\\\"searchType\\\":\\\"full-text-search\\\",\\\"item\\\":\\\"string\\\",\\\"EventTimestamp\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"property1\\\":null,\\\"property2\\\":null}]}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/ai-compat/batch\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"eventType\": \"item.search.click\",\n \"items\": [\n {\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 0,\n \"searchType\": \"full-text-search\",\n \"item\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\",\n \"property1\": null,\n \"property2\": null\n }\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/ai-compat/batch\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/ai-compat/batch\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n eventType: 'item.search.click',\n items: [\n {\n correlationId: 'string',\n clientUUID: '07243772-008a-42e1-ba37-c3807cebde8f',\n position: 0,\n searchType: 'full-text-search',\n item: 'string',\n EventTimestamp: '2019-02-07T09:53:56.999+00:00',\n property1: null,\n property2: null\n }\n ]\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/ai-compat/batch');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"eventType\":\"item.search.click\",\"items\":[{\"correlationId\":\"string\",\"clientUUID\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"position\":0,\"searchType\":\"full-text-search\",\"item\":\"string\",\"EventTimestamp\":\"2019-02-07T09:53:56.999+00:00\",\"property1\":null,\"property2\":null}]}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/ai-compat/batch\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"eventType\\\":\\\"item.search.click\\\",\\\"items\\\":[{\\\"correlationId\\\":\\\"string\\\",\\\"clientUUID\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"position\\\":0,\\\"searchType\\\":\\\"full-text-search\\\",\\\"item\\\":\\\"string\\\",\\\"EventTimestamp\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"property1\\\":null,\\\"property2\\\":null}]}\")\n .asString();"}]}},"/v4/events/ai-compat/item.search.click":{"post":{"security":[{"JWT":[]},{"TrackerKey":[]}],"tags":["AI Events"],"summary":"Item clicked in search","description":"Upload an item.search.click event to the AI engine.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Web SDK Tracker, AI API key (legacy)\n\n**API key permission required:** `API_ITEM_SEARCH_CLICK_EVENT_CREATE`\n","operationId":"publishAiCompatItemSearchClickUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-ItemSearchClickEventDataCompat-apiv4"}}}},"responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"x-snr-doc-urls":["/api-reference/data-management#tag/AI-Events/operation/publishAiCompatItemSearchClickUsingPOST"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/ai-compat/item.search.click \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"correlationId\":\"string\",\"clientUUID\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"position\":0,\"searchType\":\"full-text-search\",\"item\":\"string\",\"EventTimestamp\":\"2019-02-07T09:53:56.999+00:00\",\"property1\":null,\"property2\":null}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"correlationId\\\":\\\"string\\\",\\\"clientUUID\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"position\\\":0,\\\"searchType\\\":\\\"full-text-search\\\",\\\"item\\\":\\\"string\\\",\\\"EventTimestamp\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"property1\\\":null,\\\"property2\\\":null}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/ai-compat/item.search.click\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 0,\n \"searchType\": \"full-text-search\",\n \"item\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\",\n \"property1\": null,\n \"property2\": null\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/ai-compat/item.search.click\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/ai-compat/item.search.click\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n correlationId: 'string',\n clientUUID: '07243772-008a-42e1-ba37-c3807cebde8f',\n position: 0,\n searchType: 'full-text-search',\n item: 'string',\n EventTimestamp: '2019-02-07T09:53:56.999+00:00',\n property1: null,\n property2: null\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/ai-compat/item.search.click');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"correlationId\":\"string\",\"clientUUID\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"position\":0,\"searchType\":\"full-text-search\",\"item\":\"string\",\"EventTimestamp\":\"2019-02-07T09:53:56.999+00:00\",\"property1\":null,\"property2\":null}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/ai-compat/item.search.click\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"correlationId\\\":\\\"string\\\",\\\"clientUUID\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"position\\\":0,\\\"searchType\\\":\\\"full-text-search\\\",\\\"item\\\":\\\"string\\\",\\\"EventTimestamp\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"property1\\\":null,\\\"property2\\\":null}\")\n .asString();"}]}},"/v4/events/ai-compat/suggestion.search.click":{"post":{"security":[{"JWT":[]},{"TrackerKey":[]}],"tags":["AI Events"],"summary":"Suggestion clicked in search","description":"Upload a suggestion.search.click event to the AI engine.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Web SDK Tracker, AI API key (legacy)\n\n**API key permission required:** `API_SUGGESTION_SEARCH_CLICK_EVENT_CREATE`\n","operationId":"publishAiCompatSuggestionSearchClickUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-SuggestionSearchClickEventDataCompat-apiv4"}}}},"responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"x-snr-doc-urls":["/api-reference/data-management#tag/AI-Events/operation/publishAiCompatSuggestionSearchClickUsingPOST"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/ai-compat/suggestion.search.click \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"correlationId\":\"string\",\"clientUUID\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"position\":0,\"searchType\":\"full-text-search\",\"EventTimestamp\":\"2019-02-07T09:53:56.999+00:00\",\"suggestion\":\"string\",\"property1\":null,\"property2\":null}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"correlationId\\\":\\\"string\\\",\\\"clientUUID\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"position\\\":0,\\\"searchType\\\":\\\"full-text-search\\\",\\\"EventTimestamp\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"suggestion\\\":\\\"string\\\",\\\"property1\\\":null,\\\"property2\\\":null}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/ai-compat/suggestion.search.click\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 0,\n \"searchType\": \"full-text-search\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\",\n \"suggestion\": \"string\",\n \"property1\": null,\n \"property2\": null\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/ai-compat/suggestion.search.click\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/ai-compat/suggestion.search.click\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n correlationId: 'string',\n clientUUID: '07243772-008a-42e1-ba37-c3807cebde8f',\n position: 0,\n searchType: 'full-text-search',\n EventTimestamp: '2019-02-07T09:53:56.999+00:00',\n suggestion: 'string',\n property1: null,\n property2: null\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/ai-compat/suggestion.search.click');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"correlationId\":\"string\",\"clientUUID\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"position\":0,\"searchType\":\"full-text-search\",\"EventTimestamp\":\"2019-02-07T09:53:56.999+00:00\",\"suggestion\":\"string\",\"property1\":null,\"property2\":null}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/ai-compat/suggestion.search.click\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"correlationId\\\":\\\"string\\\",\\\"clientUUID\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"position\\\":0,\\\"searchType\\\":\\\"full-text-search\\\",\\\"EventTimestamp\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"suggestion\\\":\\\"string\\\",\\\"property1\\\":null,\\\"property2\\\":null}\")\n .asString();"}]}},"/v4/events/ai-compat/product.search.click":{"post":{"deprecated":true,"security":[{"JWT":[]},{"TrackerKey":[]}],"tags":["AI Events"],"summary":"Product clicked in search","description":"Upload a product.search.click event to the AI engine.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Web SDK Tracker, AI API key (legacy)\n\n**API key permission required:** `API_PRODUCT_SEARCH_CLICK_EVENT_CREATE`\n","operationId":"publishAiCompatProductSearchClickUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-ProductSearchClickEventDataCompat-apiv4"}}}},"responses":{"202":{"description":"Accepted"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"x-snr-doc-urls":["/api-reference/data-management#tag/AI-Events/operation/publishAiCompatProductSearchClickUsingPOST"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/ai-compat/product.search.click \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"correlationId\":\"string\",\"clientUUID\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"position\":0,\"searchType\":\"full-text-search\",\"productId\":\"string\",\"EventTimestamp\":\"2019-02-07T09:53:56.999+00:00\",\"property1\":null,\"property2\":null}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"correlationId\\\":\\\"string\\\",\\\"clientUUID\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"position\\\":0,\\\"searchType\\\":\\\"full-text-search\\\",\\\"productId\\\":\\\"string\\\",\\\"EventTimestamp\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"property1\\\":null,\\\"property2\\\":null}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/ai-compat/product.search.click\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"position\": 0,\n \"searchType\": \"full-text-search\",\n \"productId\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\",\n \"property1\": null,\n \"property2\": null\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/ai-compat/product.search.click\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/ai-compat/product.search.click\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n correlationId: 'string',\n clientUUID: '07243772-008a-42e1-ba37-c3807cebde8f',\n position: 0,\n searchType: 'full-text-search',\n productId: 'string',\n EventTimestamp: '2019-02-07T09:53:56.999+00:00',\n property1: null,\n property2: null\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/ai-compat/product.search.click');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"correlationId\":\"string\",\"clientUUID\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"position\":0,\"searchType\":\"full-text-search\",\"productId\":\"string\",\"EventTimestamp\":\"2019-02-07T09:53:56.999+00:00\",\"property1\":null,\"property2\":null}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/ai-compat/product.search.click\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"correlationId\\\":\\\"string\\\",\\\"clientUUID\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"position\\\":0,\\\"searchType\\\":\\\"full-text-search\\\",\\\"productId\\\":\\\"string\\\",\\\"EventTimestamp\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"property1\\\":null,\\\"property2\\\":null}\")\n .asString();"}]}},"/v4/events/ai-compat/recommendation.click":{"post":{"security":[{"JWT":[]},{"TrackerKey":[]}],"tags":["AI Events"],"summary":"Item clicked in recommendation","description":"Upload a recommendation.click event to the AI engine.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Web SDK Tracker, AI API key (legacy)\n\n**API key permission required:** `API_RECOMMENDATION_CLICK_EVENT_CREATE`\n","operationId":"publishAiCompatRecommendationClickUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-RecommendationClickEventDataCompat-apiv4"}}}},"responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"x-snr-doc-urls":["/api-reference/data-management#tag/AI-Events/operation/publishAiCompatRecommendationClickUsingPOST"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/ai-compat/recommendation.click \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"correlationId\":\"string\",\"clientUUID\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"item\":\"string\",\"campaignId\":\"string\",\"sessionId\":\"string\",\"EventTimestamp\":\"2019-02-07T09:53:56.999+00:00\",\"property1\":null,\"property2\":null}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"correlationId\\\":\\\"string\\\",\\\"clientUUID\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"item\\\":\\\"string\\\",\\\"campaignId\\\":\\\"string\\\",\\\"sessionId\\\":\\\"string\\\",\\\"EventTimestamp\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"property1\\\":null,\\\"property2\\\":null}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/ai-compat/recommendation.click\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"item\": \"string\",\n \"campaignId\": \"string\",\n \"sessionId\": \"string\",\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\",\n \"property1\": null,\n \"property2\": null\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/ai-compat/recommendation.click\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/ai-compat/recommendation.click\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n correlationId: 'string',\n clientUUID: '07243772-008a-42e1-ba37-c3807cebde8f',\n item: 'string',\n campaignId: 'string',\n sessionId: 'string',\n EventTimestamp: '2019-02-07T09:53:56.999+00:00',\n property1: null,\n property2: null\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/ai-compat/recommendation.click');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"correlationId\":\"string\",\"clientUUID\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"item\":\"string\",\"campaignId\":\"string\",\"sessionId\":\"string\",\"EventTimestamp\":\"2019-02-07T09:53:56.999+00:00\",\"property1\":null,\"property2\":null}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/ai-compat/recommendation.click\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"correlationId\\\":\\\"string\\\",\\\"clientUUID\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"item\\\":\\\"string\\\",\\\"campaignId\\\":\\\"string\\\",\\\"sessionId\\\":\\\"string\\\",\\\"EventTimestamp\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"property1\\\":null,\\\"property2\\\":null}\")\n .asString();"}]}},"/v4/events/ai-compat/recommendation.view":{"post":{"security":[{"JWT":[]},{"TrackerKey":[]}],"tags":["AI Events"],"summary":"Recommendation viewed","description":"Upload a recommendation.view event to the AI engine.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Web SDK Tracker, AI API key (legacy)\n\n**API key permission required:** `API_RECOMMENDATION_VIEW_EVENT_CREATE`\n","operationId":"publishAiCompatRecommendationViewUsingPOST","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-RecommendationViewEventDataCompat-apiv4"}}}},"responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"x-snr-doc-urls":["/api-reference/data-management#tag/AI-Events/operation/publishAiCompatRecommendationViewUsingPOST"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/ai-compat/recommendation.view \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"correlationId\":\"string\",\"clientUUID\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"items\":[\"string\"],\"EventTimestamp\":\"2019-02-07T09:53:56.999+00:00\",\"campaignId\":\"string\",\"property1\":null,\"property2\":null}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"correlationId\\\":\\\"string\\\",\\\"clientUUID\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"items\\\":[\\\"string\\\"],\\\"EventTimestamp\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"campaignId\\\":\\\"string\\\",\\\"property1\\\":null,\\\"property2\\\":null}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/ai-compat/recommendation.view\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"correlationId\": \"string\",\n \"clientUUID\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"items\": [\n \"string\"\n ],\n \"EventTimestamp\": \"2019-02-07T09:53:56.999+00:00\",\n \"campaignId\": \"string\",\n \"property1\": null,\n \"property2\": null\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/ai-compat/recommendation.view\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/ai-compat/recommendation.view\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n correlationId: 'string',\n clientUUID: '07243772-008a-42e1-ba37-c3807cebde8f',\n items: ['string'],\n EventTimestamp: '2019-02-07T09:53:56.999+00:00',\n campaignId: 'string',\n property1: null,\n property2: null\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/ai-compat/recommendation.view');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"correlationId\":\"string\",\"clientUUID\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"items\":[\"string\"],\"EventTimestamp\":\"2019-02-07T09:53:56.999+00:00\",\"campaignId\":\"string\",\"property1\":null,\"property2\":null}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/ai-compat/recommendation.view\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"correlationId\\\":\\\"string\\\",\\\"clientUUID\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"items\\\":[\\\"string\\\"],\\\"EventTimestamp\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"campaignId\\\":\\\"string\\\",\\\"property1\\\":null,\\\"property2\\\":null}\")\n .asString();"}]}},"/v4/events/recommendation-view":{"post":{"security":[{"JWT":[]}],"tags":["Events"],"summary":"Recommendation viewed","description":"A recommendation was displayed to a customer.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Web SDK Tracker, AI API key (legacy)\n\n**API key permission required:** `API_RECOMMENDATION_VIEW_EVENT_CREATE`\n","operationId":"publishRecommendationViewEventUsingPOST","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-RecommendationViewEventData-apiv4"}}}},"responses":{"200":{"description":"OK"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/publishRecommendationViewEventUsingPOST"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/recommendation-view \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"params\":{\"items\":[\"string\"],\"correlationId\":\"string\",\"campaignId\":\"string\"},\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\"}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"params\\\":{\\\"items\\\":[\\\"string\\\"],\\\"correlationId\\\":\\\"string\\\",\\\"campaignId\\\":\\\"string\\\"},\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\"}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/recommendation-view\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"params\": {\n \"items\": [\n \"string\"\n ],\n \"correlationId\": \"string\",\n \"campaignId\": \"string\"\n },\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\"\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/recommendation-view\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/recommendation-view\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n params: {items: ['string'], correlationId: 'string', campaignId: 'string'},\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00'\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/recommendation-view');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"params\":{\"items\":[\"string\"],\"correlationId\":\"string\",\"campaignId\":\"string\"},\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\"}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/recommendation-view\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"params\\\":{\\\"items\\\":[\\\"string\\\"],\\\"correlationId\\\":\\\"string\\\",\\\"campaignId\\\":\\\"string\\\"},\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\"}\")\n .asString();"}]}},"/v4/events/item-search-click":{"post":{"security":[{"JWT":[]}],"tags":["Events"],"summary":"Search result clicked","description":"An item in a search result was clicked or tapped.\n\n---\n\n**API consumers:** Workspace (Business Profile), Profile (Client), Anonymous Profile, Web SDK Tracker, AI API key (legacy)\n\n**API key permission required:** `API_ITEM_SEARCH_CLICK_EVENT_CREATE`\n","operationId":"publishItemSearchClickEventUsingPOST","parameters":[{"$ref":"#/components/parameters/api-service-apiVersionHeader-apiv4"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-service-ItemSearchClickEventData-apiv4"}}}},"responses":{"200":{"description":"OK"},"400":{"$ref":"#/components/responses/api-service-400-apiv4"},"401":{"$ref":"#/components/responses/api-service-401-apiv4"},"403":{"$ref":"#/components/responses/api-service-403-apiv4"},"415":{"$ref":"#/components/responses/api-service-415-apiv4"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Events/operation/publishItemSearchClickEventUsingPOST"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/v4/events/item-search-click \\\n --header 'Api-Version: SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"params\":{\"item\":\"string\",\"correlationId\":\"string\",\"position\":0,\"searchType\":\"full-text-search\"},\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\"}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"params\\\":{\\\"item\\\":\\\"string\\\",\\\"correlationId\\\":\\\"string\\\",\\\"position\\\":0,\\\"searchType\\\":\\\"full-text-search\\\"},\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\"}\"\n\nheaders = {\n 'Api-Version': \"SOME_STRING_VALUE\",\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/v4/events/item-search-click\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"params\": {\n \"item\": \"string\",\n \"correlationId\": \"string\",\n \"position\": 0,\n \"searchType\": \"full-text-search\"\n },\n \"label\": \"Human-readable label\",\n \"client\": {\n \"customId\": \"string\",\n \"id\": 433230297,\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\"\n },\n \"time\": \"2019-02-07T09:53:56.999+00:00\",\n \"eventSalt\": \"972346context.action2019-02-07T09:53:56.999+00:00\"\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/v4/events/item-search-click\");\nxhr.setRequestHeader(\"Api-Version\", \"SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/v4/events/item-search-click\",\n \"headers\": {\n \"Api-Version\": \"SOME_STRING_VALUE\",\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n params: {\n item: 'string',\n correlationId: 'string',\n position: 0,\n searchType: 'full-text-search'\n },\n label: 'Human-readable label',\n client: {\n customId: 'string',\n id: 433230297,\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string'\n },\n time: '2019-02-07T09:53:56.999+00:00',\n eventSalt: '972346context.action2019-02-07T09:53:56.999+00:00'\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/v4/events/item-search-click');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Api-Version' => 'SOME_STRING_VALUE',\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"params\":{\"item\":\"string\",\"correlationId\":\"string\",\"position\":0,\"searchType\":\"full-text-search\"},\"label\":\"Human-readable label\",\"client\":{\"customId\":\"string\",\"id\":433230297,\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\"},\"time\":\"2019-02-07T09:53:56.999+00:00\",\"eventSalt\":\"972346context.action2019-02-07T09:53:56.999+00:00\"}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/v4/events/item-search-click\")\n .header(\"Api-Version\", \"SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"params\\\":{\\\"item\\\":\\\"string\\\",\\\"correlationId\\\":\\\"string\\\",\\\"position\\\":0,\\\"searchType\\\":\\\"full-text-search\\\"},\\\"label\\\":\\\"Human-readable label\\\",\\\"client\\\":{\\\"customId\\\":\\\"string\\\",\\\"id\\\":433230297,\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\"},\\\"time\\\":\\\"2019-02-07T09:53:56.999+00:00\\\",\\\"eventSalt\\\":\\\"972346context.action2019-02-07T09:53:56.999+00:00\\\"}\")\n .asString();"}]}},"/automation-brain/dashboard/diagrams/count-by-trigger-type":{"get":{"security":[{"JWT":[]}],"tags":["Control Center"],"summary":"Count workflows by trigger type","operationId":"countDiagramsByTriggerType","description":"Returns the count of active workflows grouped by trigger node type for the current workspace.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_LIST_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","responses":{"200":{"description":"Workflow counts by trigger type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation-brain-DiagramCountByTriggerTypeResponse"}}}},"400":{"$ref":"#/components/responses/automation-brain-genericError"},"401":{"$ref":"#/components/responses/automation-brain-401"},"403":{"$ref":"#/components/responses/automation-brain-403"}},"x-snr-doc-urls":["/api-reference/automation#tag/Control-Center/operation/countDiagramsByTriggerType"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url https://api.synerise.com/automation-brain/dashboard/diagrams/count-by-trigger-type \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/automation-brain/dashboard/diagrams/count-by-trigger-type\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/automation-brain/dashboard/diagrams/count-by-trigger-type\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/dashboard/diagrams/count-by-trigger-type\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/dashboard/diagrams/count-by-trigger-type');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/automation-brain/dashboard/diagrams/count-by-trigger-type\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/automation-brain/dashboard/diagrams/count-by-status":{"get":{"security":[{"JWT":[]}],"tags":["Control Center"],"summary":"Count workflows by status","operationId":"countDiagramsByStatus","description":"Returns the count of workflows grouped by status for the current workspace.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_LIST_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","responses":{"200":{"description":"Workflow counts by status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation-brain-DiagramCountByStatusResponse"}}}},"400":{"$ref":"#/components/responses/automation-brain-genericError"},"401":{"$ref":"#/components/responses/automation-brain-401"},"403":{"$ref":"#/components/responses/automation-brain-403"}},"x-snr-doc-urls":["/api-reference/automation#tag/Control-Center/operation/countDiagramsByStatus"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url https://api.synerise.com/automation-brain/dashboard/diagrams/count-by-status \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/automation-brain/dashboard/diagrams/count-by-status\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/automation-brain/dashboard/diagrams/count-by-status\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/dashboard/diagrams/count-by-status\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/dashboard/diagrams/count-by-status');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/automation-brain/dashboard/diagrams/count-by-status\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/automation-brain/dashboard/diagrams/most-used":{"get":{"security":[{"JWT":[]}],"tags":["Control Center"],"summary":"Get most used workflows","operationId":"getMostUsedDiagrams","description":"Returns a paginated list of workflows ordered by the number of data points (events) generated by those workflows.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_LIST_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","parameters":[{"$ref":"#/components/parameters/automation-brain-page"},{"$ref":"#/components/parameters/automation-brain-limit"}],"responses":{"200":{"description":"A page of most used workflows","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation-brain-PaginatedDashboardDiagramsMostUsed"}}}},"400":{"$ref":"#/components/responses/automation-brain-genericError"},"401":{"$ref":"#/components/responses/automation-brain-401"},"403":{"$ref":"#/components/responses/automation-brain-403"}},"x-snr-doc-urls":["/api-reference/automation#tag/Control-Center/operation/getMostUsedDiagrams"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/automation-brain/dashboard/diagrams/most-used?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/automation-brain/dashboard/diagrams/most-used?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/automation-brain/dashboard/diagrams/most-used?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/dashboard/diagrams/most-used?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/dashboard/diagrams/most-used');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'page' => 'SOME_NUMBER_VALUE',\n 'limit' => 'SOME_NUMBER_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/automation-brain/dashboard/diagrams/most-used?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/automation-brain/dashboard/diagrams/most-triggered":{"get":{"security":[{"JWT":[]}],"tags":["Control Center"],"summary":"Get most triggered workflows","operationId":"getMostTriggeredDiagrams","description":"Returns a paginated list of workflows ordered by the number of triggered paths.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_LIST_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","parameters":[{"$ref":"#/components/parameters/automation-brain-page"},{"$ref":"#/components/parameters/automation-brain-limit"}],"responses":{"200":{"description":"A page of most triggered workflows","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation-brain-PaginatedDashboardDiagramsMostTriggered"}}}},"400":{"$ref":"#/components/responses/automation-brain-genericError"},"401":{"$ref":"#/components/responses/automation-brain-401"},"403":{"$ref":"#/components/responses/automation-brain-403"}},"x-snr-doc-urls":["/api-reference/automation#tag/Control-Center/operation/getMostTriggeredDiagrams"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/automation-brain/dashboard/diagrams/most-triggered?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/automation-brain/dashboard/diagrams/most-triggered?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/automation-brain/dashboard/diagrams/most-triggered?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/dashboard/diagrams/most-triggered?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/dashboard/diagrams/most-triggered');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'page' => 'SOME_NUMBER_VALUE',\n 'limit' => 'SOME_NUMBER_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/automation-brain/dashboard/diagrams/most-triggered?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/automation-brain/dashboard/diagrams/in-progress":{"get":{"security":[{"JWT":[]}],"tags":["Control Center"],"summary":"Get workflows with paths in progress","operationId":"getInProgressDiagrams","description":"Returns a paginated list of workflows ordered by the number of paths currently in progress.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_LIST_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","parameters":[{"$ref":"#/components/parameters/automation-brain-page"},{"$ref":"#/components/parameters/automation-brain-limit"}],"responses":{"200":{"description":"A page of workflows with paths in progress","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation-brain-PaginatedDashboardDiagramsInProgress"}}}},"400":{"$ref":"#/components/responses/automation-brain-genericError"},"401":{"$ref":"#/components/responses/automation-brain-401"},"403":{"$ref":"#/components/responses/automation-brain-403"}},"x-snr-doc-urls":["/api-reference/automation#tag/Control-Center/operation/getInProgressDiagrams"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/automation-brain/dashboard/diagrams/in-progress?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/automation-brain/dashboard/diagrams/in-progress?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/automation-brain/dashboard/diagrams/in-progress?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/dashboard/diagrams/in-progress?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/dashboard/diagrams/in-progress');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'page' => 'SOME_NUMBER_VALUE',\n 'limit' => 'SOME_NUMBER_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/automation-brain/dashboard/diagrams/in-progress?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/automation-brain/dashboard/upcoming-status-changes":{"get":{"security":[{"JWT":[]}],"tags":["Control Center"],"summary":"Get upcoming status changes","operationId":"getUpcomingStatusChanges","description":"Returns a paginated list of upcoming workflow status changes (resumes, pauses, and stops).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_LIST_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","parameters":[{"$ref":"#/components/parameters/automation-brain-page"},{"$ref":"#/components/parameters/automation-brain-limit"}],"responses":{"200":{"description":"A page of upcoming status changes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation-brain-PaginatedDashboardUpcomingStatusChanges"}}}},"400":{"$ref":"#/components/responses/automation-brain-genericError"},"401":{"$ref":"#/components/responses/automation-brain-401"},"403":{"$ref":"#/components/responses/automation-brain-403"}},"x-snr-doc-urls":["/api-reference/automation#tag/Control-Center/operation/getUpcomingStatusChanges"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/automation-brain/dashboard/upcoming-status-changes?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/automation-brain/dashboard/upcoming-status-changes?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/automation-brain/dashboard/upcoming-status-changes?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/dashboard/upcoming-status-changes?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/dashboard/upcoming-status-changes');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'page' => 'SOME_NUMBER_VALUE',\n 'limit' => 'SOME_NUMBER_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/automation-brain/dashboard/upcoming-status-changes?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/automation-brain/dashboard/upcoming-triggers":{"get":{"security":[{"JWT":[]}],"tags":["Control Center"],"summary":"Get upcoming trigger events","operationId":"getUpcomingTriggers","description":"Returns a paginated list of upcoming trigger events for workflows with active scheduled triggers.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_LIST_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","parameters":[{"$ref":"#/components/parameters/automation-brain-page"},{"$ref":"#/components/parameters/automation-brain-limit"}],"responses":{"200":{"description":"A page of upcoming trigger events","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation-brain-PaginatedDashboardUpcomingTriggers"}}}},"400":{"$ref":"#/components/responses/automation-brain-genericError"},"401":{"$ref":"#/components/responses/automation-brain-401"},"403":{"$ref":"#/components/responses/automation-brain-403"}},"x-snr-doc-urls":["/api-reference/automation#tag/Control-Center/operation/getUpcomingTriggers"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/automation-brain/dashboard/upcoming-triggers?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/automation-brain/dashboard/upcoming-triggers?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/automation-brain/dashboard/upcoming-triggers?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/dashboard/upcoming-triggers?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/dashboard/upcoming-triggers');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'page' => 'SOME_NUMBER_VALUE',\n 'limit' => 'SOME_NUMBER_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/automation-brain/dashboard/upcoming-triggers?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/automation-brain/dashboard/diagrams/with-issues":{"get":{"security":[{"JWT":[]}],"tags":["Control Center"],"summary":"Get workflows with issues","operationId":"getDiagramsWithIssues","description":"Returns a paginated list of workflows that have encountered failures, ordered by failure count.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_LIST_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","parameters":[{"$ref":"#/components/parameters/automation-brain-timePeriod"},{"name":"context","description":"AutomationContext for which workflows should be returned","in":"query","required":false,"schema":{"type":"string","enum":["Client","Business","Undefined"]}},{"$ref":"#/components/parameters/automation-brain-page"},{"$ref":"#/components/parameters/automation-brain-limit"}],"responses":{"200":{"description":"A page of workflows with issues","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation-brain-PaginatedDashboardDiagramsWithIssues"}}}},"400":{"$ref":"#/components/responses/automation-brain-genericError"},"401":{"$ref":"#/components/responses/automation-brain-401"},"403":{"$ref":"#/components/responses/automation-brain-403"}},"x-snr-doc-urls":["/api-reference/automation#tag/Control-Center/operation/getDiagramsWithIssues"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/automation-brain/dashboard/diagrams/with-issues?timePeriod=SOME_STRING_VALUE&context=SOME_STRING_VALUE&page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/automation-brain/dashboard/diagrams/with-issues?timePeriod=SOME_STRING_VALUE&context=SOME_STRING_VALUE&page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/automation-brain/dashboard/diagrams/with-issues?timePeriod=SOME_STRING_VALUE&context=SOME_STRING_VALUE&page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/dashboard/diagrams/with-issues?timePeriod=SOME_STRING_VALUE&context=SOME_STRING_VALUE&page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/dashboard/diagrams/with-issues');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'timePeriod' => 'SOME_STRING_VALUE',\n 'context' => 'SOME_STRING_VALUE',\n 'page' => 'SOME_NUMBER_VALUE',\n 'limit' => 'SOME_NUMBER_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/automation-brain/dashboard/diagrams/with-issues?timePeriod=SOME_STRING_VALUE&context=SOME_STRING_VALUE&page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/automation-brain/diagrams":{"get":{"security":[{"JWT":[]}],"tags":["Workflows"],"summary":"Get list of workflows/diagrams","operationId":"getPaginatedDiagrams","description":"Retrieve a paginated list of workflows.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_LIST_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","parameters":[{"$ref":"#/components/parameters/automation-brain-page"},{"$ref":"#/components/parameters/automation-brain-limit"},{"$ref":"#/components/parameters/automation-brain-filterByStatus"},{"$ref":"#/components/parameters/automation-brain-sortDiagrams"},{"$ref":"#/components/parameters/automation-brain-sortByDiagrams"},{"$ref":"#/components/parameters/automation-brain-sortingOrder"},{"$ref":"#/components/parameters/automation-brain-search"},{"$ref":"#/components/parameters/automation-brain-directoryId"},{"$ref":"#/components/parameters/automation-brain-blockTypes"},{"$ref":"#/components/parameters/automation-brain-triggersOnEvent"},{"$ref":"#/components/parameters/automation-brain-generatesEvent"}],"responses":{"200":{"description":"A page of workflows","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation-brain-PaginatedDiagrams"}}}},"400":{"$ref":"#/components/responses/automation-brain-400"},"401":{"$ref":"#/components/responses/automation-brain-401"},"403":{"$ref":"#/components/responses/automation-brain-403"},"404":{"$ref":"#/components/responses/automation-brain-404"}},"x-snr-doc-urls":["/api-reference/automation#tag/Workflows/operation/getPaginatedDiagrams"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/automation-brain/diagrams?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE&status=SOME_STRING_VALUE&sort=SOME_STRING_VALUE&sortBy=createdTime%3Adesc&order=SOME_STRING_VALUE&search=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE&blockTypes=SOME_STRING_VALUE&triggersOnEvent=SOME_STRING_VALUE&generatesEvent=SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/automation-brain/diagrams?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE&status=SOME_STRING_VALUE&sort=SOME_STRING_VALUE&sortBy=createdTime%3Adesc&order=SOME_STRING_VALUE&search=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE&blockTypes=SOME_STRING_VALUE&triggersOnEvent=SOME_STRING_VALUE&generatesEvent=SOME_STRING_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/automation-brain/diagrams?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE&status=SOME_STRING_VALUE&sort=SOME_STRING_VALUE&sortBy=createdTime%3Adesc&order=SOME_STRING_VALUE&search=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE&blockTypes=SOME_STRING_VALUE&triggersOnEvent=SOME_STRING_VALUE&generatesEvent=SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/diagrams?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE&status=SOME_STRING_VALUE&sort=SOME_STRING_VALUE&sortBy=createdTime%3Adesc&order=SOME_STRING_VALUE&search=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE&blockTypes=SOME_STRING_VALUE&triggersOnEvent=SOME_STRING_VALUE&generatesEvent=SOME_STRING_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/diagrams');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'page' => 'SOME_NUMBER_VALUE',\n 'limit' => 'SOME_NUMBER_VALUE',\n 'status' => 'SOME_STRING_VALUE',\n 'sort' => 'SOME_STRING_VALUE',\n 'sortBy' => 'createdTime:desc',\n 'order' => 'SOME_STRING_VALUE',\n 'search' => 'SOME_STRING_VALUE',\n 'directoryId' => 'SOME_STRING_VALUE',\n 'blockTypes' => 'SOME_STRING_VALUE',\n 'triggersOnEvent' => 'SOME_STRING_VALUE',\n 'generatesEvent' => 'SOME_STRING_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/automation-brain/diagrams?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE&status=SOME_STRING_VALUE&sort=SOME_STRING_VALUE&sortBy=createdTime%3Adesc&order=SOME_STRING_VALUE&search=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE&blockTypes=SOME_STRING_VALUE&triggersOnEvent=SOME_STRING_VALUE&generatesEvent=SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/automation-brain/v2/diagrams":{"get":{"security":[{"JWT":[]}],"tags":["Workflows"],"summary":"Get list of workflows","operationId":"getPaginatedDiagramsV2","description":"Retrieve a paginated list of workflows.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_LIST_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","parameters":[{"$ref":"#/components/parameters/automation-brain-page"},{"$ref":"#/components/parameters/automation-brain-limit50"},{"$ref":"#/components/parameters/automation-brain-filterByStatus"},{"$ref":"#/components/parameters/automation-brain-sortDiagrams"},{"$ref":"#/components/parameters/automation-brain-sortByDiagrams"},{"$ref":"#/components/parameters/automation-brain-sortingOrder"},{"$ref":"#/components/parameters/automation-brain-search"},{"$ref":"#/components/parameters/automation-brain-directoryId"},{"$ref":"#/components/parameters/automation-brain-tagIds"},{"$ref":"#/components/parameters/automation-brain-blockTypes"},{"$ref":"#/components/parameters/automation-brain-triggersOnEvent"},{"$ref":"#/components/parameters/automation-brain-generatesEvent"}],"responses":{"200":{"description":"A page of workflows","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation-brain-PaginatedDiagramsV2"}}}},"400":{"$ref":"#/components/responses/automation-brain-400"},"401":{"$ref":"#/components/responses/automation-brain-401"},"403":{"$ref":"#/components/responses/automation-brain-403"},"404":{"$ref":"#/components/responses/automation-brain-404"}},"x-snr-doc-urls":["/api-reference/automation#tag/Workflows/operation/getPaginatedDiagramsV2"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/automation-brain/v2/diagrams?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE&status=SOME_STRING_VALUE&sort=SOME_STRING_VALUE&sortBy=createdTime%3Adesc&order=SOME_STRING_VALUE&search=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE&tags=SOME_STRING_VALUE&blockTypes=SOME_STRING_VALUE&triggersOnEvent=SOME_STRING_VALUE&generatesEvent=SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/automation-brain/v2/diagrams?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE&status=SOME_STRING_VALUE&sort=SOME_STRING_VALUE&sortBy=createdTime%3Adesc&order=SOME_STRING_VALUE&search=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE&tags=SOME_STRING_VALUE&blockTypes=SOME_STRING_VALUE&triggersOnEvent=SOME_STRING_VALUE&generatesEvent=SOME_STRING_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/automation-brain/v2/diagrams?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE&status=SOME_STRING_VALUE&sort=SOME_STRING_VALUE&sortBy=createdTime%3Adesc&order=SOME_STRING_VALUE&search=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE&tags=SOME_STRING_VALUE&blockTypes=SOME_STRING_VALUE&triggersOnEvent=SOME_STRING_VALUE&generatesEvent=SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/v2/diagrams?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE&status=SOME_STRING_VALUE&sort=SOME_STRING_VALUE&sortBy=createdTime%3Adesc&order=SOME_STRING_VALUE&search=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE&tags=SOME_STRING_VALUE&blockTypes=SOME_STRING_VALUE&triggersOnEvent=SOME_STRING_VALUE&generatesEvent=SOME_STRING_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/v2/diagrams');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'page' => 'SOME_NUMBER_VALUE',\n 'limit' => 'SOME_NUMBER_VALUE',\n 'status' => 'SOME_STRING_VALUE',\n 'sort' => 'SOME_STRING_VALUE',\n 'sortBy' => 'createdTime:desc',\n 'order' => 'SOME_STRING_VALUE',\n 'search' => 'SOME_STRING_VALUE',\n 'directoryId' => 'SOME_STRING_VALUE',\n 'tags' => 'SOME_STRING_VALUE',\n 'blockTypes' => 'SOME_STRING_VALUE',\n 'triggersOnEvent' => 'SOME_STRING_VALUE',\n 'generatesEvent' => 'SOME_STRING_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/automation-brain/v2/diagrams?page=SOME_NUMBER_VALUE&limit=SOME_NUMBER_VALUE&status=SOME_STRING_VALUE&sort=SOME_STRING_VALUE&sortBy=createdTime%3Adesc&order=SOME_STRING_VALUE&search=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE&tags=SOME_STRING_VALUE&blockTypes=SOME_STRING_VALUE&triggersOnEvent=SOME_STRING_VALUE&generatesEvent=SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/automation-brain/diagrams/{diagramId}/run":{"post":{"security":[{"JWT":[]}],"tags":["Workflows"],"summary":"Run/resume workflow","operationId":"runAutomationDiagram","description":"Run a or resume workflow.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_EXECUTE`\n\n**User role permission required:** `automation_2_journeys: execute`\n","parameters":[{"$ref":"#/components/parameters/automation-brain-diagramId"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation-brain-DiagramActionRequest"}}}},"responses":{"200":{"description":"Workflow run/resumed or was already running","content":{"text/plain":{"schema":{"type":"string","enum":["OK"]}}}},"400":{"$ref":"#/components/responses/automation-brain-genericError"},"401":{"$ref":"#/components/responses/automation-brain-401"},"403":{"$ref":"#/components/responses/automation-brain-403"},"404":{"$ref":"#/components/responses/automation-brain-404"}},"x-snr-doc-urls":["/api-reference/automation#tag/Workflows/operation/runAutomationDiagram"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/run \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"scheduleAction\":\"On\"}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"scheduleAction\\\":\\\"On\\\"}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/automation-brain/diagrams/%7BdiagramId%7D/run\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"scheduleAction\": \"On\"\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/run\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/diagrams/%7BdiagramId%7D/run\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({scheduleAction: 'On'}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/run');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"scheduleAction\":\"On\"}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/run\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"scheduleAction\\\":\\\"On\\\"}\")\n .asString();"}]}},"/automation-brain/diagrams/{diagramId}/pause":{"post":{"security":[{"JWT":[]}],"tags":["Workflows"],"summary":"Pause workflow","operationId":"pauseAutomationDiagram","description":"Pause a workflow.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_EXECUTE`\n\n**User role permission required:** `automation_2_journeys: execute`\n","parameters":[{"$ref":"#/components/parameters/automation-brain-diagramId"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation-brain-DiagramActionRequest"}}}},"responses":{"200":{"description":"Diagram paused or was already paused","content":{"text/plain":{"schema":{"type":"string","enum":["OK"]}}}},"400":{"$ref":"#/components/responses/automation-brain-genericError"},"401":{"$ref":"#/components/responses/automation-brain-401"},"403":{"$ref":"#/components/responses/automation-brain-403"},"404":{"$ref":"#/components/responses/automation-brain-404"}},"x-snr-doc-urls":["/api-reference/automation#tag/Workflows/operation/pauseAutomationDiagram"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/pause \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"scheduleAction\":\"On\"}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"scheduleAction\\\":\\\"On\\\"}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/automation-brain/diagrams/%7BdiagramId%7D/pause\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"scheduleAction\": \"On\"\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/pause\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/diagrams/%7BdiagramId%7D/pause\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({scheduleAction: 'On'}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/pause');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"scheduleAction\":\"On\"}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/pause\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"scheduleAction\\\":\\\"On\\\"}\")\n .asString();"}]}},"/automation-brain/diagrams/{diagramId}/stop":{"post":{"security":[{"JWT":[]}],"tags":["Workflows"],"summary":"Stop workflow","operationId":"stopAutomationDiagram","description":"Stop a workflow.\n\nWARNING: A stopped workflow can't be restarted.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_EXECUTE`\n\n**User role permission required:** `automation_2_journeys: execute`\n","parameters":[{"$ref":"#/components/parameters/automation-brain-diagramId"}],"responses":{"200":{"description":"Workflow stopped or was already stopped","content":{"text/plain":{"schema":{"type":"string","enum":["OK"]}}}},"400":{"$ref":"#/components/responses/automation-brain-genericError"},"401":{"$ref":"#/components/responses/automation-brain-401"},"403":{"$ref":"#/components/responses/automation-brain-403"},"404":{"$ref":"#/components/responses/automation-brain-404"}},"x-snr-doc-urls":["/api-reference/automation#tag/Workflows/operation/stopAutomationDiagram"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/stop \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"POST\", \"/automation-brain/diagrams/%7BdiagramId%7D/stop\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/stop\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/diagrams/%7BdiagramId%7D/stop\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/stop');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/stop\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/automation-brain/diagrams/{diagramId}/schedule":{"post":{"security":[{"JWT":[]}],"tags":["Workflow schedules"],"summary":"Set schedule rules for workflow","description":"Set schedule rules for a workflow. This lets you activate, pause, or stop a workflow according to a plan. \n\nAfter the schedule is set, it must be activated to take effect (see the `POST /automation-brain/diagrams/{diagramId}/schedule-on` method). \n\n**The backend doesn't validate the logic of the schedule**. You must ensure it's well-built (rules make logical sense) and complies with the structure of the workflow (such as trigger node time rules). See [\"Workflow Scheduler > Important\" in the Synerise Hub](https://hub.synerise.com/docs/automation/workflow-scheduler#important).\n\nThe contents of this request overwrite an existing schedule.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_SCHEDULE_UPDATE`\n\n**User role permission required:** `automation_2_journeys: update`\n","operationId":"setDiagramSchedule","parameters":[{"$ref":"#/components/parameters/automation-brain-diagramId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation-brain-DiagramScheduleRequest"}}},"required":true},"responses":{"200":{"description":"Schedule saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation-brain-DiagramSchedule"}}}},"400":{"$ref":"#/components/responses/automation-brain-SimpleError"},"401":{"$ref":"#/components/responses/automation-brain-401"},"403":{"$ref":"#/components/responses/automation-brain-403"},"404":{"$ref":"#/components/responses/automation-brain-404"}},"x-snr-doc-urls":["/api-reference/automation#tag/Workflow-schedules/operation/setDiagramSchedule"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"timezone\":\"Europe/Paris\",\"rules\":[{\"ruleId\":\"70af3071-65d9-4ec3-b3cb-5283e8d55dac\",\"actionType\":\"Resume\",\"repeatModel\":{\"repeatType\":\"Interval\",\"body\":{\"start\":\"2020-01-01T01:00:00.000\",\"intervalSeconds\":6000}}}]}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"timezone\\\":\\\"Europe/Paris\\\",\\\"rules\\\":[{\\\"ruleId\\\":\\\"70af3071-65d9-4ec3-b3cb-5283e8d55dac\\\",\\\"actionType\\\":\\\"Resume\\\",\\\"repeatModel\\\":{\\\"repeatType\\\":\\\"Interval\\\",\\\"body\\\":{\\\"start\\\":\\\"2020-01-01T01:00:00.000\\\",\\\"intervalSeconds\\\":6000}}}]}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/automation-brain/diagrams/%7BdiagramId%7D/schedule\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"timezone\": \"Europe/Paris\",\n \"rules\": [\n {\n \"ruleId\": \"70af3071-65d9-4ec3-b3cb-5283e8d55dac\",\n \"actionType\": \"Resume\",\n \"repeatModel\": {\n \"repeatType\": \"Interval\",\n \"body\": {\n \"start\": \"2020-01-01T01:00:00.000\",\n \"intervalSeconds\": 6000\n }\n }\n }\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/diagrams/%7BdiagramId%7D/schedule\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n timezone: 'Europe/Paris',\n rules: [\n {\n ruleId: '70af3071-65d9-4ec3-b3cb-5283e8d55dac',\n actionType: 'Resume',\n repeatModel: {\n repeatType: 'Interval',\n body: {start: '2020-01-01T01:00:00.000', intervalSeconds: 6000}\n }\n }\n ]\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"timezone\":\"Europe/Paris\",\"rules\":[{\"ruleId\":\"70af3071-65d9-4ec3-b3cb-5283e8d55dac\",\"actionType\":\"Resume\",\"repeatModel\":{\"repeatType\":\"Interval\",\"body\":{\"start\":\"2020-01-01T01:00:00.000\",\"intervalSeconds\":6000}}}]}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"timezone\\\":\\\"Europe/Paris\\\",\\\"rules\\\":[{\\\"ruleId\\\":\\\"70af3071-65d9-4ec3-b3cb-5283e8d55dac\\\",\\\"actionType\\\":\\\"Resume\\\",\\\"repeatModel\\\":{\\\"repeatType\\\":\\\"Interval\\\",\\\"body\\\":{\\\"start\\\":\\\"2020-01-01T01:00:00.000\\\",\\\"intervalSeconds\\\":6000}}}]}\")\n .asString();"}]},"get":{"security":[{"JWT":[]}],"tags":["Workflow schedules"],"summary":"Get workflow schedule","operationId":"getDiagramSchedule","description":"Get all schedule rules of a workflow.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_SCHEDULE_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","parameters":[{"$ref":"#/components/parameters/automation-brain-diagramId"}],"responses":{"200":{"description":"Schedule rules","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation-brain-DiagramSchedule"}}}},"400":{"$ref":"#/components/responses/automation-brain-SimpleError"},"401":{"$ref":"#/components/responses/automation-brain-401"},"403":{"$ref":"#/components/responses/automation-brain-403"},"404":{"$ref":"#/components/responses/automation-brain-404"}},"x-snr-doc-urls":["/api-reference/automation#tag/Workflow-schedules/operation/getDiagramSchedule"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/automation-brain/diagrams/%7BdiagramId%7D/schedule\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/diagrams/%7BdiagramId%7D/schedule\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/automation-brain/diagrams/{diagramId}/schedule-on":{"post":{"security":[{"JWT":[]}],"tags":["Workflow schedules"],"summary":"Enable schedule for workflow","operationId":"scheduleOnAutomationDiagram","description":"Enable schedule for a workflow. The schedule must first be set with `POST /automation-brain/diagrams/{diagramId}/schedule`\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_EXECUTE`\n\n**User role permission required:** `automation_2_journeys: execute`\n","parameters":[{"$ref":"#/components/parameters/automation-brain-diagramId"}],"responses":{"200":{"description":"Workflow scheduled or was already scheduled","content":{"text/plain":{"schema":{"type":"string","enum":["OK"]}}}},"400":{"$ref":"#/components/responses/automation-brain-genericError"},"401":{"$ref":"#/components/responses/automation-brain-401"},"403":{"$ref":"#/components/responses/automation-brain-403"},"404":{"$ref":"#/components/responses/automation-brain-404"}},"x-snr-doc-urls":["/api-reference/automation#tag/Workflow-schedules/operation/scheduleOnAutomationDiagram"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule-on \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"POST\", \"/automation-brain/diagrams/%7BdiagramId%7D/schedule-on\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule-on\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/diagrams/%7BdiagramId%7D/schedule-on\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule-on');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule-on\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/automation-brain/diagrams/{diagramId}/schedule-off":{"post":{"security":[{"JWT":[]}],"tags":["Workflow schedules"],"summary":"Disable schedule for workflow","operationId":"scheduleOffAutomationDiagram","description":"Disable schedule for a workflow.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_EXECUTE`\n\n**User role permission required:** `automation_2_journeys: execute`\n","parameters":[{"$ref":"#/components/parameters/automation-brain-diagramId"}],"responses":{"200":{"description":"Workflow unscheduled or was already unscheduled","content":{"text/plain":{"schema":{"type":"string","enum":["OK"]}}}},"400":{"$ref":"#/components/responses/automation-brain-genericError"},"401":{"$ref":"#/components/responses/automation-brain-401"},"403":{"$ref":"#/components/responses/automation-brain-403"},"404":{"$ref":"#/components/responses/automation-brain-404"}},"x-snr-doc-urls":["/api-reference/automation#tag/Workflow-schedules/operation/scheduleOffAutomationDiagram"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule-off \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"POST\", \"/automation-brain/diagrams/%7BdiagramId%7D/schedule-off\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule-off\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/diagrams/%7BdiagramId%7D/schedule-off\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule-off');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule-off\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/automation-brain/diagrams/{diagramId}/schedule-executed-events":{"get":{"security":[{"JWT":[]}],"tags":["Workflow schedules"],"summary":"Get schedule execution events","operationId":"getDiagramScheduleExecutedEvents","description":"Get events (rule executions) that were already processed for the workflow. You can limit the list to a time range defined by `start` and `end`.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_SCHEDULE_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","parameters":[{"$ref":"#/components/parameters/automation-brain-diagramId"},{"name":"start","in":"query","required":true,"description":"Start date","schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/automation-brain-ScheduleEventFilterEnd"}],"responses":{"200":{"description":"Executed schedule events","content":{"application/json":{"schema":{"type":"object","properties":{"hasMore":{"$ref":"#/components/schemas/automation-brain-HasMore"},"events":{"type":"array","description":"Executed schedule rules","items":{"$ref":"#/components/schemas/automation-brain-ExecutedDiagramScheduleEvent"}}},"required":["hasMore","events"]}}}},"400":{"$ref":"#/components/responses/automation-brain-genericError"},"403":{"$ref":"#/components/responses/automation-brain-403"}},"x-snr-doc-urls":["/api-reference/automation#tag/Workflow-schedules/operation/getDiagramScheduleExecutedEvents"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule-executed-events?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/automation-brain/diagrams/%7BdiagramId%7D/schedule-executed-events?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule-executed-events?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/diagrams/%7BdiagramId%7D/schedule-executed-events?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule-executed-events');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'start' => 'SOME_STRING_VALUE',\n 'end' => 'SOME_STRING_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule-executed-events?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/automation-brain/diagrams/{diagramId}/schedule-upcoming-events":{"get":{"security":[{"JWT":[]}],"tags":["Workflow schedules"],"summary":"Get upcoming schedule events","operationId":"getDiagramSchedulePendingEvents","description":"Get a list of upcoming events (rule executions) caused by a schedule. You can limit the list to a time range defined by `start` and `end`.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_SCHEDULE_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","parameters":[{"$ref":"#/components/parameters/automation-brain-diagramId"},{"$ref":"#/components/parameters/automation-brain-ScheduleEventFilterStart"},{"$ref":"#/components/parameters/automation-brain-ScheduleEventFilterEnd"}],"responses":{"200":{"description":"Upcoming schedule events","content":{"application/json":{"schema":{"type":"object","properties":{"hasMore":{"$ref":"#/components/schemas/automation-brain-HasMore"},"events":{"type":"array","description":"Upcoming schedule rule executions","items":{"$ref":"#/components/schemas/automation-brain-UpcomingDiagramScheduleEvent"}}},"required":["hasMore","events"]}}}},"400":{"$ref":"#/components/responses/automation-brain-genericError"},"403":{"$ref":"#/components/responses/automation-brain-403"}},"x-snr-doc-urls":["/api-reference/automation#tag/Workflow-schedules/operation/getDiagramSchedulePendingEvents"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule-upcoming-events?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/automation-brain/diagrams/%7BdiagramId%7D/schedule-upcoming-events?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule-upcoming-events?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/diagrams/%7BdiagramId%7D/schedule-upcoming-events?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule-upcoming-events');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'start' => 'SOME_STRING_VALUE',\n 'end' => 'SOME_STRING_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/schedule-upcoming-events?start=SOME_STRING_VALUE&end=SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/automation-brain/diagrams/{diagramId}/upcoming-status-changes":{"get":{"security":[{"JWT":[]}],"tags":["Workflow schedules"],"summary":"Get upcoming workflow status changes","operationId":"getDiagramUpcomingStatusChanges","description":"Get upcoming status changes for a workflow. You can limit the list to a time range defined by `start` and `end`.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATON_BRAIN_DIAGRAM_SCHEDULE_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","parameters":[{"$ref":"#/components/parameters/automation-brain-diagramId"},{"name":"initialStatus","in":"query","description":"Initial status used if diagramId is not present (default: Pending)","schema":{"type":"string"}},{"$ref":"#/components/parameters/automation-brain-ScheduleEventFilterStart"},{"$ref":"#/components/parameters/automation-brain-ScheduleEventFilterEnd"}],"responses":{"200":{"description":"Upcoming status changes","content":{"application/json":{"schema":{"type":"object","properties":{"hasMore":{"$ref":"#/components/schemas/automation-brain-HasMore"},"events":{"type":"array","description":"Upcoming status changes of the workflow","items":{"$ref":"#/components/schemas/automation-brain-UpcomingDiagramStatusChange"}}},"required":["hasMore","events"]}}}},"400":{"$ref":"#/components/responses/automation-brain-genericError"},"403":{"$ref":"#/components/responses/automation-brain-403"}},"x-snr-doc-urls":["/api-reference/automation#tag/Workflow-schedules/operation/getDiagramUpcomingStatusChanges"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/upcoming-status-changes?initialStatus=SOME_STRING_VALUE&start=SOME_STRING_VALUE&end=SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/automation-brain/diagrams/%7BdiagramId%7D/upcoming-status-changes?initialStatus=SOME_STRING_VALUE&start=SOME_STRING_VALUE&end=SOME_STRING_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/upcoming-status-changes?initialStatus=SOME_STRING_VALUE&start=SOME_STRING_VALUE&end=SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/diagrams/%7BdiagramId%7D/upcoming-status-changes?initialStatus=SOME_STRING_VALUE&start=SOME_STRING_VALUE&end=SOME_STRING_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/upcoming-status-changes');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'initialStatus' => 'SOME_STRING_VALUE',\n 'start' => 'SOME_STRING_VALUE',\n 'end' => 'SOME_STRING_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/upcoming-status-changes?initialStatus=SOME_STRING_VALUE&start=SOME_STRING_VALUE&end=SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/automation-brain/diagrams/{diagramId}/statistics":{"get":{"security":[{"JWT":[]}],"tags":["Workflows"],"summary":"Get workflow statistics with node details","operationId":"getDiagramStatistics","description":"Retrieve workflow execution statistics, including node statistics and metadata (name, type).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATION_STATS_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","parameters":[{"$ref":"#/components/parameters/automation-brain-diagramId"},{"name":"timePeriod","in":"query","description":"Time period for the statistics","required":false,"schema":{"type":"string","enum":["currentHour","currentDay","previousHour","previousDay"]}}],"responses":{"200":{"description":"Diagram statistics with node info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation-brain-ExternalDiagramStatsWithInfo"}}}},"400":{"$ref":"#/components/responses/automation-brain-genericError"},"403":{"$ref":"#/components/responses/automation-brain-403"},"404":{"description":"Diagram not found"}},"x-snr-doc-urls":["/api-reference/automation#tag/Workflows/operation/getDiagramStatistics"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/statistics?timePeriod=SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/automation-brain/diagrams/%7BdiagramId%7D/statistics?timePeriod=SOME_STRING_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/statistics?timePeriod=SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/diagrams/%7BdiagramId%7D/statistics?timePeriod=SOME_STRING_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/statistics');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'timePeriod' => 'SOME_STRING_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/statistics?timePeriod=SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/automation-brain/diagrams/{diagramId}/blocks/{blockId}/statistics":{"get":{"security":[{"JWT":[]}],"tags":["Workflows"],"summary":"Get node statistics","operationId":"getBlockStatistics","description":"Retrieve execution statistics for a single block enriched with block metadata (name, type).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `AUTOMATION_STATS_READ`\n\n**User role permission required:** `automation_2_journeys: read`\n","parameters":[{"$ref":"#/components/parameters/automation-brain-diagramId"},{"name":"blockId","in":"path","description":"UUID of the node","required":true,"schema":{"type":"string"}},{"name":"timePeriod","in":"query","description":"Time period for statistics","required":false,"schema":{"type":"string","enum":["currentHour","currentDay","previousHour","previousDay"]}}],"responses":{"200":{"description":"Block statistics with block info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automation-brain-ExternalBlockStatsWithInfo"}}}},"400":{"$ref":"#/components/responses/automation-brain-genericError"},"403":{"$ref":"#/components/responses/automation-brain-403"},"404":{"description":"Diagram or block not found"}},"x-snr-doc-urls":["/api-reference/automation#tag/Workflows/operation/getBlockStatistics"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/blocks/%7BblockId%7D/statistics?timePeriod=SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/automation-brain/diagrams/%7BdiagramId%7D/blocks/%7BblockId%7D/statistics?timePeriod=SOME_STRING_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/blocks/%7BblockId%7D/statistics?timePeriod=SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/automation-brain/diagrams/%7BdiagramId%7D/blocks/%7BblockId%7D/statistics?timePeriod=SOME_STRING_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/blocks/%7BblockId%7D/statistics');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'timePeriod' => 'SOME_STRING_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/automation-brain/diagrams/%7BdiagramId%7D/blocks/%7BblockId%7D/statistics?timePeriod=SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/brickworks/v1/schemas":{"get":{"tags":["Brickworks: Schemas"],"summary":"Get schemas","description":"Retrieve a list of schemas. You can paginate the results, filter by schema type, and search for a phrase in schema names.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_SCHEMAS_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","operationId":"getSchemas","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/brickworks-service-queryLimit"},{"$ref":"#/components/parameters/brickworks-service-queryPage"},{"$ref":"#/components/parameters/brickworks-service-querySearch"},{"$ref":"#/components/parameters/brickworks-service-querySortBy"},{"$ref":"#/components/parameters/brickworks-service-querySchemaTypes"}],"responses":{"200":{"description":"Schema objects","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-SchemaPagingResult"}}}},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-Schemas/operation/getSchemas"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/brickworks/v1/schemas?limit=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sortBy=updatedAt%3Aasc&schemaTypes=SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/brickworks/v1/schemas?limit=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sortBy=updatedAt%3Aasc&schemaTypes=SOME_STRING_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/brickworks/v1/schemas?limit=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sortBy=updatedAt%3Aasc&schemaTypes=SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/brickworks/v1/schemas?limit=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sortBy=updatedAt%3Aasc&schemaTypes=SOME_STRING_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/brickworks/v1/schemas');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'limit' => 'SOME_INTEGER_VALUE',\n 'page' => 'SOME_INTEGER_VALUE',\n 'search' => 'SOME_STRING_VALUE',\n 'sortBy' => 'updatedAt:asc',\n 'schemaTypes' => 'SOME_STRING_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/brickworks/v1/schemas?limit=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sortBy=updatedAt%3Aasc&schemaTypes=SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]},"post":{"tags":["Brickworks: Schemas"],"summary":"Create schema","description":"Create a new schema\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_SCHEMAS_CREATE`\n\n**User role permission required:** `assets_brickworks: create`\n","operationId":"createSchema","security":[{"JWT":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-CreateSchemaRequest"}}}},"responses":{"200":{"description":"Details of the created schema","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-Schema"}}}},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-Schemas/operation/createSchema"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/brickworks/v1/schemas \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"appId\":\"string\",\"displayName\":\"string\",\"description\":\"string\",\"fields\":{\"type\":\"object\",\"properties\":{\"property1\":{\"type\":\"number\",\"subtype\":\"number\",\"minimum\":0.1,\"maximum\":0.1,\"unique\":true,\"searchable\":true,\"default\":0,\"isConstantField\":false},\"property2\":{\"type\":\"number\",\"subtype\":\"number\",\"minimum\":0.1,\"maximum\":0.1,\"unique\":true,\"searchable\":true,\"default\":0,\"isConstantField\":false}},\"required\":[\"string\"],\"allOf\":[{\"if\":{\"required\":[\"string\"],\"properties\":{\"property1\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}},\"property2\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}}}},\"then\":{\"required\":[\"string\"],\"properties\":{\"property1\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}},\"property2\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}}}},\"else\":{\"required\":[\"string\"],\"properties\":{\"property1\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}},\"property2\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}}}}}],\"additionalProperties\":true},\"displayConfiguration\":{\"ordering\":{\"property1\":0,\"property2\":0},\"metadata\":{\"property1\":{\"title\":\"empty title\",\"description\":\"string\",\"useAsRecordName\":false},\"property2\":{\"title\":\"empty title\",\"description\":\"string\",\"useAsRecordName\":false}}},\"audience\":{\"targetType\":\"SEGMENT\",\"segments\":[\"497f6eca-6276-4993-bfeb-53cbbbba6f08\"],\"query\":\"{\\\\\\\"analysis\\\\\\\":{\\\\\\\"title\\\\\\\":\\\\\\\"notempty\\\\\\\",\\\\\\\"segments\\\\\\\":[{\\\\\\\"title\\\\\\\":\\\\\\\"notempty\\\\\\\",\\\\\\\"filter\\\\\\\":{\\\\\\\"matching\\\\\\\":true,\\\\\\\"expressions\\\\\\\":[{\\\\\\\"type\\\\\\\":\\\\\\\"ATTRIBUTE\\\\\\\",\\\\\\\"attribute\\\\\\\":{\\\\\\\"expressions\\\\\\\":[{\\\\\\\"constraint\\\\\\\":{\\\\\\\"type\\\\\\\":\\\\\\\"BOOL\\\\\\\",\\\\\\\"logic\\\\\\\":\\\\\\\"IS_TRUE\\\\\\\"},\\\\\\\"attribute\\\\\\\":{\\\\\\\"type\\\\\\\":\\\\\\\"PARAM\\\\\\\",\\\\\\\"param\\\\\\\":\\\\\\\"exampleBool\\\\\\\"}}]}}]}}]}}\"},\"schemaType\":\"SIMPLE\",\"lambdaId\":\"19f4e1cf-838e-4f7d-9400-1ddf9fb6829d\"}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"appId\\\":\\\"string\\\",\\\"displayName\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"fields\\\":{\\\"type\\\":\\\"object\\\",\\\"properties\\\":{\\\"property1\\\":{\\\"type\\\":\\\"number\\\",\\\"subtype\\\":\\\"number\\\",\\\"minimum\\\":0.1,\\\"maximum\\\":0.1,\\\"unique\\\":true,\\\"searchable\\\":true,\\\"default\\\":0,\\\"isConstantField\\\":false},\\\"property2\\\":{\\\"type\\\":\\\"number\\\",\\\"subtype\\\":\\\"number\\\",\\\"minimum\\\":0.1,\\\"maximum\\\":0.1,\\\"unique\\\":true,\\\"searchable\\\":true,\\\"default\\\":0,\\\"isConstantField\\\":false}},\\\"required\\\":[\\\"string\\\"],\\\"allOf\\\":[{\\\"if\\\":{\\\"required\\\":[\\\"string\\\"],\\\"properties\\\":{\\\"property1\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}},\\\"property2\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}}}},\\\"then\\\":{\\\"required\\\":[\\\"string\\\"],\\\"properties\\\":{\\\"property1\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}},\\\"property2\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}}}},\\\"else\\\":{\\\"required\\\":[\\\"string\\\"],\\\"properties\\\":{\\\"property1\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}},\\\"property2\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}}}}}],\\\"additionalProperties\\\":true},\\\"displayConfiguration\\\":{\\\"ordering\\\":{\\\"property1\\\":0,\\\"property2\\\":0},\\\"metadata\\\":{\\\"property1\\\":{\\\"title\\\":\\\"empty title\\\",\\\"description\\\":\\\"string\\\",\\\"useAsRecordName\\\":false},\\\"property2\\\":{\\\"title\\\":\\\"empty title\\\",\\\"description\\\":\\\"string\\\",\\\"useAsRecordName\\\":false}}},\\\"audience\\\":{\\\"targetType\\\":\\\"SEGMENT\\\",\\\"segments\\\":[\\\"497f6eca-6276-4993-bfeb-53cbbbba6f08\\\"],\\\"query\\\":\\\"{\\\\\\\\\\\\\\\"analysis\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"notempty\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"segments\\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"notempty\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"filter\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"matching\\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\\"expressions\\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"ATTRIBUTE\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"attribute\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"expressions\\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\\"constraint\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"BOOL\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"logic\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"IS_TRUE\\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\\"attribute\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"PARAM\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"param\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"exampleBool\\\\\\\\\\\\\\\"}}]}}]}}]}}\\\"},\\\"schemaType\\\":\\\"SIMPLE\\\",\\\"lambdaId\\\":\\\"19f4e1cf-838e-4f7d-9400-1ddf9fb6829d\\\"}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/brickworks/v1/schemas\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"appId\": \"string\",\n \"displayName\": \"string\",\n \"description\": \"string\",\n \"fields\": {\n \"type\": \"object\",\n \"properties\": {\n \"property1\": {\n \"type\": \"number\",\n \"subtype\": \"number\",\n \"minimum\": 0.1,\n \"maximum\": 0.1,\n \"unique\": true,\n \"searchable\": true,\n \"default\": 0,\n \"isConstantField\": false\n },\n \"property2\": {\n \"type\": \"number\",\n \"subtype\": \"number\",\n \"minimum\": 0.1,\n \"maximum\": 0.1,\n \"unique\": true,\n \"searchable\": true,\n \"default\": 0,\n \"isConstantField\": false\n }\n },\n \"required\": [\n \"string\"\n ],\n \"allOf\": [\n {\n \"if\": {\n \"required\": [\n \"string\"\n ],\n \"properties\": {\n \"property1\": {\n \"minItems\": 0,\n \"maxItems\": 0,\n \"uniqueItems\": true,\n \"minimum\": 0,\n \"maximum\": 0,\n \"pattern\": \"string\",\n \"const\": null,\n \"enum\": [\n \"string\"\n ],\n \"not\": {}\n },\n \"property2\": {\n \"minItems\": 0,\n \"maxItems\": 0,\n \"uniqueItems\": true,\n \"minimum\": 0,\n \"maximum\": 0,\n \"pattern\": \"string\",\n \"const\": null,\n \"enum\": [\n \"string\"\n ],\n \"not\": {}\n }\n }\n },\n \"then\": {\n \"required\": [\n \"string\"\n ],\n \"properties\": {\n \"property1\": {\n \"minItems\": 0,\n \"maxItems\": 0,\n \"uniqueItems\": true,\n \"minimum\": 0,\n \"maximum\": 0,\n \"pattern\": \"string\",\n \"const\": null,\n \"enum\": [\n \"string\"\n ],\n \"not\": {}\n },\n \"property2\": {\n \"minItems\": 0,\n \"maxItems\": 0,\n \"uniqueItems\": true,\n \"minimum\": 0,\n \"maximum\": 0,\n \"pattern\": \"string\",\n \"const\": null,\n \"enum\": [\n \"string\"\n ],\n \"not\": {}\n }\n }\n },\n \"else\": {\n \"required\": [\n \"string\"\n ],\n \"properties\": {\n \"property1\": {\n \"minItems\": 0,\n \"maxItems\": 0,\n \"uniqueItems\": true,\n \"minimum\": 0,\n \"maximum\": 0,\n \"pattern\": \"string\",\n \"const\": null,\n \"enum\": [\n \"string\"\n ],\n \"not\": {}\n },\n \"property2\": {\n \"minItems\": 0,\n \"maxItems\": 0,\n \"uniqueItems\": true,\n \"minimum\": 0,\n \"maximum\": 0,\n \"pattern\": \"string\",\n \"const\": null,\n \"enum\": [\n \"string\"\n ],\n \"not\": {}\n }\n }\n }\n }\n ],\n \"additionalProperties\": true\n },\n \"displayConfiguration\": {\n \"ordering\": {\n \"property1\": 0,\n \"property2\": 0\n },\n \"metadata\": {\n \"property1\": {\n \"title\": \"empty title\",\n \"description\": \"string\",\n \"useAsRecordName\": false\n },\n \"property2\": {\n \"title\": \"empty title\",\n \"description\": \"string\",\n \"useAsRecordName\": false\n }\n }\n },\n \"audience\": {\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n ],\n \"query\": \"{\\\\\\\"analysis\\\\\\\":{\\\\\\\"title\\\\\\\":\\\\\\\"notempty\\\\\\\",\\\\\\\"segments\\\\\\\":[{\\\\\\\"title\\\\\\\":\\\\\\\"notempty\\\\\\\",\\\\\\\"filter\\\\\\\":{\\\\\\\"matching\\\\\\\":true,\\\\\\\"expressions\\\\\\\":[{\\\\\\\"type\\\\\\\":\\\\\\\"ATTRIBUTE\\\\\\\",\\\\\\\"attribute\\\\\\\":{\\\\\\\"expressions\\\\\\\":[{\\\\\\\"constraint\\\\\\\":{\\\\\\\"type\\\\\\\":\\\\\\\"BOOL\\\\\\\",\\\\\\\"logic\\\\\\\":\\\\\\\"IS_TRUE\\\\\\\"},\\\\\\\"attribute\\\\\\\":{\\\\\\\"type\\\\\\\":\\\\\\\"PARAM\\\\\\\",\\\\\\\"param\\\\\\\":\\\\\\\"exampleBool\\\\\\\"}}]}}]}}]}}\"\n },\n \"schemaType\": \"SIMPLE\",\n \"lambdaId\": \"19f4e1cf-838e-4f7d-9400-1ddf9fb6829d\"\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/brickworks/v1/schemas\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/brickworks/v1/schemas\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n appId: 'string',\n displayName: 'string',\n description: 'string',\n fields: {\n type: 'object',\n properties: {\n property1: {\n type: 'number',\n subtype: 'number',\n minimum: 0.1,\n maximum: 0.1,\n unique: true,\n searchable: true,\n default: 0,\n isConstantField: false\n },\n property2: {\n type: 'number',\n subtype: 'number',\n minimum: 0.1,\n maximum: 0.1,\n unique: true,\n searchable: true,\n default: 0,\n isConstantField: false\n }\n },\n required: ['string'],\n allOf: [\n {\n if: {\n required: ['string'],\n properties: {\n property1: {\n minItems: 0,\n maxItems: 0,\n uniqueItems: true,\n minimum: 0,\n maximum: 0,\n pattern: 'string',\n const: null,\n enum: ['string'],\n not: {}\n },\n property2: {\n minItems: 0,\n maxItems: 0,\n uniqueItems: true,\n minimum: 0,\n maximum: 0,\n pattern: 'string',\n const: null,\n enum: ['string'],\n not: {}\n }\n }\n },\n then: {\n required: ['string'],\n properties: {\n property1: {\n minItems: 0,\n maxItems: 0,\n uniqueItems: true,\n minimum: 0,\n maximum: 0,\n pattern: 'string',\n const: null,\n enum: ['string'],\n not: {}\n },\n property2: {\n minItems: 0,\n maxItems: 0,\n uniqueItems: true,\n minimum: 0,\n maximum: 0,\n pattern: 'string',\n const: null,\n enum: ['string'],\n not: {}\n }\n }\n },\n else: {\n required: ['string'],\n properties: {\n property1: {\n minItems: 0,\n maxItems: 0,\n uniqueItems: true,\n minimum: 0,\n maximum: 0,\n pattern: 'string',\n const: null,\n enum: ['string'],\n not: {}\n },\n property2: {\n minItems: 0,\n maxItems: 0,\n uniqueItems: true,\n minimum: 0,\n maximum: 0,\n pattern: 'string',\n const: null,\n enum: ['string'],\n not: {}\n }\n }\n }\n }\n ],\n additionalProperties: true\n },\n displayConfiguration: {\n ordering: {property1: 0, property2: 0},\n metadata: {\n property1: {title: 'empty title', description: 'string', useAsRecordName: false},\n property2: {title: 'empty title', description: 'string', useAsRecordName: false}\n }\n },\n audience: {\n targetType: 'SEGMENT',\n segments: ['497f6eca-6276-4993-bfeb-53cbbbba6f08'],\n query: '{\\\"analysis\\\":{\\\"title\\\":\\\"notempty\\\",\\\"segments\\\":[{\\\"title\\\":\\\"notempty\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"type\\\":\\\"ATTRIBUTE\\\",\\\"attribute\\\":{\\\"expressions\\\":[{\\\"constraint\\\":{\\\"type\\\":\\\"BOOL\\\",\\\"logic\\\":\\\"IS_TRUE\\\"},\\\"attribute\\\":{\\\"type\\\":\\\"PARAM\\\",\\\"param\\\":\\\"exampleBool\\\"}}]}}]}}]}}'\n },\n schemaType: 'SIMPLE',\n lambdaId: '19f4e1cf-838e-4f7d-9400-1ddf9fb6829d'\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/brickworks/v1/schemas');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"appId\":\"string\",\"displayName\":\"string\",\"description\":\"string\",\"fields\":{\"type\":\"object\",\"properties\":{\"property1\":{\"type\":\"number\",\"subtype\":\"number\",\"minimum\":0.1,\"maximum\":0.1,\"unique\":true,\"searchable\":true,\"default\":0,\"isConstantField\":false},\"property2\":{\"type\":\"number\",\"subtype\":\"number\",\"minimum\":0.1,\"maximum\":0.1,\"unique\":true,\"searchable\":true,\"default\":0,\"isConstantField\":false}},\"required\":[\"string\"],\"allOf\":[{\"if\":{\"required\":[\"string\"],\"properties\":{\"property1\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}},\"property2\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}}}},\"then\":{\"required\":[\"string\"],\"properties\":{\"property1\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}},\"property2\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}}}},\"else\":{\"required\":[\"string\"],\"properties\":{\"property1\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}},\"property2\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}}}}}],\"additionalProperties\":true},\"displayConfiguration\":{\"ordering\":{\"property1\":0,\"property2\":0},\"metadata\":{\"property1\":{\"title\":\"empty title\",\"description\":\"string\",\"useAsRecordName\":false},\"property2\":{\"title\":\"empty title\",\"description\":\"string\",\"useAsRecordName\":false}}},\"audience\":{\"targetType\":\"SEGMENT\",\"segments\":[\"497f6eca-6276-4993-bfeb-53cbbbba6f08\"],\"query\":\"{\\\\\\\\\\\\\"analysis\\\\\\\\\\\\\":{\\\\\\\\\\\\\"title\\\\\\\\\\\\\":\\\\\\\\\\\\\"notempty\\\\\\\\\\\\\",\\\\\\\\\\\\\"segments\\\\\\\\\\\\\":[{\\\\\\\\\\\\\"title\\\\\\\\\\\\\":\\\\\\\\\\\\\"notempty\\\\\\\\\\\\\",\\\\\\\\\\\\\"filter\\\\\\\\\\\\\":{\\\\\\\\\\\\\"matching\\\\\\\\\\\\\":true,\\\\\\\\\\\\\"expressions\\\\\\\\\\\\\":[{\\\\\\\\\\\\\"type\\\\\\\\\\\\\":\\\\\\\\\\\\\"ATTRIBUTE\\\\\\\\\\\\\",\\\\\\\\\\\\\"attribute\\\\\\\\\\\\\":{\\\\\\\\\\\\\"expressions\\\\\\\\\\\\\":[{\\\\\\\\\\\\\"constraint\\\\\\\\\\\\\":{\\\\\\\\\\\\\"type\\\\\\\\\\\\\":\\\\\\\\\\\\\"BOOL\\\\\\\\\\\\\",\\\\\\\\\\\\\"logic\\\\\\\\\\\\\":\\\\\\\\\\\\\"IS_TRUE\\\\\\\\\\\\\"},\\\\\\\\\\\\\"attribute\\\\\\\\\\\\\":{\\\\\\\\\\\\\"type\\\\\\\\\\\\\":\\\\\\\\\\\\\"PARAM\\\\\\\\\\\\\",\\\\\\\\\\\\\"param\\\\\\\\\\\\\":\\\\\\\\\\\\\"exampleBool\\\\\\\\\\\\\"}}]}}]}}]}}\"},\"schemaType\":\"SIMPLE\",\"lambdaId\":\"19f4e1cf-838e-4f7d-9400-1ddf9fb6829d\"}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/brickworks/v1/schemas\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"appId\\\":\\\"string\\\",\\\"displayName\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"fields\\\":{\\\"type\\\":\\\"object\\\",\\\"properties\\\":{\\\"property1\\\":{\\\"type\\\":\\\"number\\\",\\\"subtype\\\":\\\"number\\\",\\\"minimum\\\":0.1,\\\"maximum\\\":0.1,\\\"unique\\\":true,\\\"searchable\\\":true,\\\"default\\\":0,\\\"isConstantField\\\":false},\\\"property2\\\":{\\\"type\\\":\\\"number\\\",\\\"subtype\\\":\\\"number\\\",\\\"minimum\\\":0.1,\\\"maximum\\\":0.1,\\\"unique\\\":true,\\\"searchable\\\":true,\\\"default\\\":0,\\\"isConstantField\\\":false}},\\\"required\\\":[\\\"string\\\"],\\\"allOf\\\":[{\\\"if\\\":{\\\"required\\\":[\\\"string\\\"],\\\"properties\\\":{\\\"property1\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}},\\\"property2\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}}}},\\\"then\\\":{\\\"required\\\":[\\\"string\\\"],\\\"properties\\\":{\\\"property1\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}},\\\"property2\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}}}},\\\"else\\\":{\\\"required\\\":[\\\"string\\\"],\\\"properties\\\":{\\\"property1\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}},\\\"property2\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}}}}}],\\\"additionalProperties\\\":true},\\\"displayConfiguration\\\":{\\\"ordering\\\":{\\\"property1\\\":0,\\\"property2\\\":0},\\\"metadata\\\":{\\\"property1\\\":{\\\"title\\\":\\\"empty title\\\",\\\"description\\\":\\\"string\\\",\\\"useAsRecordName\\\":false},\\\"property2\\\":{\\\"title\\\":\\\"empty title\\\",\\\"description\\\":\\\"string\\\",\\\"useAsRecordName\\\":false}}},\\\"audience\\\":{\\\"targetType\\\":\\\"SEGMENT\\\",\\\"segments\\\":[\\\"497f6eca-6276-4993-bfeb-53cbbbba6f08\\\"],\\\"query\\\":\\\"{\\\\\\\\\\\\\\\"analysis\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"notempty\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"segments\\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"notempty\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"filter\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"matching\\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\\"expressions\\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"ATTRIBUTE\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"attribute\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"expressions\\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\\"constraint\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"BOOL\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"logic\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"IS_TRUE\\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\\"attribute\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"PARAM\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"param\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"exampleBool\\\\\\\\\\\\\\\"}}]}}]}}]}}\\\"},\\\"schemaType\\\":\\\"SIMPLE\\\",\\\"lambdaId\\\":\\\"19f4e1cf-838e-4f7d-9400-1ddf9fb6829d\\\"}\")\n .asString();"}]}},"/brickworks/v1/schemas/{SchemaIdentifier}":{"get":{"tags":["Brickworks: Schemas"],"summary":"Get schema","description":"Retrieve the details of a schema.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_SCHEMAS_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","operationId":"getSchemaById","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/brickworks-service-pathSchemaIdentifier"}],"responses":{"200":{"description":"Details of the schema","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-Schema"}}}},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-Schemas/operation/getSchemaById"]},"put":{"tags":["Brickworks: Schemas"],"summary":"Update schema","description":"Update a schema.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_SCHEMAS_UPDATE`\n\n**User role permission required:** `assets_brickworks: update`\n","operationId":"updateSchema","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/brickworks-service-pathSchemaIdentifier"}],"requestBody":{"description":"Schema properties to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-UpdateSchemaRequest"}}}},"responses":{"200":{"description":"Schema updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-Schema"}}}},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-Schemas/operation/updateSchema"]},"delete":{"tags":["Brickworks: Schemas"],"summary":"Delete schema","description":"Delete a schema.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_SCHEMAS_DELETE`\n\n**User role permission required:** `assets_brickworks: delete`\n","operationId":"deleteSchema","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/brickworks-service-pathSchemaIdentifier"}],"responses":{"204":{"description":"Schema deleted"},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-Schemas/operation/deleteSchema"]}},"/brickworks/v1/schemas/{SchemaIdentifier}/records":{"get":{"tags":["Brickworks: Records"],"summary":"Get records from schema","description":"Retrieve records from a schema. You can paginate, sort, and refine the results. By default, the records are sorted by status (published > scheduled > draft > unpublished) and then by last update time.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","operationId":"getRecordsFromSchema","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/brickworks-service-pathSchemaIdentifier"},{"$ref":"#/components/parameters/brickworks-service-queryLimit"},{"$ref":"#/components/parameters/brickworks-service-queryPage"},{"$ref":"#/components/parameters/brickworks-service-queryRecordFilters"},{"$ref":"#/components/parameters/brickworks-service-querySearchRecords"},{"$ref":"#/components/parameters/brickworks-service-querySortByRecords"},{"$ref":"#/components/parameters/brickworks-service-queryIds"},{"$ref":"#/components/parameters/brickworks-service-queryStatuses"},{"$ref":"#/components/parameters/brickworks-service-querySlugs"},{"$ref":"#/components/parameters/brickworks-service-queryFields"}],"responses":{"200":{"description":"A page of records","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-RecordPagingResult"}}}},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-Records/operation/getRecordsFromSchema"]},"post":{"tags":["Brickworks: Records"],"summary":"Add record to schema","description":"Add a record to a schema\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_CREATE`\n\n**User role permission required:** `assets_brickworks: create`\n","operationId":"addRecordToSchema","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/brickworks-service-pathSchemaIdentifier"}],"requestBody":{"description":"Add record to schema","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-AddRecordToSchemaRequest"}}}},"responses":{"200":{"description":"Record data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-Record"}}}},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-Records/operation/addRecordToSchema"]}},"/brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier}":{"get":{"tags":["Brickworks: Records"],"summary":"Get record","description":"Retrieve a record. You can select the fields that you want to include in the response.\n\nIf the record has multiple versions in different publishing states, the first available version is returned according to publishing status priority:\n - PUBLISHED\n - DRAFT\n - SCHEDULED\n - UNPUBLISHED\nYou can use the `statuses` parameter to limit the lookup.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","operationId":"getRecord","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/brickworks-service-pathSchemaIdentifier"},{"$ref":"#/components/parameters/brickworks-service-pathRecordIdentifier"},{"$ref":"#/components/parameters/brickworks-service-queryFields"},{"$ref":"#/components/parameters/brickworks-service-queryStatuses"}],"responses":{"200":{"description":"Details of the record","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-Record"}}}},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-Records/operation/getRecord"]},"put":{"tags":["Brickworks: Records"],"summary":"Update record","description":"Update a record.\n\nIn a versioned schema, you can't directly edit a published record. To make changes, update the status to DRAFT (you can include the other changes that you want to make). This creates a new version of the record (without modifying the currently published version), which you can edit and publish.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_UPDATE`\n\n**User role permission required:** `assets_brickworks: update`\n","operationId":"updateRecord","security":[{"JWT":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-UpdateRecordRequest"}}}},"parameters":[{"$ref":"#/components/parameters/brickworks-service-pathSchemaIdentifier"},{"$ref":"#/components/parameters/brickworks-service-pathRecordIdentifier"}],"responses":{"200":{"description":"Details of the updated record","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-Record"}}}},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-Records/operation/updateRecord"]},"delete":{"tags":["Brickworks: Records"],"summary":"Delete record","description":"Delete a record **permanently**. If you want to unpublish a record instead, send an update request to change the status to `UNPUBLISHED`\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_DELETE`\n\n**User role permission required:** `assets_brickworks: delete`\n","operationId":"deleteRecord","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/brickworks-service-pathSchemaIdentifier"},{"$ref":"#/components/parameters/brickworks-service-pathRecordIdentifier"}],"responses":{"204":{"description":"Record deleted"},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-Records/operation/deleteRecord"]}},"/brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier}/generate/by/{IdentifierType}":{"post":{"tags":["Brickworks: Content generation"],"summary":"Generate object from a record (as workspace)","description":"Generate content from the latest **published version of a record** by processing Jinjava inserts and requests to external sources. Profile data (if needed, for example for Jinjava) is retrieved automatically from the profile declared in the request.\n\nThe system looks for values to generate in the following order:\n\n 1. Values in the `fieldContext` object (used by recommendations and relations).\n 1. Values saved in the record.\n 2. Values from the `default` object in the schema. \n This is available for all field types. \n 3. Default values nested in the `properties` of a field in the schema. \n This is available for some complex field types. \n\n\nThe content is always generated according to the latest version of a schema:\n - If fields were deleted from the schema, but they still exist in the record, they are ignored.\n - If fields were added to the schema and they don't exist in the record, their default values are added. If there are no default values, the fields are ignored.\n\nSome data is cached:\n- profile data (even if the profile is updated)\n- responses from external sources \nFor details, see the [User Guide](https://hub.synerise.com/docs/assets/brickworks/limits).\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","operationId":"generateObjectForProfile","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/brickworks-service-pathSchemaIdentifier"},{"$ref":"#/components/parameters/brickworks-service-pathRecordIdentifier"},{"$ref":"#/components/parameters/brickworks-service-pathIdentifierType"}],"requestBody":{"description":"Object generation request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-GenerateRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/brickworks-service-GeneratedObject"},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-Content-generation/operation/generateObjectForProfile"]}},"/brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier}/generate":{"post":{"tags":["Brickworks: Content generation"],"summary":"Generate object from a record (as any consumer)","description":"Generate content from the latest **published version of a record** by processing Jinjava inserts and requests to external sources. \nIf the request is authorized by a profile, the profile data is automatically retrieve for fields which need it (for example, in Jinjava inserts).\n\nThe system looks for values to generate in the following order:\n\n 1. Values in the `fieldContext` object (used by recommendations and relations).\n 1. Values saved in the record.\n 2. Values from the `default` object in the schema. \n This is available for all field types. \n 3. Default values nested in the `properties` of a field in the schema. \n This is available for some complex field types. \n\n\nThe content is always generated according to the latest version of a schema:\n - If fields were deleted from the schema, but they still exist in the record, they are ignored.\n - If fields were added to the schema and they don't exist in the record, their default values are added. If there are no default values, the fields are ignored.\n\nSome data is cached:\n- profile data (even if the profile is updated)\n- responses from external sources \nFor details, see the [User Guide](https://hub.synerise.com/docs/assets/brickworks/limits).\n\n\n---\n\n**API consumers:** Profile (Client), Anonymous Profile, Workspace (Business Profile), Synerise User\n\n**API key permission required:** `BRICKWORKS_RECORDS_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","operationId":"generateObject","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/brickworks-service-pathSchemaIdentifier"},{"$ref":"#/components/parameters/brickworks-service-pathRecordIdentifier"}],"requestBody":{"description":"Object generation request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-GenerateRequestWithoutIdentifier"}}}},"responses":{"200":{"$ref":"#/components/responses/brickworks-service-GeneratedObject"},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-Content-generation/operation/generateObject"]}},"/brickworks/v1/schemas/records/preview/by/{IdentifierType}":{"post":{"tags":["Brickworks: Records"],"summary":"Preview object (as workspace)","description":"Preview an object by sending field values. \n\nWhen generating a preview, fields are only generated when you send their value or they have a default value. Values saved in the record are not used in the preview.\n\nSome data is cached:\n- profile data (even if the profile is updated)\n- responses from external sources \nFor details, see the [User Guide](https://hub.synerise.com/docs/assets/brickworks/limits).\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","operationId":"previewObject","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/brickworks-service-pathIdentifierType"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-PreviewRequest"}}}},"responses":{"200":{"description":"Generated JSON","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-GeneratedObject"}}}},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-Records/operation/previewObject"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/brickworks/v1/schemas/records/preview/by/%7BIdentifierType%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"identifierValue\":\"string\",\"context\":{\"property1\":null,\"property2\":null},\"fieldContext\":{\"property1\":{\"page\":1,\"limit\":10,\"itemId\":\"item-123\",\"additionalFilters\":\"custom filter value\"},\"property2\":{\"page\":1,\"limit\":10,\"itemId\":\"item-123\",\"additionalFilters\":\"custom filter value\"}},\"values\":{\"property1\":null,\"property2\":null},\"schema\":{\"fields\":{\"type\":\"object\",\"properties\":{\"property1\":{\"type\":\"number\",\"subtype\":\"number\",\"minimum\":0.1,\"maximum\":0.1,\"unique\":true,\"searchable\":true,\"default\":0,\"isConstantField\":false},\"property2\":{\"type\":\"number\",\"subtype\":\"number\",\"minimum\":0.1,\"maximum\":0.1,\"unique\":true,\"searchable\":true,\"default\":0,\"isConstantField\":false}},\"required\":[\"string\"],\"allOf\":[{\"if\":{\"required\":[\"string\"],\"properties\":{\"property1\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}},\"property2\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}}}},\"then\":{\"required\":[\"string\"],\"properties\":{\"property1\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}},\"property2\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}}}},\"else\":{\"required\":[\"string\"],\"properties\":{\"property1\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}},\"property2\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}}}}}],\"additionalProperties\":true},\"audience\":{\"targetType\":\"SEGMENT\",\"segments\":[\"497f6eca-6276-4993-bfeb-53cbbbba6f08\"],\"query\":\"{\\\\\\\"analysis\\\\\\\":{\\\\\\\"title\\\\\\\":\\\\\\\"notempty\\\\\\\",\\\\\\\"segments\\\\\\\":[{\\\\\\\"title\\\\\\\":\\\\\\\"notempty\\\\\\\",\\\\\\\"filter\\\\\\\":{\\\\\\\"matching\\\\\\\":true,\\\\\\\"expressions\\\\\\\":[{\\\\\\\"type\\\\\\\":\\\\\\\"ATTRIBUTE\\\\\\\",\\\\\\\"attribute\\\\\\\":{\\\\\\\"expressions\\\\\\\":[{\\\\\\\"constraint\\\\\\\":{\\\\\\\"type\\\\\\\":\\\\\\\"BOOL\\\\\\\",\\\\\\\"logic\\\\\\\":\\\\\\\"IS_TRUE\\\\\\\"},\\\\\\\"attribute\\\\\\\":{\\\\\\\"type\\\\\\\":\\\\\\\"PARAM\\\\\\\",\\\\\\\"param\\\\\\\":\\\\\\\"exampleBool\\\\\\\"}}]}}]}}]}}\"},\"schemaType\":\"SIMPLE\",\"lambdaId\":\"19f4e1cf-838e-4f7d-9400-1ddf9fb6829d\",\"id\":\"497f6eca-6276-4993-bfeb-53cbbbba6f08\"}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"identifierValue\\\":\\\"string\\\",\\\"context\\\":{\\\"property1\\\":null,\\\"property2\\\":null},\\\"fieldContext\\\":{\\\"property1\\\":{\\\"page\\\":1,\\\"limit\\\":10,\\\"itemId\\\":\\\"item-123\\\",\\\"additionalFilters\\\":\\\"custom filter value\\\"},\\\"property2\\\":{\\\"page\\\":1,\\\"limit\\\":10,\\\"itemId\\\":\\\"item-123\\\",\\\"additionalFilters\\\":\\\"custom filter value\\\"}},\\\"values\\\":{\\\"property1\\\":null,\\\"property2\\\":null},\\\"schema\\\":{\\\"fields\\\":{\\\"type\\\":\\\"object\\\",\\\"properties\\\":{\\\"property1\\\":{\\\"type\\\":\\\"number\\\",\\\"subtype\\\":\\\"number\\\",\\\"minimum\\\":0.1,\\\"maximum\\\":0.1,\\\"unique\\\":true,\\\"searchable\\\":true,\\\"default\\\":0,\\\"isConstantField\\\":false},\\\"property2\\\":{\\\"type\\\":\\\"number\\\",\\\"subtype\\\":\\\"number\\\",\\\"minimum\\\":0.1,\\\"maximum\\\":0.1,\\\"unique\\\":true,\\\"searchable\\\":true,\\\"default\\\":0,\\\"isConstantField\\\":false}},\\\"required\\\":[\\\"string\\\"],\\\"allOf\\\":[{\\\"if\\\":{\\\"required\\\":[\\\"string\\\"],\\\"properties\\\":{\\\"property1\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}},\\\"property2\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}}}},\\\"then\\\":{\\\"required\\\":[\\\"string\\\"],\\\"properties\\\":{\\\"property1\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}},\\\"property2\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}}}},\\\"else\\\":{\\\"required\\\":[\\\"string\\\"],\\\"properties\\\":{\\\"property1\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}},\\\"property2\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}}}}}],\\\"additionalProperties\\\":true},\\\"audience\\\":{\\\"targetType\\\":\\\"SEGMENT\\\",\\\"segments\\\":[\\\"497f6eca-6276-4993-bfeb-53cbbbba6f08\\\"],\\\"query\\\":\\\"{\\\\\\\\\\\\\\\"analysis\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"notempty\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"segments\\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"notempty\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"filter\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"matching\\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\\"expressions\\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"ATTRIBUTE\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"attribute\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"expressions\\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\\"constraint\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"BOOL\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"logic\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"IS_TRUE\\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\\"attribute\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"PARAM\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"param\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"exampleBool\\\\\\\\\\\\\\\"}}]}}]}}]}}\\\"},\\\"schemaType\\\":\\\"SIMPLE\\\",\\\"lambdaId\\\":\\\"19f4e1cf-838e-4f7d-9400-1ddf9fb6829d\\\",\\\"id\\\":\\\"497f6eca-6276-4993-bfeb-53cbbbba6f08\\\"}}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/brickworks/v1/schemas/records/preview/by/%7BIdentifierType%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"identifierValue\": \"string\",\n \"context\": {\n \"property1\": null,\n \"property2\": null\n },\n \"fieldContext\": {\n \"property1\": {\n \"page\": 1,\n \"limit\": 10,\n \"itemId\": \"item-123\",\n \"additionalFilters\": \"custom filter value\"\n },\n \"property2\": {\n \"page\": 1,\n \"limit\": 10,\n \"itemId\": \"item-123\",\n \"additionalFilters\": \"custom filter value\"\n }\n },\n \"values\": {\n \"property1\": null,\n \"property2\": null\n },\n \"schema\": {\n \"fields\": {\n \"type\": \"object\",\n \"properties\": {\n \"property1\": {\n \"type\": \"number\",\n \"subtype\": \"number\",\n \"minimum\": 0.1,\n \"maximum\": 0.1,\n \"unique\": true,\n \"searchable\": true,\n \"default\": 0,\n \"isConstantField\": false\n },\n \"property2\": {\n \"type\": \"number\",\n \"subtype\": \"number\",\n \"minimum\": 0.1,\n \"maximum\": 0.1,\n \"unique\": true,\n \"searchable\": true,\n \"default\": 0,\n \"isConstantField\": false\n }\n },\n \"required\": [\n \"string\"\n ],\n \"allOf\": [\n {\n \"if\": {\n \"required\": [\n \"string\"\n ],\n \"properties\": {\n \"property1\": {\n \"minItems\": 0,\n \"maxItems\": 0,\n \"uniqueItems\": true,\n \"minimum\": 0,\n \"maximum\": 0,\n \"pattern\": \"string\",\n \"const\": null,\n \"enum\": [\n \"string\"\n ],\n \"not\": {}\n },\n \"property2\": {\n \"minItems\": 0,\n \"maxItems\": 0,\n \"uniqueItems\": true,\n \"minimum\": 0,\n \"maximum\": 0,\n \"pattern\": \"string\",\n \"const\": null,\n \"enum\": [\n \"string\"\n ],\n \"not\": {}\n }\n }\n },\n \"then\": {\n \"required\": [\n \"string\"\n ],\n \"properties\": {\n \"property1\": {\n \"minItems\": 0,\n \"maxItems\": 0,\n \"uniqueItems\": true,\n \"minimum\": 0,\n \"maximum\": 0,\n \"pattern\": \"string\",\n \"const\": null,\n \"enum\": [\n \"string\"\n ],\n \"not\": {}\n },\n \"property2\": {\n \"minItems\": 0,\n \"maxItems\": 0,\n \"uniqueItems\": true,\n \"minimum\": 0,\n \"maximum\": 0,\n \"pattern\": \"string\",\n \"const\": null,\n \"enum\": [\n \"string\"\n ],\n \"not\": {}\n }\n }\n },\n \"else\": {\n \"required\": [\n \"string\"\n ],\n \"properties\": {\n \"property1\": {\n \"minItems\": 0,\n \"maxItems\": 0,\n \"uniqueItems\": true,\n \"minimum\": 0,\n \"maximum\": 0,\n \"pattern\": \"string\",\n \"const\": null,\n \"enum\": [\n \"string\"\n ],\n \"not\": {}\n },\n \"property2\": {\n \"minItems\": 0,\n \"maxItems\": 0,\n \"uniqueItems\": true,\n \"minimum\": 0,\n \"maximum\": 0,\n \"pattern\": \"string\",\n \"const\": null,\n \"enum\": [\n \"string\"\n ],\n \"not\": {}\n }\n }\n }\n }\n ],\n \"additionalProperties\": true\n },\n \"audience\": {\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n ],\n \"query\": \"{\\\\\\\"analysis\\\\\\\":{\\\\\\\"title\\\\\\\":\\\\\\\"notempty\\\\\\\",\\\\\\\"segments\\\\\\\":[{\\\\\\\"title\\\\\\\":\\\\\\\"notempty\\\\\\\",\\\\\\\"filter\\\\\\\":{\\\\\\\"matching\\\\\\\":true,\\\\\\\"expressions\\\\\\\":[{\\\\\\\"type\\\\\\\":\\\\\\\"ATTRIBUTE\\\\\\\",\\\\\\\"attribute\\\\\\\":{\\\\\\\"expressions\\\\\\\":[{\\\\\\\"constraint\\\\\\\":{\\\\\\\"type\\\\\\\":\\\\\\\"BOOL\\\\\\\",\\\\\\\"logic\\\\\\\":\\\\\\\"IS_TRUE\\\\\\\"},\\\\\\\"attribute\\\\\\\":{\\\\\\\"type\\\\\\\":\\\\\\\"PARAM\\\\\\\",\\\\\\\"param\\\\\\\":\\\\\\\"exampleBool\\\\\\\"}}]}}]}}]}}\"\n },\n \"schemaType\": \"SIMPLE\",\n \"lambdaId\": \"19f4e1cf-838e-4f7d-9400-1ddf9fb6829d\",\n \"id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/brickworks/v1/schemas/records/preview/by/%7BIdentifierType%7D\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/brickworks/v1/schemas/records/preview/by/%7BIdentifierType%7D\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n identifierValue: 'string',\n context: {property1: null, property2: null},\n fieldContext: {\n property1: {\n page: 1,\n limit: 10,\n itemId: 'item-123',\n additionalFilters: 'custom filter value'\n },\n property2: {\n page: 1,\n limit: 10,\n itemId: 'item-123',\n additionalFilters: 'custom filter value'\n }\n },\n values: {property1: null, property2: null},\n schema: {\n fields: {\n type: 'object',\n properties: {\n property1: {\n type: 'number',\n subtype: 'number',\n minimum: 0.1,\n maximum: 0.1,\n unique: true,\n searchable: true,\n default: 0,\n isConstantField: false\n },\n property2: {\n type: 'number',\n subtype: 'number',\n minimum: 0.1,\n maximum: 0.1,\n unique: true,\n searchable: true,\n default: 0,\n isConstantField: false\n }\n },\n required: ['string'],\n allOf: [\n {\n if: {\n required: ['string'],\n properties: {\n property1: {\n minItems: 0,\n maxItems: 0,\n uniqueItems: true,\n minimum: 0,\n maximum: 0,\n pattern: 'string',\n const: null,\n enum: ['string'],\n not: {}\n },\n property2: {\n minItems: 0,\n maxItems: 0,\n uniqueItems: true,\n minimum: 0,\n maximum: 0,\n pattern: 'string',\n const: null,\n enum: ['string'],\n not: {}\n }\n }\n },\n then: {\n required: ['string'],\n properties: {\n property1: {\n minItems: 0,\n maxItems: 0,\n uniqueItems: true,\n minimum: 0,\n maximum: 0,\n pattern: 'string',\n const: null,\n enum: ['string'],\n not: {}\n },\n property2: {\n minItems: 0,\n maxItems: 0,\n uniqueItems: true,\n minimum: 0,\n maximum: 0,\n pattern: 'string',\n const: null,\n enum: ['string'],\n not: {}\n }\n }\n },\n else: {\n required: ['string'],\n properties: {\n property1: {\n minItems: 0,\n maxItems: 0,\n uniqueItems: true,\n minimum: 0,\n maximum: 0,\n pattern: 'string',\n const: null,\n enum: ['string'],\n not: {}\n },\n property2: {\n minItems: 0,\n maxItems: 0,\n uniqueItems: true,\n minimum: 0,\n maximum: 0,\n pattern: 'string',\n const: null,\n enum: ['string'],\n not: {}\n }\n }\n }\n }\n ],\n additionalProperties: true\n },\n audience: {\n targetType: 'SEGMENT',\n segments: ['497f6eca-6276-4993-bfeb-53cbbbba6f08'],\n query: '{\\\"analysis\\\":{\\\"title\\\":\\\"notempty\\\",\\\"segments\\\":[{\\\"title\\\":\\\"notempty\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"type\\\":\\\"ATTRIBUTE\\\",\\\"attribute\\\":{\\\"expressions\\\":[{\\\"constraint\\\":{\\\"type\\\":\\\"BOOL\\\",\\\"logic\\\":\\\"IS_TRUE\\\"},\\\"attribute\\\":{\\\"type\\\":\\\"PARAM\\\",\\\"param\\\":\\\"exampleBool\\\"}}]}}]}}]}}'\n },\n schemaType: 'SIMPLE',\n lambdaId: '19f4e1cf-838e-4f7d-9400-1ddf9fb6829d',\n id: '497f6eca-6276-4993-bfeb-53cbbbba6f08'\n }\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/brickworks/v1/schemas/records/preview/by/%7BIdentifierType%7D');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"identifierValue\":\"string\",\"context\":{\"property1\":null,\"property2\":null},\"fieldContext\":{\"property1\":{\"page\":1,\"limit\":10,\"itemId\":\"item-123\",\"additionalFilters\":\"custom filter value\"},\"property2\":{\"page\":1,\"limit\":10,\"itemId\":\"item-123\",\"additionalFilters\":\"custom filter value\"}},\"values\":{\"property1\":null,\"property2\":null},\"schema\":{\"fields\":{\"type\":\"object\",\"properties\":{\"property1\":{\"type\":\"number\",\"subtype\":\"number\",\"minimum\":0.1,\"maximum\":0.1,\"unique\":true,\"searchable\":true,\"default\":0,\"isConstantField\":false},\"property2\":{\"type\":\"number\",\"subtype\":\"number\",\"minimum\":0.1,\"maximum\":0.1,\"unique\":true,\"searchable\":true,\"default\":0,\"isConstantField\":false}},\"required\":[\"string\"],\"allOf\":[{\"if\":{\"required\":[\"string\"],\"properties\":{\"property1\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}},\"property2\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}}}},\"then\":{\"required\":[\"string\"],\"properties\":{\"property1\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}},\"property2\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}}}},\"else\":{\"required\":[\"string\"],\"properties\":{\"property1\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}},\"property2\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}}}}}],\"additionalProperties\":true},\"audience\":{\"targetType\":\"SEGMENT\",\"segments\":[\"497f6eca-6276-4993-bfeb-53cbbbba6f08\"],\"query\":\"{\\\\\\\\\\\\\"analysis\\\\\\\\\\\\\":{\\\\\\\\\\\\\"title\\\\\\\\\\\\\":\\\\\\\\\\\\\"notempty\\\\\\\\\\\\\",\\\\\\\\\\\\\"segments\\\\\\\\\\\\\":[{\\\\\\\\\\\\\"title\\\\\\\\\\\\\":\\\\\\\\\\\\\"notempty\\\\\\\\\\\\\",\\\\\\\\\\\\\"filter\\\\\\\\\\\\\":{\\\\\\\\\\\\\"matching\\\\\\\\\\\\\":true,\\\\\\\\\\\\\"expressions\\\\\\\\\\\\\":[{\\\\\\\\\\\\\"type\\\\\\\\\\\\\":\\\\\\\\\\\\\"ATTRIBUTE\\\\\\\\\\\\\",\\\\\\\\\\\\\"attribute\\\\\\\\\\\\\":{\\\\\\\\\\\\\"expressions\\\\\\\\\\\\\":[{\\\\\\\\\\\\\"constraint\\\\\\\\\\\\\":{\\\\\\\\\\\\\"type\\\\\\\\\\\\\":\\\\\\\\\\\\\"BOOL\\\\\\\\\\\\\",\\\\\\\\\\\\\"logic\\\\\\\\\\\\\":\\\\\\\\\\\\\"IS_TRUE\\\\\\\\\\\\\"},\\\\\\\\\\\\\"attribute\\\\\\\\\\\\\":{\\\\\\\\\\\\\"type\\\\\\\\\\\\\":\\\\\\\\\\\\\"PARAM\\\\\\\\\\\\\",\\\\\\\\\\\\\"param\\\\\\\\\\\\\":\\\\\\\\\\\\\"exampleBool\\\\\\\\\\\\\"}}]}}]}}]}}\"},\"schemaType\":\"SIMPLE\",\"lambdaId\":\"19f4e1cf-838e-4f7d-9400-1ddf9fb6829d\",\"id\":\"497f6eca-6276-4993-bfeb-53cbbbba6f08\"}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/brickworks/v1/schemas/records/preview/by/%7BIdentifierType%7D\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"identifierValue\\\":\\\"string\\\",\\\"context\\\":{\\\"property1\\\":null,\\\"property2\\\":null},\\\"fieldContext\\\":{\\\"property1\\\":{\\\"page\\\":1,\\\"limit\\\":10,\\\"itemId\\\":\\\"item-123\\\",\\\"additionalFilters\\\":\\\"custom filter value\\\"},\\\"property2\\\":{\\\"page\\\":1,\\\"limit\\\":10,\\\"itemId\\\":\\\"item-123\\\",\\\"additionalFilters\\\":\\\"custom filter value\\\"}},\\\"values\\\":{\\\"property1\\\":null,\\\"property2\\\":null},\\\"schema\\\":{\\\"fields\\\":{\\\"type\\\":\\\"object\\\",\\\"properties\\\":{\\\"property1\\\":{\\\"type\\\":\\\"number\\\",\\\"subtype\\\":\\\"number\\\",\\\"minimum\\\":0.1,\\\"maximum\\\":0.1,\\\"unique\\\":true,\\\"searchable\\\":true,\\\"default\\\":0,\\\"isConstantField\\\":false},\\\"property2\\\":{\\\"type\\\":\\\"number\\\",\\\"subtype\\\":\\\"number\\\",\\\"minimum\\\":0.1,\\\"maximum\\\":0.1,\\\"unique\\\":true,\\\"searchable\\\":true,\\\"default\\\":0,\\\"isConstantField\\\":false}},\\\"required\\\":[\\\"string\\\"],\\\"allOf\\\":[{\\\"if\\\":{\\\"required\\\":[\\\"string\\\"],\\\"properties\\\":{\\\"property1\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}},\\\"property2\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}}}},\\\"then\\\":{\\\"required\\\":[\\\"string\\\"],\\\"properties\\\":{\\\"property1\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}},\\\"property2\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}}}},\\\"else\\\":{\\\"required\\\":[\\\"string\\\"],\\\"properties\\\":{\\\"property1\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}},\\\"property2\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}}}}}],\\\"additionalProperties\\\":true},\\\"audience\\\":{\\\"targetType\\\":\\\"SEGMENT\\\",\\\"segments\\\":[\\\"497f6eca-6276-4993-bfeb-53cbbbba6f08\\\"],\\\"query\\\":\\\"{\\\\\\\\\\\\\\\"analysis\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"notempty\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"segments\\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"notempty\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"filter\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"matching\\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\\"expressions\\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"ATTRIBUTE\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"attribute\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"expressions\\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\\"constraint\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"BOOL\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"logic\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"IS_TRUE\\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\\"attribute\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"PARAM\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"param\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"exampleBool\\\\\\\\\\\\\\\"}}]}}]}}]}}\\\"},\\\"schemaType\\\":\\\"SIMPLE\\\",\\\"lambdaId\\\":\\\"19f4e1cf-838e-4f7d-9400-1ddf9fb6829d\\\",\\\"id\\\":\\\"497f6eca-6276-4993-bfeb-53cbbbba6f08\\\"}}\")\n .asString();"}]}},"/brickworks/v1/schemas/records/preview":{"post":{"tags":["Brickworks: Records"],"summary":"Preview object (as any consumer)","description":"Preview an object by sending field values. \n\nWhen generating a preview, fields are only generated when you send their value or they have a default value. Values saved in the record are not used in the preview.\n\nSome data is cached:\n- profile data (even if the profile is updated)\n- responses from external sources \nFor details, see the [User Guide](https://hub.synerise.com/docs/assets/brickworks/limits).\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile), Profile (Client), Anonymous Profile\n\n**API key permission required:** `BRICKWORKS_RECORDS_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","operationId":"previewObjectByProfile","security":[{"JWT":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-PreviewRequestWithoutIdentifier"}}}},"responses":{"200":{"description":"Generated JSON","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-GeneratedObject"}}}},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-Records/operation/previewObjectByProfile"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/brickworks/v1/schemas/records/preview \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"context\":{\"property1\":null,\"property2\":null},\"fieldContext\":{\"property1\":{\"page\":1,\"limit\":10,\"itemId\":\"item-123\",\"additionalFilters\":\"custom filter value\"},\"property2\":{\"page\":1,\"limit\":10,\"itemId\":\"item-123\",\"additionalFilters\":\"custom filter value\"}},\"values\":{\"property1\":null,\"property2\":null},\"schema\":{\"fields\":{\"type\":\"object\",\"properties\":{\"property1\":{\"type\":\"number\",\"subtype\":\"number\",\"minimum\":0.1,\"maximum\":0.1,\"unique\":true,\"searchable\":true,\"default\":0,\"isConstantField\":false},\"property2\":{\"type\":\"number\",\"subtype\":\"number\",\"minimum\":0.1,\"maximum\":0.1,\"unique\":true,\"searchable\":true,\"default\":0,\"isConstantField\":false}},\"required\":[\"string\"],\"allOf\":[{\"if\":{\"required\":[\"string\"],\"properties\":{\"property1\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}},\"property2\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}}}},\"then\":{\"required\":[\"string\"],\"properties\":{\"property1\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}},\"property2\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}}}},\"else\":{\"required\":[\"string\"],\"properties\":{\"property1\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}},\"property2\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}}}}}],\"additionalProperties\":true},\"audience\":{\"targetType\":\"SEGMENT\",\"segments\":[\"497f6eca-6276-4993-bfeb-53cbbbba6f08\"],\"query\":\"{\\\\\\\"analysis\\\\\\\":{\\\\\\\"title\\\\\\\":\\\\\\\"notempty\\\\\\\",\\\\\\\"segments\\\\\\\":[{\\\\\\\"title\\\\\\\":\\\\\\\"notempty\\\\\\\",\\\\\\\"filter\\\\\\\":{\\\\\\\"matching\\\\\\\":true,\\\\\\\"expressions\\\\\\\":[{\\\\\\\"type\\\\\\\":\\\\\\\"ATTRIBUTE\\\\\\\",\\\\\\\"attribute\\\\\\\":{\\\\\\\"expressions\\\\\\\":[{\\\\\\\"constraint\\\\\\\":{\\\\\\\"type\\\\\\\":\\\\\\\"BOOL\\\\\\\",\\\\\\\"logic\\\\\\\":\\\\\\\"IS_TRUE\\\\\\\"},\\\\\\\"attribute\\\\\\\":{\\\\\\\"type\\\\\\\":\\\\\\\"PARAM\\\\\\\",\\\\\\\"param\\\\\\\":\\\\\\\"exampleBool\\\\\\\"}}]}}]}}]}}\"},\"schemaType\":\"SIMPLE\",\"lambdaId\":\"19f4e1cf-838e-4f7d-9400-1ddf9fb6829d\",\"id\":\"497f6eca-6276-4993-bfeb-53cbbbba6f08\"},\"lambdaId\":\"19f4e1cf-838e-4f7d-9400-1ddf9fb6829d\"}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"context\\\":{\\\"property1\\\":null,\\\"property2\\\":null},\\\"fieldContext\\\":{\\\"property1\\\":{\\\"page\\\":1,\\\"limit\\\":10,\\\"itemId\\\":\\\"item-123\\\",\\\"additionalFilters\\\":\\\"custom filter value\\\"},\\\"property2\\\":{\\\"page\\\":1,\\\"limit\\\":10,\\\"itemId\\\":\\\"item-123\\\",\\\"additionalFilters\\\":\\\"custom filter value\\\"}},\\\"values\\\":{\\\"property1\\\":null,\\\"property2\\\":null},\\\"schema\\\":{\\\"fields\\\":{\\\"type\\\":\\\"object\\\",\\\"properties\\\":{\\\"property1\\\":{\\\"type\\\":\\\"number\\\",\\\"subtype\\\":\\\"number\\\",\\\"minimum\\\":0.1,\\\"maximum\\\":0.1,\\\"unique\\\":true,\\\"searchable\\\":true,\\\"default\\\":0,\\\"isConstantField\\\":false},\\\"property2\\\":{\\\"type\\\":\\\"number\\\",\\\"subtype\\\":\\\"number\\\",\\\"minimum\\\":0.1,\\\"maximum\\\":0.1,\\\"unique\\\":true,\\\"searchable\\\":true,\\\"default\\\":0,\\\"isConstantField\\\":false}},\\\"required\\\":[\\\"string\\\"],\\\"allOf\\\":[{\\\"if\\\":{\\\"required\\\":[\\\"string\\\"],\\\"properties\\\":{\\\"property1\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}},\\\"property2\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}}}},\\\"then\\\":{\\\"required\\\":[\\\"string\\\"],\\\"properties\\\":{\\\"property1\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}},\\\"property2\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}}}},\\\"else\\\":{\\\"required\\\":[\\\"string\\\"],\\\"properties\\\":{\\\"property1\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}},\\\"property2\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}}}}}],\\\"additionalProperties\\\":true},\\\"audience\\\":{\\\"targetType\\\":\\\"SEGMENT\\\",\\\"segments\\\":[\\\"497f6eca-6276-4993-bfeb-53cbbbba6f08\\\"],\\\"query\\\":\\\"{\\\\\\\\\\\\\\\"analysis\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"notempty\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"segments\\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"notempty\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"filter\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"matching\\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\\"expressions\\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"ATTRIBUTE\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"attribute\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"expressions\\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\\"constraint\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"BOOL\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"logic\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"IS_TRUE\\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\\"attribute\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"PARAM\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"param\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"exampleBool\\\\\\\\\\\\\\\"}}]}}]}}]}}\\\"},\\\"schemaType\\\":\\\"SIMPLE\\\",\\\"lambdaId\\\":\\\"19f4e1cf-838e-4f7d-9400-1ddf9fb6829d\\\",\\\"id\\\":\\\"497f6eca-6276-4993-bfeb-53cbbbba6f08\\\"},\\\"lambdaId\\\":\\\"19f4e1cf-838e-4f7d-9400-1ddf9fb6829d\\\"}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/brickworks/v1/schemas/records/preview\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"context\": {\n \"property1\": null,\n \"property2\": null\n },\n \"fieldContext\": {\n \"property1\": {\n \"page\": 1,\n \"limit\": 10,\n \"itemId\": \"item-123\",\n \"additionalFilters\": \"custom filter value\"\n },\n \"property2\": {\n \"page\": 1,\n \"limit\": 10,\n \"itemId\": \"item-123\",\n \"additionalFilters\": \"custom filter value\"\n }\n },\n \"values\": {\n \"property1\": null,\n \"property2\": null\n },\n \"schema\": {\n \"fields\": {\n \"type\": \"object\",\n \"properties\": {\n \"property1\": {\n \"type\": \"number\",\n \"subtype\": \"number\",\n \"minimum\": 0.1,\n \"maximum\": 0.1,\n \"unique\": true,\n \"searchable\": true,\n \"default\": 0,\n \"isConstantField\": false\n },\n \"property2\": {\n \"type\": \"number\",\n \"subtype\": \"number\",\n \"minimum\": 0.1,\n \"maximum\": 0.1,\n \"unique\": true,\n \"searchable\": true,\n \"default\": 0,\n \"isConstantField\": false\n }\n },\n \"required\": [\n \"string\"\n ],\n \"allOf\": [\n {\n \"if\": {\n \"required\": [\n \"string\"\n ],\n \"properties\": {\n \"property1\": {\n \"minItems\": 0,\n \"maxItems\": 0,\n \"uniqueItems\": true,\n \"minimum\": 0,\n \"maximum\": 0,\n \"pattern\": \"string\",\n \"const\": null,\n \"enum\": [\n \"string\"\n ],\n \"not\": {}\n },\n \"property2\": {\n \"minItems\": 0,\n \"maxItems\": 0,\n \"uniqueItems\": true,\n \"minimum\": 0,\n \"maximum\": 0,\n \"pattern\": \"string\",\n \"const\": null,\n \"enum\": [\n \"string\"\n ],\n \"not\": {}\n }\n }\n },\n \"then\": {\n \"required\": [\n \"string\"\n ],\n \"properties\": {\n \"property1\": {\n \"minItems\": 0,\n \"maxItems\": 0,\n \"uniqueItems\": true,\n \"minimum\": 0,\n \"maximum\": 0,\n \"pattern\": \"string\",\n \"const\": null,\n \"enum\": [\n \"string\"\n ],\n \"not\": {}\n },\n \"property2\": {\n \"minItems\": 0,\n \"maxItems\": 0,\n \"uniqueItems\": true,\n \"minimum\": 0,\n \"maximum\": 0,\n \"pattern\": \"string\",\n \"const\": null,\n \"enum\": [\n \"string\"\n ],\n \"not\": {}\n }\n }\n },\n \"else\": {\n \"required\": [\n \"string\"\n ],\n \"properties\": {\n \"property1\": {\n \"minItems\": 0,\n \"maxItems\": 0,\n \"uniqueItems\": true,\n \"minimum\": 0,\n \"maximum\": 0,\n \"pattern\": \"string\",\n \"const\": null,\n \"enum\": [\n \"string\"\n ],\n \"not\": {}\n },\n \"property2\": {\n \"minItems\": 0,\n \"maxItems\": 0,\n \"uniqueItems\": true,\n \"minimum\": 0,\n \"maximum\": 0,\n \"pattern\": \"string\",\n \"const\": null,\n \"enum\": [\n \"string\"\n ],\n \"not\": {}\n }\n }\n }\n }\n ],\n \"additionalProperties\": true\n },\n \"audience\": {\n \"targetType\": \"SEGMENT\",\n \"segments\": [\n \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n ],\n \"query\": \"{\\\\\\\"analysis\\\\\\\":{\\\\\\\"title\\\\\\\":\\\\\\\"notempty\\\\\\\",\\\\\\\"segments\\\\\\\":[{\\\\\\\"title\\\\\\\":\\\\\\\"notempty\\\\\\\",\\\\\\\"filter\\\\\\\":{\\\\\\\"matching\\\\\\\":true,\\\\\\\"expressions\\\\\\\":[{\\\\\\\"type\\\\\\\":\\\\\\\"ATTRIBUTE\\\\\\\",\\\\\\\"attribute\\\\\\\":{\\\\\\\"expressions\\\\\\\":[{\\\\\\\"constraint\\\\\\\":{\\\\\\\"type\\\\\\\":\\\\\\\"BOOL\\\\\\\",\\\\\\\"logic\\\\\\\":\\\\\\\"IS_TRUE\\\\\\\"},\\\\\\\"attribute\\\\\\\":{\\\\\\\"type\\\\\\\":\\\\\\\"PARAM\\\\\\\",\\\\\\\"param\\\\\\\":\\\\\\\"exampleBool\\\\\\\"}}]}}]}}]}}\"\n },\n \"schemaType\": \"SIMPLE\",\n \"lambdaId\": \"19f4e1cf-838e-4f7d-9400-1ddf9fb6829d\",\n \"id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n },\n \"lambdaId\": \"19f4e1cf-838e-4f7d-9400-1ddf9fb6829d\"\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/brickworks/v1/schemas/records/preview\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/brickworks/v1/schemas/records/preview\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n context: {property1: null, property2: null},\n fieldContext: {\n property1: {\n page: 1,\n limit: 10,\n itemId: 'item-123',\n additionalFilters: 'custom filter value'\n },\n property2: {\n page: 1,\n limit: 10,\n itemId: 'item-123',\n additionalFilters: 'custom filter value'\n }\n },\n values: {property1: null, property2: null},\n schema: {\n fields: {\n type: 'object',\n properties: {\n property1: {\n type: 'number',\n subtype: 'number',\n minimum: 0.1,\n maximum: 0.1,\n unique: true,\n searchable: true,\n default: 0,\n isConstantField: false\n },\n property2: {\n type: 'number',\n subtype: 'number',\n minimum: 0.1,\n maximum: 0.1,\n unique: true,\n searchable: true,\n default: 0,\n isConstantField: false\n }\n },\n required: ['string'],\n allOf: [\n {\n if: {\n required: ['string'],\n properties: {\n property1: {\n minItems: 0,\n maxItems: 0,\n uniqueItems: true,\n minimum: 0,\n maximum: 0,\n pattern: 'string',\n const: null,\n enum: ['string'],\n not: {}\n },\n property2: {\n minItems: 0,\n maxItems: 0,\n uniqueItems: true,\n minimum: 0,\n maximum: 0,\n pattern: 'string',\n const: null,\n enum: ['string'],\n not: {}\n }\n }\n },\n then: {\n required: ['string'],\n properties: {\n property1: {\n minItems: 0,\n maxItems: 0,\n uniqueItems: true,\n minimum: 0,\n maximum: 0,\n pattern: 'string',\n const: null,\n enum: ['string'],\n not: {}\n },\n property2: {\n minItems: 0,\n maxItems: 0,\n uniqueItems: true,\n minimum: 0,\n maximum: 0,\n pattern: 'string',\n const: null,\n enum: ['string'],\n not: {}\n }\n }\n },\n else: {\n required: ['string'],\n properties: {\n property1: {\n minItems: 0,\n maxItems: 0,\n uniqueItems: true,\n minimum: 0,\n maximum: 0,\n pattern: 'string',\n const: null,\n enum: ['string'],\n not: {}\n },\n property2: {\n minItems: 0,\n maxItems: 0,\n uniqueItems: true,\n minimum: 0,\n maximum: 0,\n pattern: 'string',\n const: null,\n enum: ['string'],\n not: {}\n }\n }\n }\n }\n ],\n additionalProperties: true\n },\n audience: {\n targetType: 'SEGMENT',\n segments: ['497f6eca-6276-4993-bfeb-53cbbbba6f08'],\n query: '{\\\"analysis\\\":{\\\"title\\\":\\\"notempty\\\",\\\"segments\\\":[{\\\"title\\\":\\\"notempty\\\",\\\"filter\\\":{\\\"matching\\\":true,\\\"expressions\\\":[{\\\"type\\\":\\\"ATTRIBUTE\\\",\\\"attribute\\\":{\\\"expressions\\\":[{\\\"constraint\\\":{\\\"type\\\":\\\"BOOL\\\",\\\"logic\\\":\\\"IS_TRUE\\\"},\\\"attribute\\\":{\\\"type\\\":\\\"PARAM\\\",\\\"param\\\":\\\"exampleBool\\\"}}]}}]}}]}}'\n },\n schemaType: 'SIMPLE',\n lambdaId: '19f4e1cf-838e-4f7d-9400-1ddf9fb6829d',\n id: '497f6eca-6276-4993-bfeb-53cbbbba6f08'\n },\n lambdaId: '19f4e1cf-838e-4f7d-9400-1ddf9fb6829d'\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/brickworks/v1/schemas/records/preview');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"context\":{\"property1\":null,\"property2\":null},\"fieldContext\":{\"property1\":{\"page\":1,\"limit\":10,\"itemId\":\"item-123\",\"additionalFilters\":\"custom filter value\"},\"property2\":{\"page\":1,\"limit\":10,\"itemId\":\"item-123\",\"additionalFilters\":\"custom filter value\"}},\"values\":{\"property1\":null,\"property2\":null},\"schema\":{\"fields\":{\"type\":\"object\",\"properties\":{\"property1\":{\"type\":\"number\",\"subtype\":\"number\",\"minimum\":0.1,\"maximum\":0.1,\"unique\":true,\"searchable\":true,\"default\":0,\"isConstantField\":false},\"property2\":{\"type\":\"number\",\"subtype\":\"number\",\"minimum\":0.1,\"maximum\":0.1,\"unique\":true,\"searchable\":true,\"default\":0,\"isConstantField\":false}},\"required\":[\"string\"],\"allOf\":[{\"if\":{\"required\":[\"string\"],\"properties\":{\"property1\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}},\"property2\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}}}},\"then\":{\"required\":[\"string\"],\"properties\":{\"property1\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}},\"property2\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}}}},\"else\":{\"required\":[\"string\"],\"properties\":{\"property1\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}},\"property2\":{\"minItems\":0,\"maxItems\":0,\"uniqueItems\":true,\"minimum\":0,\"maximum\":0,\"pattern\":\"string\",\"const\":null,\"enum\":[\"string\"],\"not\":{}}}}}],\"additionalProperties\":true},\"audience\":{\"targetType\":\"SEGMENT\",\"segments\":[\"497f6eca-6276-4993-bfeb-53cbbbba6f08\"],\"query\":\"{\\\\\\\\\\\\\"analysis\\\\\\\\\\\\\":{\\\\\\\\\\\\\"title\\\\\\\\\\\\\":\\\\\\\\\\\\\"notempty\\\\\\\\\\\\\",\\\\\\\\\\\\\"segments\\\\\\\\\\\\\":[{\\\\\\\\\\\\\"title\\\\\\\\\\\\\":\\\\\\\\\\\\\"notempty\\\\\\\\\\\\\",\\\\\\\\\\\\\"filter\\\\\\\\\\\\\":{\\\\\\\\\\\\\"matching\\\\\\\\\\\\\":true,\\\\\\\\\\\\\"expressions\\\\\\\\\\\\\":[{\\\\\\\\\\\\\"type\\\\\\\\\\\\\":\\\\\\\\\\\\\"ATTRIBUTE\\\\\\\\\\\\\",\\\\\\\\\\\\\"attribute\\\\\\\\\\\\\":{\\\\\\\\\\\\\"expressions\\\\\\\\\\\\\":[{\\\\\\\\\\\\\"constraint\\\\\\\\\\\\\":{\\\\\\\\\\\\\"type\\\\\\\\\\\\\":\\\\\\\\\\\\\"BOOL\\\\\\\\\\\\\",\\\\\\\\\\\\\"logic\\\\\\\\\\\\\":\\\\\\\\\\\\\"IS_TRUE\\\\\\\\\\\\\"},\\\\\\\\\\\\\"attribute\\\\\\\\\\\\\":{\\\\\\\\\\\\\"type\\\\\\\\\\\\\":\\\\\\\\\\\\\"PARAM\\\\\\\\\\\\\",\\\\\\\\\\\\\"param\\\\\\\\\\\\\":\\\\\\\\\\\\\"exampleBool\\\\\\\\\\\\\"}}]}}]}}]}}\"},\"schemaType\":\"SIMPLE\",\"lambdaId\":\"19f4e1cf-838e-4f7d-9400-1ddf9fb6829d\",\"id\":\"497f6eca-6276-4993-bfeb-53cbbbba6f08\"},\"lambdaId\":\"19f4e1cf-838e-4f7d-9400-1ddf9fb6829d\"}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/brickworks/v1/schemas/records/preview\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"context\\\":{\\\"property1\\\":null,\\\"property2\\\":null},\\\"fieldContext\\\":{\\\"property1\\\":{\\\"page\\\":1,\\\"limit\\\":10,\\\"itemId\\\":\\\"item-123\\\",\\\"additionalFilters\\\":\\\"custom filter value\\\"},\\\"property2\\\":{\\\"page\\\":1,\\\"limit\\\":10,\\\"itemId\\\":\\\"item-123\\\",\\\"additionalFilters\\\":\\\"custom filter value\\\"}},\\\"values\\\":{\\\"property1\\\":null,\\\"property2\\\":null},\\\"schema\\\":{\\\"fields\\\":{\\\"type\\\":\\\"object\\\",\\\"properties\\\":{\\\"property1\\\":{\\\"type\\\":\\\"number\\\",\\\"subtype\\\":\\\"number\\\",\\\"minimum\\\":0.1,\\\"maximum\\\":0.1,\\\"unique\\\":true,\\\"searchable\\\":true,\\\"default\\\":0,\\\"isConstantField\\\":false},\\\"property2\\\":{\\\"type\\\":\\\"number\\\",\\\"subtype\\\":\\\"number\\\",\\\"minimum\\\":0.1,\\\"maximum\\\":0.1,\\\"unique\\\":true,\\\"searchable\\\":true,\\\"default\\\":0,\\\"isConstantField\\\":false}},\\\"required\\\":[\\\"string\\\"],\\\"allOf\\\":[{\\\"if\\\":{\\\"required\\\":[\\\"string\\\"],\\\"properties\\\":{\\\"property1\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}},\\\"property2\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}}}},\\\"then\\\":{\\\"required\\\":[\\\"string\\\"],\\\"properties\\\":{\\\"property1\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}},\\\"property2\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}}}},\\\"else\\\":{\\\"required\\\":[\\\"string\\\"],\\\"properties\\\":{\\\"property1\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}},\\\"property2\\\":{\\\"minItems\\\":0,\\\"maxItems\\\":0,\\\"uniqueItems\\\":true,\\\"minimum\\\":0,\\\"maximum\\\":0,\\\"pattern\\\":\\\"string\\\",\\\"const\\\":null,\\\"enum\\\":[\\\"string\\\"],\\\"not\\\":{}}}}}],\\\"additionalProperties\\\":true},\\\"audience\\\":{\\\"targetType\\\":\\\"SEGMENT\\\",\\\"segments\\\":[\\\"497f6eca-6276-4993-bfeb-53cbbbba6f08\\\"],\\\"query\\\":\\\"{\\\\\\\\\\\\\\\"analysis\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"notempty\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"segments\\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"notempty\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"filter\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"matching\\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\\"expressions\\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"ATTRIBUTE\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"attribute\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"expressions\\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\\"constraint\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"BOOL\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"logic\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"IS_TRUE\\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\\"attribute\\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"PARAM\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\"param\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\"exampleBool\\\\\\\\\\\\\\\"}}]}}]}}]}}\\\"},\\\"schemaType\\\":\\\"SIMPLE\\\",\\\"lambdaId\\\":\\\"19f4e1cf-838e-4f7d-9400-1ddf9fb6829d\\\",\\\"id\\\":\\\"497f6eca-6276-4993-bfeb-53cbbbba6f08\\\"},\\\"lambdaId\\\":\\\"19f4e1cf-838e-4f7d-9400-1ddf9fb6829d\\\"}\")\n .asString();"}]}},"/brickworks/v1/external-sources":{"post":{"tags":["Brickworks: External sources"],"summary":"Create external source","description":"Create an external data source definition. External sources can be used as a special schema field to retrieve data from a given URL when generating an object from a record.\n\nBefore starting, make sure you have a [connection](https://hub.synerise.com/docs/settings/tool/connections/) which you can use in the external source definition.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_EXTERNALSOURCES_CREATE`\n\n**User role permission required:** `assets_brickworks: create`\n","operationId":"createExternalSource","security":[{"JWT":[]}],"requestBody":{"description":"External data source definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-CreateExternalSourceRequest"}}}},"responses":{"200":{"description":"External Data Source created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-ExternalSourceModel"}}}},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-External-sources/operation/createExternalSource"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/brickworks/v1/external-sources \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"name\":\"string\",\"description\":\"string\",\"properties\":{\"sourceType\":\"http_source\",\"url\":\"https://example.com/clients/{% customer email %}\",\"method\":\"post\",\"headers\":{\"property1\":\"string\",\"property2\":\"string\"},\"params\":{\"property1\":\"string\",\"property2\":\"string\"},\"authType\":\"basic\",\"authId\":\"25d4321e-f980-49d3-983b-4275c49dc2c4\",\"body\":{\"someString\":\"string\",\"someObject\":{\"key\":\"{% customer email %}\"},\"dynamicField\":\"{% customer id %}\"},\"bodySchema\":{\"type\":\"object\",\"subtype\":\"key_value\",\"properties\":{\"someObject\":{\"type\":\"object\",\"subtype\":\"key_value\",\"properties\":{\"key\":{\"type\":\"string\",\"subtype\":\"jinjava\"}},\"additionalProperties\":true},\"dynamicField\":{\"type\":\"string\",\"subtype\":\"jinjava\"}},\"additionalProperties\":true}},\"ttl\":0}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"properties\\\":{\\\"sourceType\\\":\\\"http_source\\\",\\\"url\\\":\\\"https://example.com/clients/{% customer email %}\\\",\\\"method\\\":\\\"post\\\",\\\"headers\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"authType\\\":\\\"basic\\\",\\\"authId\\\":\\\"25d4321e-f980-49d3-983b-4275c49dc2c4\\\",\\\"body\\\":{\\\"someString\\\":\\\"string\\\",\\\"someObject\\\":{\\\"key\\\":\\\"{% customer email %}\\\"},\\\"dynamicField\\\":\\\"{% customer id %}\\\"},\\\"bodySchema\\\":{\\\"type\\\":\\\"object\\\",\\\"subtype\\\":\\\"key_value\\\",\\\"properties\\\":{\\\"someObject\\\":{\\\"type\\\":\\\"object\\\",\\\"subtype\\\":\\\"key_value\\\",\\\"properties\\\":{\\\"key\\\":{\\\"type\\\":\\\"string\\\",\\\"subtype\\\":\\\"jinjava\\\"}},\\\"additionalProperties\\\":true},\\\"dynamicField\\\":{\\\"type\\\":\\\"string\\\",\\\"subtype\\\":\\\"jinjava\\\"}},\\\"additionalProperties\\\":true}},\\\"ttl\\\":0}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/brickworks/v1/external-sources\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"name\": \"string\",\n \"description\": \"string\",\n \"properties\": {\n \"sourceType\": \"http_source\",\n \"url\": \"https://example.com/clients/{% customer email %}\",\n \"method\": \"post\",\n \"headers\": {\n \"property1\": \"string\",\n \"property2\": \"string\"\n },\n \"params\": {\n \"property1\": \"string\",\n \"property2\": \"string\"\n },\n \"authType\": \"basic\",\n \"authId\": \"25d4321e-f980-49d3-983b-4275c49dc2c4\",\n \"body\": {\n \"someString\": \"string\",\n \"someObject\": {\n \"key\": \"{% customer email %}\"\n },\n \"dynamicField\": \"{% customer id %}\"\n },\n \"bodySchema\": {\n \"type\": \"object\",\n \"subtype\": \"key_value\",\n \"properties\": {\n \"someObject\": {\n \"type\": \"object\",\n \"subtype\": \"key_value\",\n \"properties\": {\n \"key\": {\n \"type\": \"string\",\n \"subtype\": \"jinjava\"\n }\n },\n \"additionalProperties\": true\n },\n \"dynamicField\": {\n \"type\": \"string\",\n \"subtype\": \"jinjava\"\n }\n },\n \"additionalProperties\": true\n }\n },\n \"ttl\": 0\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/brickworks/v1/external-sources\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/brickworks/v1/external-sources\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n name: 'string',\n description: 'string',\n properties: {\n sourceType: 'http_source',\n url: 'https://example.com/clients/{% customer email %}',\n method: 'post',\n headers: {property1: 'string', property2: 'string'},\n params: {property1: 'string', property2: 'string'},\n authType: 'basic',\n authId: '25d4321e-f980-49d3-983b-4275c49dc2c4',\n body: {\n someString: 'string',\n someObject: {key: '{% customer email %}'},\n dynamicField: '{% customer id %}'\n },\n bodySchema: {\n type: 'object',\n subtype: 'key_value',\n properties: {\n someObject: {\n type: 'object',\n subtype: 'key_value',\n properties: {key: {type: 'string', subtype: 'jinjava'}},\n additionalProperties: true\n },\n dynamicField: {type: 'string', subtype: 'jinjava'}\n },\n additionalProperties: true\n }\n },\n ttl: 0\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/brickworks/v1/external-sources');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"name\":\"string\",\"description\":\"string\",\"properties\":{\"sourceType\":\"http_source\",\"url\":\"https://example.com/clients/{% customer email %}\",\"method\":\"post\",\"headers\":{\"property1\":\"string\",\"property2\":\"string\"},\"params\":{\"property1\":\"string\",\"property2\":\"string\"},\"authType\":\"basic\",\"authId\":\"25d4321e-f980-49d3-983b-4275c49dc2c4\",\"body\":{\"someString\":\"string\",\"someObject\":{\"key\":\"{% customer email %}\"},\"dynamicField\":\"{% customer id %}\"},\"bodySchema\":{\"type\":\"object\",\"subtype\":\"key_value\",\"properties\":{\"someObject\":{\"type\":\"object\",\"subtype\":\"key_value\",\"properties\":{\"key\":{\"type\":\"string\",\"subtype\":\"jinjava\"}},\"additionalProperties\":true},\"dynamicField\":{\"type\":\"string\",\"subtype\":\"jinjava\"}},\"additionalProperties\":true}},\"ttl\":0}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/brickworks/v1/external-sources\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"properties\\\":{\\\"sourceType\\\":\\\"http_source\\\",\\\"url\\\":\\\"https://example.com/clients/{% customer email %}\\\",\\\"method\\\":\\\"post\\\",\\\"headers\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"authType\\\":\\\"basic\\\",\\\"authId\\\":\\\"25d4321e-f980-49d3-983b-4275c49dc2c4\\\",\\\"body\\\":{\\\"someString\\\":\\\"string\\\",\\\"someObject\\\":{\\\"key\\\":\\\"{% customer email %}\\\"},\\\"dynamicField\\\":\\\"{% customer id %}\\\"},\\\"bodySchema\\\":{\\\"type\\\":\\\"object\\\",\\\"subtype\\\":\\\"key_value\\\",\\\"properties\\\":{\\\"someObject\\\":{\\\"type\\\":\\\"object\\\",\\\"subtype\\\":\\\"key_value\\\",\\\"properties\\\":{\\\"key\\\":{\\\"type\\\":\\\"string\\\",\\\"subtype\\\":\\\"jinjava\\\"}},\\\"additionalProperties\\\":true},\\\"dynamicField\\\":{\\\"type\\\":\\\"string\\\",\\\"subtype\\\":\\\"jinjava\\\"}},\\\"additionalProperties\\\":true}},\\\"ttl\\\":0}\")\n .asString();"}]},"get":{"tags":["Brickworks: External sources"],"summary":"List external sources","description":"Retrieve a list of external data sources. You can sort and paginate the results.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_EXTERNALSOURCES_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","operationId":"listExternalSource","parameters":[{"$ref":"#/components/parameters/brickworks-service-queryLimit"},{"$ref":"#/components/parameters/brickworks-service-queryPage"},{"$ref":"#/components/parameters/brickworks-service-querySearch"},{"in":"query","name":"sortBy","required":false,"description":"You can sort by:\n- `createdAt`\n- `updatedAt`\n- `name`\n","schema":{"type":"string","example":"createdAt:asc|desc"}},{"$ref":"#/components/parameters/brickworks-service-methodQueryParam"}],"security":[{"JWT":[]}],"responses":{"200":{"description":"A page of external data sources","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-ExternalSourcePagingResult"}}}},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-External-sources/operation/listExternalSource"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/brickworks/v1/external-sources?limit=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sortBy=createdAt%3Aasc%7Cdesc&method=SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/brickworks/v1/external-sources?limit=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sortBy=createdAt%3Aasc%7Cdesc&method=SOME_STRING_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/brickworks/v1/external-sources?limit=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sortBy=createdAt%3Aasc%7Cdesc&method=SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/brickworks/v1/external-sources?limit=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sortBy=createdAt%3Aasc%7Cdesc&method=SOME_STRING_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/brickworks/v1/external-sources');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'limit' => 'SOME_INTEGER_VALUE',\n 'page' => 'SOME_INTEGER_VALUE',\n 'search' => 'SOME_STRING_VALUE',\n 'sortBy' => 'createdAt:asc|desc',\n 'method' => 'SOME_STRING_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/brickworks/v1/external-sources?limit=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sortBy=createdAt%3Aasc%7Cdesc&method=SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/brickworks/v1/external-sources/{ExternalDataSourceId}":{"get":{"tags":["Brickworks: External sources"],"summary":"Get External Source","description":"Retrieve the details of an external data source.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_EXTERNALSOURCES_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","operationId":"getExternalSourceById","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/brickworks-service-pathExternalDataSourceId"}],"responses":{"200":{"description":"Details of the external source","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-ExternalSourceModel"}}}},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-External-sources/operation/getExternalSourceById"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url https://api.synerise.com/brickworks/v1/external-sources/%7BExternalDataSourceId%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/brickworks/v1/external-sources/%7BExternalDataSourceId%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/brickworks/v1/external-sources/%7BExternalDataSourceId%7D\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/brickworks/v1/external-sources/%7BExternalDataSourceId%7D\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/brickworks/v1/external-sources/%7BExternalDataSourceId%7D');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/brickworks/v1/external-sources/%7BExternalDataSourceId%7D\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]},"put":{"tags":["Brickworks: External sources"],"summary":"Update External Source","description":"Update an external data source definition.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_EXTERNALSOURCES_UPDATE`\n\n**User role permission required:** `assets_brickworks: update`\n","operationId":"updateExternalSource","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/brickworks-service-pathExternalDataSourceId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-UpdateExternalSourceRequest"}}}},"responses":{"200":{"description":"External Source updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-ExternalSourceModel"}}}},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-External-sources/operation/updateExternalSource"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request PUT \\\n --url https://api.synerise.com/brickworks/v1/external-sources/%7BExternalDataSourceId%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"name\":\"string\",\"description\":\"string\",\"properties\":{\"sourceType\":\"http_source\",\"url\":\"https://example.com/clients/{% customer email %}\",\"method\":\"post\",\"headers\":{\"property1\":\"string\",\"property2\":\"string\"},\"params\":{\"property1\":\"string\",\"property2\":\"string\"},\"authType\":\"basic\",\"authId\":\"25d4321e-f980-49d3-983b-4275c49dc2c4\",\"body\":{\"someString\":\"string\",\"someObject\":{\"key\":\"{% customer email %}\"},\"dynamicField\":\"{% customer id %}\"},\"bodySchema\":{\"type\":\"object\",\"subtype\":\"key_value\",\"properties\":{\"someObject\":{\"type\":\"object\",\"subtype\":\"key_value\",\"properties\":{\"key\":{\"type\":\"string\",\"subtype\":\"jinjava\"}},\"additionalProperties\":true},\"dynamicField\":{\"type\":\"string\",\"subtype\":\"jinjava\"}},\"additionalProperties\":true}},\"ttl\":0}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"properties\\\":{\\\"sourceType\\\":\\\"http_source\\\",\\\"url\\\":\\\"https://example.com/clients/{% customer email %}\\\",\\\"method\\\":\\\"post\\\",\\\"headers\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"authType\\\":\\\"basic\\\",\\\"authId\\\":\\\"25d4321e-f980-49d3-983b-4275c49dc2c4\\\",\\\"body\\\":{\\\"someString\\\":\\\"string\\\",\\\"someObject\\\":{\\\"key\\\":\\\"{% customer email %}\\\"},\\\"dynamicField\\\":\\\"{% customer id %}\\\"},\\\"bodySchema\\\":{\\\"type\\\":\\\"object\\\",\\\"subtype\\\":\\\"key_value\\\",\\\"properties\\\":{\\\"someObject\\\":{\\\"type\\\":\\\"object\\\",\\\"subtype\\\":\\\"key_value\\\",\\\"properties\\\":{\\\"key\\\":{\\\"type\\\":\\\"string\\\",\\\"subtype\\\":\\\"jinjava\\\"}},\\\"additionalProperties\\\":true},\\\"dynamicField\\\":{\\\"type\\\":\\\"string\\\",\\\"subtype\\\":\\\"jinjava\\\"}},\\\"additionalProperties\\\":true}},\\\"ttl\\\":0}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"PUT\", \"/brickworks/v1/external-sources/%7BExternalDataSourceId%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"name\": \"string\",\n \"description\": \"string\",\n \"properties\": {\n \"sourceType\": \"http_source\",\n \"url\": \"https://example.com/clients/{% customer email %}\",\n \"method\": \"post\",\n \"headers\": {\n \"property1\": \"string\",\n \"property2\": \"string\"\n },\n \"params\": {\n \"property1\": \"string\",\n \"property2\": \"string\"\n },\n \"authType\": \"basic\",\n \"authId\": \"25d4321e-f980-49d3-983b-4275c49dc2c4\",\n \"body\": {\n \"someString\": \"string\",\n \"someObject\": {\n \"key\": \"{% customer email %}\"\n },\n \"dynamicField\": \"{% customer id %}\"\n },\n \"bodySchema\": {\n \"type\": \"object\",\n \"subtype\": \"key_value\",\n \"properties\": {\n \"someObject\": {\n \"type\": \"object\",\n \"subtype\": \"key_value\",\n \"properties\": {\n \"key\": {\n \"type\": \"string\",\n \"subtype\": \"jinjava\"\n }\n },\n \"additionalProperties\": true\n },\n \"dynamicField\": {\n \"type\": \"string\",\n \"subtype\": \"jinjava\"\n }\n },\n \"additionalProperties\": true\n }\n },\n \"ttl\": 0\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.synerise.com/brickworks/v1/external-sources/%7BExternalDataSourceId%7D\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/brickworks/v1/external-sources/%7BExternalDataSourceId%7D\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n name: 'string',\n description: 'string',\n properties: {\n sourceType: 'http_source',\n url: 'https://example.com/clients/{% customer email %}',\n method: 'post',\n headers: {property1: 'string', property2: 'string'},\n params: {property1: 'string', property2: 'string'},\n authType: 'basic',\n authId: '25d4321e-f980-49d3-983b-4275c49dc2c4',\n body: {\n someString: 'string',\n someObject: {key: '{% customer email %}'},\n dynamicField: '{% customer id %}'\n },\n bodySchema: {\n type: 'object',\n subtype: 'key_value',\n properties: {\n someObject: {\n type: 'object',\n subtype: 'key_value',\n properties: {key: {type: 'string', subtype: 'jinjava'}},\n additionalProperties: true\n },\n dynamicField: {type: 'string', subtype: 'jinjava'}\n },\n additionalProperties: true\n }\n },\n ttl: 0\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/brickworks/v1/external-sources/%7BExternalDataSourceId%7D');\n$request->setMethod(HTTP_METH_PUT);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"name\":\"string\",\"description\":\"string\",\"properties\":{\"sourceType\":\"http_source\",\"url\":\"https://example.com/clients/{% customer email %}\",\"method\":\"post\",\"headers\":{\"property1\":\"string\",\"property2\":\"string\"},\"params\":{\"property1\":\"string\",\"property2\":\"string\"},\"authType\":\"basic\",\"authId\":\"25d4321e-f980-49d3-983b-4275c49dc2c4\",\"body\":{\"someString\":\"string\",\"someObject\":{\"key\":\"{% customer email %}\"},\"dynamicField\":\"{% customer id %}\"},\"bodySchema\":{\"type\":\"object\",\"subtype\":\"key_value\",\"properties\":{\"someObject\":{\"type\":\"object\",\"subtype\":\"key_value\",\"properties\":{\"key\":{\"type\":\"string\",\"subtype\":\"jinjava\"}},\"additionalProperties\":true},\"dynamicField\":{\"type\":\"string\",\"subtype\":\"jinjava\"}},\"additionalProperties\":true}},\"ttl\":0}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.put(\"https://api.synerise.com/brickworks/v1/external-sources/%7BExternalDataSourceId%7D\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"name\\\":\\\"string\\\",\\\"description\\\":\\\"string\\\",\\\"properties\\\":{\\\"sourceType\\\":\\\"http_source\\\",\\\"url\\\":\\\"https://example.com/clients/{% customer email %}\\\",\\\"method\\\":\\\"post\\\",\\\"headers\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"params\\\":{\\\"property1\\\":\\\"string\\\",\\\"property2\\\":\\\"string\\\"},\\\"authType\\\":\\\"basic\\\",\\\"authId\\\":\\\"25d4321e-f980-49d3-983b-4275c49dc2c4\\\",\\\"body\\\":{\\\"someString\\\":\\\"string\\\",\\\"someObject\\\":{\\\"key\\\":\\\"{% customer email %}\\\"},\\\"dynamicField\\\":\\\"{% customer id %}\\\"},\\\"bodySchema\\\":{\\\"type\\\":\\\"object\\\",\\\"subtype\\\":\\\"key_value\\\",\\\"properties\\\":{\\\"someObject\\\":{\\\"type\\\":\\\"object\\\",\\\"subtype\\\":\\\"key_value\\\",\\\"properties\\\":{\\\"key\\\":{\\\"type\\\":\\\"string\\\",\\\"subtype\\\":\\\"jinjava\\\"}},\\\"additionalProperties\\\":true},\\\"dynamicField\\\":{\\\"type\\\":\\\"string\\\",\\\"subtype\\\":\\\"jinjava\\\"}},\\\"additionalProperties\\\":true}},\\\"ttl\\\":0}\")\n .asString();"}]},"delete":{"tags":["Brickworks: External sources"],"summary":"Delete external source","description":"Permanently delete an external data source definition.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_EXTERNALSOURCES_DELETE`\n\n**User role permission required:** `assets_brickworks: delete`\n","operationId":"deleteExternalSource","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/brickworks-service-pathExternalDataSourceId"}],"responses":{"204":{"description":"No content"},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-External-sources/operation/deleteExternalSource"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request DELETE \\\n --url https://api.synerise.com/brickworks/v1/external-sources/%7BExternalDataSourceId%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"DELETE\", \"/brickworks/v1/external-sources/%7BExternalDataSourceId%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.synerise.com/brickworks/v1/external-sources/%7BExternalDataSourceId%7D\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/brickworks/v1/external-sources/%7BExternalDataSourceId%7D\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/brickworks/v1/external-sources/%7BExternalDataSourceId%7D');\n$request->setMethod(HTTP_METH_DELETE);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.delete(\"https://api.synerise.com/brickworks/v1/external-sources/%7BExternalDataSourceId%7D\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier}/duplicate":{"post":{"tags":["Brickworks: Records"],"summary":"Duplicate record","description":"Create a copy of a record. The name of the copy is `{recordName} - copy`\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_CREATE`\n\n**User role permission required:** `assets_brickworks: create`\n","operationId":"duplicateRecordBySchemaAppIdAndRecordId","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/brickworks-service-pathSchemaIdentifier"},{"$ref":"#/components/parameters/brickworks-service-pathRecordIdentifier"}],"responses":{"200":{"description":"Data of the created record","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-Record"}}}},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-Records/operation/duplicateRecordBySchemaAppIdAndRecordId"]}},"/brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier}/versions":{"get":{"tags":["Brickworks: Record versions"],"summary":"Get record versions","description":"Retrieve all versions of a record. You can paginate, sort, and refine the results. By default, the versions are sorted from newest to oldest.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","operationId":"getRecordVersions","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/brickworks-service-pathSchemaIdentifier"},{"$ref":"#/components/parameters/brickworks-service-pathRecordIdentifier"},{"$ref":"#/components/parameters/brickworks-service-queryLimit"},{"$ref":"#/components/parameters/brickworks-service-queryPage"},{"$ref":"#/components/parameters/brickworks-service-queryRecordFilters"},{"$ref":"#/components/parameters/brickworks-service-querySortBy"},{"$ref":"#/components/parameters/brickworks-service-queryStatuses"}],"responses":{"200":{"description":"A page of record versions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-RecordVersionPagingResult"}}}},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-Record-versions/operation/getRecordVersions"]}},"/brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier}/versions/{RecordVersionIdentifier}":{"get":{"tags":["Brickworks: Record versions"],"summary":"Get record version","description":"Retrieve the details of a record version. The version can be identified by either a UUID (RecordVersionId) or a version number (integer).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_READ`\n\n**User role permission required:** `assets_brickworks: read`\n","operationId":"getRecordVersion","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/brickworks-service-pathSchemaIdentifier"},{"$ref":"#/components/parameters/brickworks-service-pathRecordIdentifier"},{"$ref":"#/components/parameters/brickworks-service-pathRecordVersionIdentifier"}],"responses":{"200":{"description":"Record version object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-RecordVersion"}}}},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-Record-versions/operation/getRecordVersion"]}},"/brickworks/v1/async/schemas/{SchemaIdentifier}/records":{"post":{"tags":["Brickworks: Records"],"summary":"Batch create or update records (async)","description":"This endpoint can only be used for simple schemas.\n\n- If a record included in this request already exists, it's entirely overwritten by the content from the request (including the slug - if the slug isn't sent, it's removed).\n- Provide the current identifier value (if your request changes the identifier, provide the one from before the change).\n- The record must conform with the schema.\n\nAsynchronous requests are processed according to the time they reach the service. \nThis means that requests to synchronous endpoints may overwrite asynchronous operations which were sent earlier and queued due to high traffic.\n\nIn some edge cases, changing a record may fail further in the backend, even when this endpoint returns no errors. In such cases, contact Support.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_CREATE`\n\n**User role permission required:** `assets_brickworks: create`\n","operationId":"createOrUpdateRecordBatchAsync","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/brickworks-service-pathSchemaIdentifier"}],"requestBody":{"description":"Record data","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/brickworks-service-AsyncRecordRequest"}}}}},"responses":{"201":{"description":"Operation added to queue"},"207":{"$ref":"#/components/responses/brickworks-service-207Response"},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-Records/operation/createOrUpdateRecordBatchAsync"]},"patch":{"tags":["Brickworks: Records"],"summary":"Batch create or partially update record (async)","description":"This endpoint can only be used for simple schemas.\n\nAsynchronous requests are processed according to the time they reach the service. \nThis means that requests to synchronous endpoints may overwrite asynchronous operations which were sent earlier and queued due to high traffic.\n\nIn some edge cases, changing a record may fail further in the backend, even when this endpoint returns no errors. In such cases, contact Support.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_CREATE`\n\n**User role permission required:** `assets_brickworks: create`\n","operationId":"createOrPartialUpdateRecordBatchAsync","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/brickworks-service-pathSchemaIdentifier"}],"requestBody":{"description":"Record data","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/brickworks-service-AsyncRecordRequest"}}}}},"responses":{"201":{"description":"Operation added to queue"},"207":{"$ref":"#/components/responses/brickworks-service-207Response"},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-Records/operation/createOrPartialUpdateRecordBatchAsync"]}},"/brickworks/v1/async/schemas/{SchemaIdentifier}/record":{"post":{"tags":["Brickworks: Records"],"summary":"Create or update record (async)","description":"This endpoint can only be used for simple schemas.\n\n- If a record included in this request already exists, it's entirely overwritten by the content from the request (including the slug - if the slug isn't sent, it's removed).\n- Provide the current identifier value (if your request changes the identifier, provide the one from before the change).\n- The record must conform with the schema.\n\nAsynchronous requests are processed according to the time they reach the service. \nThis means that requests to synchronous endpoints may overwrite asynchronous operations which were sent earlier and queued due to high traffic.\n\nIn some edge cases, changing a record may fail further in the backend, even when this endpoint returns no errors. In such cases, contact Support.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_CREATE`\n\n**User role permission required:** `assets_brickworks: create`\n","operationId":"createOrUpdateRecordSingleAsync","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/brickworks-service-pathSchemaIdentifier"}],"requestBody":{"description":"Record data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-AsyncRecordRequest"}}}},"responses":{"201":{"description":"Operation added to queue","content":{}},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-Records/operation/createOrUpdateRecordSingleAsync"]},"patch":{"tags":["Brickworks: Records"],"summary":"Create or partially update record (async)","description":"This endpoint can only be used for simple schemas.\n\n- You can use this endpoint to update a record by sending only the fields which you want to change. Other fields are not affected.\n- This endpoint doesn't validate the data against field-specific settings, such as limits on character count or regex in a string field.\n\nAsynchronous requests are processed according to the time they reach the service. \nThis means that requests to synchronous endpoints may overwrite asynchronous operations which were sent earlier and queued due to high traffic.\n\nIn some edge cases, changing a record may fail further in the backend, even when this endpoint returns no errors. In such cases, contact Support.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `BRICKWORKS_RECORDS_CREATE`\n\n**User role permission required:** `assets_brickworks: create`\n","operationId":"createOrPartialUpdateRecordSingleAsync","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/brickworks-service-pathSchemaIdentifier"}],"requestBody":{"description":"Record data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/brickworks-service-AsyncRecordRequest"}}}},"responses":{"201":{"description":"Operation added to queue"},"400":{"$ref":"#/components/responses/brickworks-service-GenericBadRequestError"},"401":{"$ref":"#/components/responses/brickworks-service-GenericUnauthorizedError"},"403":{"$ref":"#/components/responses/brickworks-service-GenericForbiddenError"},"404":{"$ref":"#/components/responses/brickworks-service-GenericNotFoundError"},"409":{"$ref":"#/components/responses/brickworks-service-GenericConflictError"},"422":{"$ref":"#/components/responses/brickworks-service-GenericUnprocessableContentError"},"500":{"$ref":"#/components/responses/brickworks-service-GenericError"}},"x-snr-doc-urls":["/api-reference/brickworks#tag/Brickworks:-Records/operation/createOrPartialUpdateRecordSingleAsync"]}},"/business-profile-service/organizations/usage/stats/newDataPoints":{"post":{"operationId":"generateDailyNewDataPointsStats","summary":"Get consumption metric with new data points","description":"Retrieve the number of new events (events added to the database on a particular day), listed by day. You can limit the metric to particular workspaces and event types (actions).\n\n---\n\n**API consumers:** Synerise User, Organization\n","security":[{"JWT":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/business-profile-service-OrganizationDailyUsageReportRequest"}}}},"responses":{"200":{"description":"Statistics of new events for the specified date range","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/business-profile-service-DailyUsageStats"}}}}},"401":{"$ref":"#/components/responses/business-profile-service-401-bpservice"},"403":{"$ref":"#/components/responses/business-profile-service-403-bpservice"},"4xx":{"$ref":"#/components/responses/business-profile-service-4xx-bpservice"}},"tags":["Consumption"],"x-snr-doc-urls":["/api-reference/organizations#tag/Consumption/operation/generateDailyNewDataPointsStats"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/business-profile-service/organizations/usage/stats/newDataPoints \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"from\":\"2025-05-29\",\"to\":\"2025-05-30\",\"actions\":[\"page.visit\"],\"bpGuids\":[\"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\"]}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"from\\\":\\\"2025-05-29\\\",\\\"to\\\":\\\"2025-05-30\\\",\\\"actions\\\":[\\\"page.visit\\\"],\\\"bpGuids\\\":[\\\"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\\\"]}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/business-profile-service/organizations/usage/stats/newDataPoints\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"from\": \"2025-05-29\",\n \"to\": \"2025-05-30\",\n \"actions\": [\n \"page.visit\"\n ],\n \"bpGuids\": [\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\"\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/business-profile-service/organizations/usage/stats/newDataPoints\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/business-profile-service/organizations/usage/stats/newDataPoints\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n from: '2025-05-29',\n to: '2025-05-30',\n actions: ['page.visit'],\n bpGuids: ['34eea35e-3ac4-44f4-95b5-fd00a3b45eff']\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/business-profile-service/organizations/usage/stats/newDataPoints');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"from\":\"2025-05-29\",\"to\":\"2025-05-30\",\"actions\":[\"page.visit\"],\"bpGuids\":[\"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\"]}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/business-profile-service/organizations/usage/stats/newDataPoints\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"from\\\":\\\"2025-05-29\\\",\\\"to\\\":\\\"2025-05-30\\\",\\\"actions\\\":[\\\"page.visit\\\"],\\\"bpGuids\\\":[\\\"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\\\"]}\")\n .asString();"}]}},"/business-profile-service/organizations/usage/stats/retentionDataPoints":{"post":{"operationId":"generateDailyRetentionDataPointsStats","summary":"Get consumption metric with retention data points","description":"Retrieve the number of events kept in the database, listed by day. This includes events saved in the past, which currently exist in the database according to their retention period. \n\nYou can limit the metric to particular workspaces and event types (actions).\n\n\n---\n\n**API consumers:** Synerise User, Organization\n","security":[{"JWT":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/business-profile-service-OrganizationDailyUsageReportRequest"}}}},"responses":{"200":{"description":"Statistics of retention events for the specified date range","content":{"application/json":{"schema":{"$ref":"#/components/schemas/business-profile-service-RetentionUsageStats"}}}},"401":{"$ref":"#/components/responses/business-profile-service-401-bpservice"},"403":{"$ref":"#/components/responses/business-profile-service-403-bpservice"},"4xx":{"$ref":"#/components/responses/business-profile-service-4xx-bpservice"}},"tags":["Consumption"],"x-snr-doc-urls":["/api-reference/organizations#tag/Consumption/operation/generateDailyRetentionDataPointsStats"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/business-profile-service/organizations/usage/stats/retentionDataPoints \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"from\":\"2025-05-29\",\"to\":\"2025-05-30\",\"actions\":[\"page.visit\"],\"bpGuids\":[\"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\"]}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"from\\\":\\\"2025-05-29\\\",\\\"to\\\":\\\"2025-05-30\\\",\\\"actions\\\":[\\\"page.visit\\\"],\\\"bpGuids\\\":[\\\"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\\\"]}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/business-profile-service/organizations/usage/stats/retentionDataPoints\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"from\": \"2025-05-29\",\n \"to\": \"2025-05-30\",\n \"actions\": [\n \"page.visit\"\n ],\n \"bpGuids\": [\n \"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\"\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/business-profile-service/organizations/usage/stats/retentionDataPoints\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/business-profile-service/organizations/usage/stats/retentionDataPoints\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n from: '2025-05-29',\n to: '2025-05-30',\n actions: ['page.visit'],\n bpGuids: ['34eea35e-3ac4-44f4-95b5-fd00a3b45eff']\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/business-profile-service/organizations/usage/stats/retentionDataPoints');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"from\":\"2025-05-29\",\"to\":\"2025-05-30\",\"actions\":[\"page.visit\"],\"bpGuids\":[\"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\"]}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/business-profile-service/organizations/usage/stats/retentionDataPoints\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"from\\\":\\\"2025-05-29\\\",\\\"to\\\":\\\"2025-05-30\\\",\\\"actions\\\":[\\\"page.visit\\\"],\\\"bpGuids\\\":[\\\"34eea35e-3ac4-44f4-95b5-fd00a3b45eff\\\"]}\")\n .asString();"}]}},"/business-profile-service/business-profiles":{"get":{"tags":["Organization workspaces"],"summary":"Get universal list of organization workspaces","operationId":"getBusinessProfilesUniversalList","description":"Retrieve a universal list of workspaces available to the user.\n\n---\n\n**API consumer:** Synerise User\n","parameters":[{"$ref":"#/components/parameters/business-profile-service-listPage"},{"$ref":"#/components/parameters/business-profile-service-listLimit"},{"name":"favorite","in":"query","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/business-profile-service-listSearch"},{"name":"sortBy","in":"query","schema":{"type":"string","default":"CREATED:ASC","enum":["ID:ASC","ID:DESC","NAME:ASC","NAME:DESC","CREATED:ASC","CREATED:DESC","FAVORITE:ASC","FAVORITE:DESC"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/business-profile-service-UniversalListBusinessProfilesResponse"}}}}},"x-snr-doc-urls":["/api-reference/organizations#tag/Organization-workspaces/operation/getBusinessProfilesUniversalList"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/business-profile-service/business-profiles?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&favorite=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nconn.request(\"GET\", \"/business-profile-service/business-profiles?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&favorite=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/business-profile-service/business-profiles?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&favorite=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/business-profile-service/business-profiles?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&favorite=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/business-profile-service/business-profiles');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'page' => 'SOME_INTEGER_VALUE',\n 'limit' => 'SOME_INTEGER_VALUE',\n 'favorite' => 'SOME_BOOLEAN_VALUE',\n 'search' => 'SOME_STRING_VALUE',\n 'sortBy' => 'SOME_STRING_VALUE'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/business-profile-service/business-profiles?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&favorite=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE\")\n .asString();"}]}},"/business-profile-service/organizations/workspaces":{"get":{"summary":"Get all workspaces from organization","description":"Retrieve a list of all workspaces in an organization.\n\n---\n\n**API consumers:** Synerise User, Organization\n","tags":["Organization workspaces"],"operationId":"getWorkspacesOfOrganization","responses":{"200":{"description":"List of workspaces","content":{"application/json":{"schema":{"$ref":"#/components/schemas/business-profile-service-OrganizationWorkspacesResponse"}}}}},"x-snr-doc-urls":["/api-reference/organizations#tag/Organization-workspaces/operation/getWorkspacesOfOrganization"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url https://api.synerise.com/business-profile-service/organizations/workspaces"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nconn.request(\"GET\", \"/business-profile-service/organizations/workspaces\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/business-profile-service/organizations/workspaces\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/business-profile-service/organizations/workspaces\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/business-profile-service/organizations/workspaces');\n$request->setMethod(HTTP_METH_GET);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/business-profile-service/organizations/workspaces\")\n .asString();"}]}},"/business-profile-service/organizations/business-profiles":{"get":{"tags":["Settings"],"summary":"Get universal list of organization workspaces","operationId":"getBusinessProfilesForOrganizationUserUniversalList","description":"Retrieve a list of worspaces in the organization in context of the current user.\n\n---\n\n**API consumer:** Synerise User\n","parameters":[{"$ref":"#/components/parameters/business-profile-service-listPage"},{"$ref":"#/components/parameters/business-profile-service-listLimit"},{"name":"businessProfileGroupId","in":"query","required":false,"description":"Workspace group to filter by.","schema":{"type":"string"}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","default":"NAME:ASC","enum":["NAME:ASC","NAME:DESC","CREATED:ASC","CREATED:DESC"]}},{"name":"search","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/business-profile-service-UniversalListBusinessProfilesForOrganizationUserResponse"}}}}},"x-snr-doc-urls":["/api-reference/identity-and-access-management#tag/Settings/operation/getBusinessProfilesForOrganizationUserUniversalList"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/business-profile-service/organizations/business-profiles?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&businessProfileGroupId=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE&search=SOME_STRING_VALUE'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nconn.request(\"GET\", \"/business-profile-service/organizations/business-profiles?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&businessProfileGroupId=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE&search=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/business-profile-service/organizations/business-profiles?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&businessProfileGroupId=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE&search=SOME_STRING_VALUE\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/business-profile-service/organizations/business-profiles?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&businessProfileGroupId=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE&search=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/business-profile-service/organizations/business-profiles');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'page' => 'SOME_INTEGER_VALUE',\n 'limit' => 'SOME_INTEGER_VALUE',\n 'businessProfileGroupId' => 'SOME_STRING_VALUE',\n 'sortBy' => 'SOME_STRING_VALUE',\n 'search' => 'SOME_STRING_VALUE'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/business-profile-service/organizations/business-profiles?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&businessProfileGroupId=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE&search=SOME_STRING_VALUE\")\n .asString();"}]}},"/business-profile-service/organizations/business-profiles/with-identifiers":{"get":{"tags":["Organization workspaces"],"summary":"Get universal list of organization workspaces with profile identifiers","operationId":"getBusinessProfilesWithIdentifiersForOrganizationUserUniversalList","description":"Retrieve a universal list of workspaces in context of the current user; with profile identifiers used in each workspace.\n\n---\n\n**API consumer:** Synerise User\n","parameters":[{"$ref":"#/components/parameters/business-profile-service-listPage"},{"$ref":"#/components/parameters/business-profile-service-listLimit"},{"name":"businessProfileGroupId","in":"query","required":false,"description":"Workspace group to filter by.","schema":{"type":"string"}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","default":"NAME:ASC","enum":["NAME:ASC","NAME:DESC","CREATED:ASC","CREATED:DESC"]}},{"name":"search","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/business-profile-service-UniversalListBusinessProfilesForOrganizationWithIdentifiersUserResponse"}}}}},"x-snr-doc-urls":["/api-reference/organizations#tag/Organization-workspaces/operation/getBusinessProfilesWithIdentifiersForOrganizationUserUniversalList"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/business-profile-service/organizations/business-profiles/with-identifiers?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&businessProfileGroupId=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE&search=SOME_STRING_VALUE'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nconn.request(\"GET\", \"/business-profile-service/organizations/business-profiles/with-identifiers?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&businessProfileGroupId=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE&search=SOME_STRING_VALUE\")\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/business-profile-service/organizations/business-profiles/with-identifiers?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&businessProfileGroupId=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE&search=SOME_STRING_VALUE\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/business-profile-service/organizations/business-profiles/with-identifiers?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&businessProfileGroupId=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE&search=SOME_STRING_VALUE\",\n \"headers\": {}\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/business-profile-service/organizations/business-profiles/with-identifiers');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'page' => 'SOME_INTEGER_VALUE',\n 'limit' => 'SOME_INTEGER_VALUE',\n 'businessProfileGroupId' => 'SOME_STRING_VALUE',\n 'sortBy' => 'SOME_STRING_VALUE',\n 'search' => 'SOME_STRING_VALUE'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/business-profile-service/organizations/business-profiles/with-identifiers?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&businessProfileGroupId=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE&search=SOME_STRING_VALUE\")\n .asString();"}]}},"/catalogs/bags/{catalogId}/csv":{"get":{"tags":["Catalogs"],"summary":"Get all items as CSV file","description":"Download a CSV with all items in the catalog. The unique identifier of an item is saved in the `item_key` column.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_READ`\n\n**User role permission required:** `assets_catalogs: read`\n","operationId":"getItemsCSV","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"},{"$ref":"#/components/parameters/catalogs-queryDelimiter"}],"responses":{"200":{"description":"CSV file. The unique identifier of an item is in the `item_key` column.","content":{"text/csv":{"schema":{"type":"string"},"example":"item_key,color,type\n3a9d38e8,blue,sneaker\ne96b17b7,red,sneaker\n"}}},"401":{"$ref":"#/components/responses/catalogs-401"},"403":{"$ref":"#/components/responses/catalogs-403"},"404":{"$ref":"#/components/responses/catalogs-404"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/getItemsCSV"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/csv?delimiter=SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/catalogs/bags/%7BcatalogId%7D/csv?delimiter=SOME_STRING_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/csv?delimiter=SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/bags/%7BcatalogId%7D/csv?delimiter=SOME_STRING_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/csv');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'delimiter' => 'SOME_STRING_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/csv?delimiter=SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/catalogs/bags/{catalogId}/items/upload":{"post":{"tags":["Catalogs"],"summary":"Add items from CSV","description":"Upload items to a catalog from a CSV file\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_UPDATE`\n\n**User role permission required:** `assets_catalogs: update`\n","operationId":"uploadItems","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"itemKey":{"description":"The name of the CSV column that contains unique identifiers. Slashes (`/`) are not allowed in the identifier values.","type":"string"},"file":{"description":"CSV file","type":"string","format":"binary"}},"required":["itemKey","file"]}}}},"responses":{"200":{"description":"Upload status","content":{"application/json":{"schema":{"type":"boolean","description":"`true` when successful"}}}},"400":{"$ref":"#/components/responses/catalogs-400"},"401":{"$ref":"#/components/responses/catalogs-401"},"403":{"$ref":"#/components/responses/catalogs-403"},"404":{"$ref":"#/components/responses/catalogs-404"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/uploadItems"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/upload \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: multipart/form-data' \\\n --form itemKey=string \\\n --form file=string"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"-----011000010111000001101001\\r\\nContent-Disposition: form-data; name=\\\"itemKey\\\"\\r\\n\\r\\nstring\\r\\n-----011000010111000001101001\\r\\nContent-Disposition: form-data; name=\\\"file\\\"\\r\\n\\r\\nstring\\r\\n-----011000010111000001101001--\\r\\n\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"multipart/form-data\"\n }\n\nconn.request(\"POST\", \"/catalogs/bags/%7BcatalogId%7D/items/upload\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = new FormData();\ndata.append(\"itemKey\", \"string\");\ndata.append(\"file\", \"string\");\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/upload\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/bags/%7BcatalogId%7D/items/upload\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(\"-----011000010111000001101001\\r\\nContent-Disposition: form-data; name=\\\"itemKey\\\"\\r\\n\\r\\nstring\\r\\n-----011000010111000001101001\\r\\nContent-Disposition: form-data; name=\\\"file\\\"\\r\\n\\r\\nstring\\r\\n-----011000010111000001101001--\\r\\n\");\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/upload');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'multipart/form-data'\n]);\n\n$request->setBody('-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"itemKey\"\r\n\r\nstring\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\nstring\r\n-----011000010111000001101001--\r\n');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/upload\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .body(\"-----011000010111000001101001\\r\\nContent-Disposition: form-data; name=\\\"itemKey\\\"\\r\\n\\r\\nstring\\r\\n-----011000010111000001101001\\r\\nContent-Disposition: form-data; name=\\\"file\\\"\\r\\n\\r\\nstring\\r\\n-----011000010111000001101001--\\r\\n\")\n .asString();"}]}},"/catalogs/bags":{"post":{"tags":["Catalogs"],"summary":"Add catalog","description":"Create a new, empty catalog.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_CREATE`\n\n**User role permission required:** `assets_catalogs: create`\n","operationId":"addBag","security":[{"JWT":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/catalogs-addBag"}}},"required":true},"responses":{"200":{"description":"Details of the created catalog","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/catalogs-bag"},"metaData":{"$ref":"#/components/schemas/catalogs-responseMeta"}}}}}},"400":{"$ref":"#/components/responses/catalogs-400"},"401":{"$ref":"#/components/responses/catalogs-401"},"403":{"$ref":"#/components/responses/catalogs-403"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/addBag"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/catalogs/bags \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"name\":\"string\"}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"name\\\":\\\"string\\\"}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/catalogs/bags\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"name\": \"string\"\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/catalogs/bags\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/bags\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({name: 'string'}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/bags');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"name\":\"string\"}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/catalogs/bags\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"name\\\":\\\"string\\\"}\")\n .asString();"}]},"get":{"tags":["Catalogs"],"summary":"Get catalogs","description":"Retrieve all catalogs from the Workspace. You can filter and sort the results.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_READ`\n\n**User role permission required:** `assets_catalogs: read`\n","operationId":"getBags","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-queryCatalogSearchBy"},{"$ref":"#/components/parameters/catalogs-queryCatalogOrderBy"},{"$ref":"#/components/parameters/catalogs-queryOffset"},{"$ref":"#/components/parameters/catalogs-queryLimit"}],"responses":{"200":{"description":"List of catalogs","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"A list of catalogs","items":{"$ref":"#/components/schemas/catalogs-bag"}},"metaData":{"$ref":"#/components/schemas/catalogs-responseMeta"}}}}}},"401":{"$ref":"#/components/responses/catalogs-401"},"403":{"$ref":"#/components/responses/catalogs-403"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/getBags"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/catalogs/bags?searchBy=SOME_STRING_VALUE&orderBy=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/catalogs/bags?searchBy=SOME_STRING_VALUE&orderBy=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/catalogs/bags?searchBy=SOME_STRING_VALUE&orderBy=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/bags?searchBy=SOME_STRING_VALUE&orderBy=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/bags');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'searchBy' => 'SOME_STRING_VALUE',\n 'orderBy' => 'SOME_STRING_VALUE',\n 'offset' => 'SOME_INTEGER_VALUE',\n 'limit' => 'SOME_INTEGER_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/catalogs/bags?searchBy=SOME_STRING_VALUE&orderBy=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]},"delete":{"tags":["Catalogs"],"summary":"Delete catalogs","description":"\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_DELETE`\n\n**User role permission required:** `assets_catalogs: delete`\n","operationId":"deleteBagByIds","security":[{"JWT":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string","description":"Catalog ID"},"example":[1199,1200,1201]}}}},"responses":{"200":{"description":"Deletion status","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"A list of catalogs and their deletion statuses","items":{"$ref":"#/components/schemas/catalogs-deleteResponse"}},"metaData":{"$ref":"#/components/schemas/catalogs-responseMeta"}}}}}},"400":{"$ref":"#/components/responses/catalogs-400"},"401":{"$ref":"#/components/responses/catalogs-401"},"403":{"$ref":"#/components/responses/catalogs-403"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/deleteBagByIds"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request DELETE \\\n --url https://api.synerise.com/catalogs/bags \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '[1199,1200,1201]'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"[1199,1200,1201]\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"DELETE\", \"/catalogs/bags\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify([\n 1199,\n 1200,\n 1201\n]);\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.synerise.com/catalogs/bags\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/bags\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify([1199, 1200, 1201]));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/bags');\n$request->setMethod(HTTP_METH_DELETE);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('[1199,1200,1201]');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.delete(\"https://api.synerise.com/catalogs/bags\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"[1199,1200,1201]\")\n .asString();"}]}},"/catalogs/bags/{catalogId}/keys":{"get":{"tags":["Catalogs"],"summary":"Get catalog keys","description":"Retrieve the list of keys from a catalog.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_READ`\n\n**User role permission required:** `assets_catalogs: read`\n","operationId":"getKeysByBag","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"}],"responses":{"200":{"description":"List of keys","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"A list of keys (column names) in the catalog","items":{"type":"string"}},"metaData":{"$ref":"#/components/schemas/catalogs-responseMeta"}},"example":{"data":["id","isbn","name"],"metaData":{"totalCount":3,"requestTime":"0.071 [s]"}}}}}},"401":{"$ref":"#/components/responses/catalogs-401"},"403":{"$ref":"#/components/responses/catalogs-403"},"404":{"$ref":"#/components/responses/catalogs-404"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/getKeysByBag"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/keys \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/catalogs/bags/%7BcatalogId%7D/keys\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/keys\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/bags/%7BcatalogId%7D/keys\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/keys');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/keys\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/catalogs/bags/{catalogId}":{"get":{"tags":["Catalogs"],"summary":"Get catalog info","description":"Retrieve the metadata of a catalog\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_READ`\n\n**User role permission required:** `assets_catalogs: read`\n","operationId":"getBagById","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"}],"responses":{"200":{"description":"Details of the catalog","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/catalogs-bag"},"metaData":{"$ref":"#/components/schemas/catalogs-responseMeta"}}}}}},"401":{"$ref":"#/components/responses/catalogs-401"},"403":{"$ref":"#/components/responses/catalogs-403"},"404":{"$ref":"#/components/responses/catalogs-404"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/getBagById"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/catalogs/bags/%7BcatalogId%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/bags/%7BcatalogId%7D\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/bags/%7BcatalogId%7D');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]},"delete":{"tags":["Catalogs"],"summary":"Delete catalog","description":"Delete a single catalog. This operation is irreversible.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_DELETE`\n\n**User role permission required:** `assets_catalogs: delete`\n","operationId":"deleteBagById","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"}],"responses":{"200":{"description":"Deletion status","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"boolean","description":"`true` if the catalog was deleted successfully"},"metaData":{"$ref":"#/components/schemas/catalogs-responseMeta"}}}}}},"401":{"$ref":"#/components/responses/catalogs-401"},"403":{"$ref":"#/components/responses/catalogs-403"},"404":{"$ref":"#/components/responses/catalogs-404"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/deleteBagById"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request DELETE \\\n --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"DELETE\", \"/catalogs/bags/%7BcatalogId%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/bags/%7BcatalogId%7D\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/bags/%7BcatalogId%7D');\n$request->setMethod(HTTP_METH_DELETE);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.delete(\"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/catalogs/bags/{catalogId}/items":{"post":{"tags":["Catalogs"],"summary":"Add item","description":"Add a single item to the catalog.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_ITEM_BATCH_CATALOG_CREATE`\n\n**User role permission required:** `assets_catalogs: create`\n","operationId":"addItems","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"}],"requestBody":{"description":"JSON object with any number of key/value pairs","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/catalogs-addItem"}}}},"responses":{"200":{"description":"Upload status","content":{"application/json":{"schema":{"type":"boolean","description":"TRUE if successful"}}}},"400":{"$ref":"#/components/responses/catalogs-400"},"401":{"$ref":"#/components/responses/catalogs-401"},"403":{"$ref":"#/components/responses/catalogs-403"},"404":{"$ref":"#/components/responses/catalogs-404"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/addItems"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"itemKey\":\"sku1357\",\"value\":{\"itemCategory\":\"smartphone\",\"itemColor\":\"blue\"}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"itemKey\\\":\\\"sku1357\\\",\\\"value\\\":{\\\"itemCategory\\\":\\\"smartphone\\\",\\\"itemColor\\\":\\\"blue\\\"}}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/catalogs/bags/%7BcatalogId%7D/items\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"itemKey\": \"sku1357\",\n \"value\": {\n \"itemCategory\": \"smartphone\",\n \"itemColor\": \"blue\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/bags/%7BcatalogId%7D/items\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({itemKey: 'sku1357', value: {itemCategory: 'smartphone', itemColor: 'blue'}}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"itemKey\":\"sku1357\",\"value\":{\"itemCategory\":\"smartphone\",\"itemColor\":\"blue\"}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"itemKey\\\":\\\"sku1357\\\",\\\"value\\\":{\\\"itemCategory\\\":\\\"smartphone\\\",\\\"itemColor\\\":\\\"blue\\\"}}\")\n .asString();"}]},"get":{"tags":["Catalogs"],"summary":"Get items from catalog","description":"Retrieve the entries from a single catalog.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_READ`\n\n**User role permission required:** `assets_catalogs: read`\n","operationId":"getItemsByBag","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"},{"$ref":"#/components/parameters/catalogs-queryItemKey"},{"$ref":"#/components/parameters/catalogs-queryOffset"},{"$ref":"#/components/parameters/catalogs-queryLimit"}],"responses":{"200":{"description":"A list of items in the catalog","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"Details of the items","items":{"$ref":"#/components/schemas/catalogs-item"}},"metaData":{"$ref":"#/components/schemas/catalogs-responseMeta"}}}}}}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/getItemsByBag"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items?itemKey=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/catalogs/bags/%7BcatalogId%7D/items?itemKey=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items?itemKey=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/bags/%7BcatalogId%7D/items?itemKey=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'itemKey' => 'SOME_STRING_VALUE',\n 'offset' => 'SOME_INTEGER_VALUE',\n 'limit' => 'SOME_INTEGER_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items?itemKey=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/catalogs/bags/{catalogId}/items/batch":{"post":{"tags":["Catalogs"],"summary":"Batch add items","description":"Add a number of items at once.\n\nFor better performance, we recommend using the [`/v1/async/bags/{catalogId}/items` endpoint](#operation/addItemsBatchAsync).\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_ITEM_BATCH_CATALOG_CREATE`\n\n**User role permission required:** `assets_catalogs: create`\n","operationId":"addItemsBatch","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"}],"requestBody":{"description":"An array of JSON objects with any number of key/value pairs","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/catalogs-addItem"}}}}},"responses":{"200":{"description":"Upload status","content":{"application/json":{"schema":{"type":"boolean","description":"TRUE if successful"}}}},"400":{"$ref":"#/components/responses/catalogs-400"},"401":{"$ref":"#/components/responses/catalogs-401"},"403":{"$ref":"#/components/responses/catalogs-403"},"404":{"$ref":"#/components/responses/catalogs-404"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/addItemsBatch"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/batch \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '[{\"itemKey\":\"sku1357\",\"value\":{\"itemCategory\":\"smartphone\",\"itemColor\":\"blue\"}}]'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"[{\\\"itemKey\\\":\\\"sku1357\\\",\\\"value\\\":{\\\"itemCategory\\\":\\\"smartphone\\\",\\\"itemColor\\\":\\\"blue\\\"}}]\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/catalogs/bags/%7BcatalogId%7D/items/batch\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify([\n {\n \"itemKey\": \"sku1357\",\n \"value\": {\n \"itemCategory\": \"smartphone\",\n \"itemColor\": \"blue\"\n }\n }\n]);\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/batch\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/bags/%7BcatalogId%7D/items/batch\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify([{itemKey: 'sku1357', value: {itemCategory: 'smartphone', itemColor: 'blue'}}]));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/batch');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('[{\"itemKey\":\"sku1357\",\"value\":{\"itemCategory\":\"smartphone\",\"itemColor\":\"blue\"}}]');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/batch\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"[{\\\"itemKey\\\":\\\"sku1357\\\",\\\"value\\\":{\\\"itemCategory\\\":\\\"smartphone\\\",\\\"itemColor\\\":\\\"blue\\\"}}]\")\n .asString();"}]}},"/catalogs/bags/{catalogId}/enrichment/fields":{"patch":{"tags":["Catalogs"],"summary":"Update enrichment fields","description":"Change enrichment fields for given mapping\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_MAPPING_CATALOG_CREATE`\n\n**User role permission required:** `assets_catalogs: create`\n","operationId":"updateEnrichmentFields","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/catalogs-enrichmentUpdateRequest"}}}},"responses":{"200":{"description":"Upload status","content":{"application/json":{"schema":{"type":"integer","description":"Number of rows changed"}}}},"400":{"$ref":"#/components/responses/catalogs-400"},"401":{"$ref":"#/components/responses/catalogs-401"},"403":{"$ref":"#/components/responses/catalogs-403"},"404":{"$ref":"#/components/responses/catalogs-404"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/updateEnrichmentFields"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request PATCH \\\n --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/enrichment/fields \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"action\":\"string\",\"paramKey\":\"string\",\"enrichmentFields\":[\"string\"]}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"action\\\":\\\"string\\\",\\\"paramKey\\\":\\\"string\\\",\\\"enrichmentFields\\\":[\\\"string\\\"]}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"PATCH\", \"/catalogs/bags/%7BcatalogId%7D/enrichment/fields\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"action\": \"string\",\n \"paramKey\": \"string\",\n \"enrichmentFields\": [\n \"string\"\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PATCH\", \"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/enrichment/fields\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/bags/%7BcatalogId%7D/enrichment/fields\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({action: 'string', paramKey: 'string', enrichmentFields: ['string']}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/enrichment/fields');\n$request->setMethod(HttpRequest::HTTP_METH_PATCH);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"action\":\"string\",\"paramKey\":\"string\",\"enrichmentFields\":[\"string\"]}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.patch(\"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/enrichment/fields\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"action\\\":\\\"string\\\",\\\"paramKey\\\":\\\"string\\\",\\\"enrichmentFields\\\":[\\\"string\\\"]}\")\n .asString();"}]}},"/catalogs/bags/{catalogId}/items/itemKey/{itemKey}":{"get":{"tags":["Catalogs"],"summary":"Get single item by itemKey","description":"Retrieve a single item from a catalog by using the item key (unique identifier of an item in the catalog, for example a product's SKU) of the entry in the Synerise database.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_READ`\n\n**User role permission required:** `assets_catalogs: read`\n","operationId":"getItemByKey","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"},{"in":"path","name":"itemKey","required":true,"description":"`itemKey` parameter of the item to retrieve","schema":{"type":"string"}}],"responses":{"200":{"description":"A single item","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/catalogs-item"},"metaData":{"$ref":"#/components/schemas/catalogs-responseMeta"}}}}}}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/getItemByKey"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/itemKey/%7BitemKey%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/catalogs/bags/%7BcatalogId%7D/items/itemKey/%7BitemKey%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/itemKey/%7BitemKey%7D\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/bags/%7BcatalogId%7D/items/itemKey/%7BitemKey%7D\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/itemKey/%7BitemKey%7D');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/itemKey/%7BitemKey%7D\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]},"delete":{"tags":["Catalogs"],"summary":"Delete single item by itemKey","description":"Delete a single item by itemKey (unique identifier of an item in the catalog, for example a product's SKU).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_DELETE`\n\n**User role permission required:** `assets_catalogs: delete`\n","operationId":"deleteItemByItemKey","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"},{"in":"path","name":"itemKey","required":true,"description":"`itemKey` parameter of the item to delete","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"boolean","description":"`true` if the operation was successful."},"metaData":{"$ref":"#/components/schemas/catalogs-responseMeta"}}}}}},"401":{"$ref":"#/components/responses/catalogs-401"},"403":{"$ref":"#/components/responses/catalogs-403"},"404":{"$ref":"#/components/responses/catalogs-404"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/deleteItemByItemKey"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request DELETE \\\n --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/itemKey/%7BitemKey%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"DELETE\", \"/catalogs/bags/%7BcatalogId%7D/items/itemKey/%7BitemKey%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/itemKey/%7BitemKey%7D\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/bags/%7BcatalogId%7D/items/itemKey/%7BitemKey%7D\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/itemKey/%7BitemKey%7D');\n$request->setMethod(HTTP_METH_DELETE);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.delete(\"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/itemKey/%7BitemKey%7D\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/catalogs/bags/{catalogId}/items/{itemId}":{"post":{"tags":["Catalogs"],"summary":"Update single item by database ID","description":"Update a single item from a catalog by using the ID of the entry in the Synerise database.\n\nUpdate requests are processed according to the time they reach the service. \nThis means that updates from the synchronous `/bags/{catalogId}/items/{itemId}` endpoint may overwrite asynchronous operations (see [`/v1/async/*` endpoints](#operation/updateItemAsync)) which were sent earlier and queued due to high traffic. \nThis behavior also applies to requests from Automation and AI feed synchronization, which use the asynchronous mechanism.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_UPDATE`\n\n**User role permission required:** `assets_catalogs: update`\n","operationId":"updateItem","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"},{"$ref":"#/components/parameters/catalogs-itemDatabaseId"}],"requestBody":{"description":"JSON object with any number of key/value pairs","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"description":"The properties of the catalog item"}}}}},"responses":{"200":{"description":"A single item","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/catalogs-item"},"metaData":{"$ref":"#/components/schemas/catalogs-responseMeta"}}}}}},"401":{"$ref":"#/components/responses/catalogs-401"},"403":{"$ref":"#/components/responses/catalogs-403"},"404":{"$ref":"#/components/responses/catalogs-404"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/updateItem"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/%7BitemId%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"property1\":null,\"property2\":null}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"property1\\\":null,\\\"property2\\\":null}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/catalogs/bags/%7BcatalogId%7D/items/%7BitemId%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"property1\": null,\n \"property2\": null\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/%7BitemId%7D\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/bags/%7BcatalogId%7D/items/%7BitemId%7D\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({property1: null, property2: null}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/%7BitemId%7D');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"property1\":null,\"property2\":null}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/%7BitemId%7D\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"property1\\\":null,\\\"property2\\\":null}\")\n .asString();"}]},"get":{"tags":["Catalogs"],"summary":"Get single item by database ID","description":"Retrieve a single item from a catalog by using the ID of the entry in the Synerise database. If you want to retrieve an item by its unique identifier in the catalog, use [/bags/{catalogId}/items/itemKey/{itemKey}](#operation/getItemByKey).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_READ`\n\n**User role permission required:** `assets_catalogs: read`\n","operationId":"getItem","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"},{"$ref":"#/components/parameters/catalogs-itemDatabaseId"}],"responses":{"200":{"description":"A single item","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/catalogs-item"},"metaData":{"$ref":"#/components/schemas/catalogs-responseMeta"}}}}}},"401":{"$ref":"#/components/responses/catalogs-401"},"403":{"$ref":"#/components/responses/catalogs-403"},"404":{"$ref":"#/components/responses/catalogs-404"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/getItem"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/%7BitemId%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/catalogs/bags/%7BcatalogId%7D/items/%7BitemId%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/%7BitemId%7D\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/bags/%7BcatalogId%7D/items/%7BitemId%7D\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/%7BitemId%7D');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/%7BitemId%7D\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]},"delete":{"tags":["Catalogs"],"summary":"Delete single item by database ID","description":"Delete a single item by ID.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_DELETE`\n\n**User role permission required:** `assets_catalogs: delete`\n","operationId":"deleteItem","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"},{"$ref":"#/components/parameters/catalogs-itemDatabaseId"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"boolean","description":"`true` if the operation was successful."},"metaData":{"$ref":"#/components/schemas/catalogs-responseMeta"}}}}}},"401":{"$ref":"#/components/responses/catalogs-401"},"403":{"$ref":"#/components/responses/catalogs-403"},"404":{"$ref":"#/components/responses/catalogs-404"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/deleteItem"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request DELETE \\\n --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/%7BitemId%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"DELETE\", \"/catalogs/bags/%7BcatalogId%7D/items/%7BitemId%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/%7BitemId%7D\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/bags/%7BcatalogId%7D/items/%7BitemId%7D\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/%7BitemId%7D');\n$request->setMethod(HTTP_METH_DELETE);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.delete(\"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/items/%7BitemId%7D\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/catalogs/items":{"get":{"tags":["Catalogs"],"summary":"Get all items","description":"Retrieve all items from all catalogs in the Workspace.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_READ`\n\n**User role permission required:** `assets_catalogs: read`\n","operationId":"getItemsByBusinessProfileid","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-queryOffset"},{"$ref":"#/components/parameters/catalogs-queryLimit"}],"responses":{"200":{"description":"A list of items in the Workspace","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"Details of the items","items":{"$ref":"#/components/schemas/catalogs-item"}},"metaData":{"$ref":"#/components/schemas/catalogs-responseMeta"}}}}}},"401":{"$ref":"#/components/responses/catalogs-401"},"403":{"$ref":"#/components/responses/catalogs-403"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/getItemsByBusinessProfileid"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/catalogs/items?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/catalogs/items?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/catalogs/items?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/items?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/items');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'offset' => 'SOME_INTEGER_VALUE',\n 'limit' => 'SOME_INTEGER_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/catalogs/items?offset=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/catalogs/bags/{catalogId}/mappings":{"post":{"tags":["Catalogs"],"summary":"Add mapping","description":"Add a new mapping. Mappings can be used to enrich events with data from catalogs.\n\nFor example, you can map the product's SKU from the \"product.buy\" event to the column in the catalog that includes the SKU. Whenever someone purchases an item with that SKU, you can extract data from the catalog (for example, the product's brand and category) and show that additional in the event log in the Synerise GUI.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_MAPPING_CATALOG_CREATE`\n\n**User role permission required:** `assets_catalogs: create`\n","operationId":"addMapping","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/catalogs-eventData"}}}},"responses":{"200":{"description":"Mapping data","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/catalogs-mapper"},"metaData":{"$ref":"#/components/schemas/catalogs-responseMeta"}}}}}},"400":{"$ref":"#/components/responses/catalogs-400"},"401":{"$ref":"#/components/responses/catalogs-401"},"403":{"$ref":"#/components/responses/catalogs-403"},"404":{"$ref":"#/components/responses/catalogs-404"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/addMapping"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/mappings \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"action\":\"transaction.charge\",\"paramKey\":\"sku\"}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"action\\\":\\\"transaction.charge\\\",\\\"paramKey\\\":\\\"sku\\\"}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/catalogs/bags/%7BcatalogId%7D/mappings\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"action\": \"transaction.charge\",\n \"paramKey\": \"sku\"\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/mappings\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/bags/%7BcatalogId%7D/mappings\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({action: 'transaction.charge', paramKey: 'sku'}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/mappings');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"action\":\"transaction.charge\",\"paramKey\":\"sku\"}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/catalogs/bags/%7BcatalogId%7D/mappings\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"action\\\":\\\"transaction.charge\\\",\\\"paramKey\\\":\\\"sku\\\"}\")\n .asString();"}]}},"/catalogs/mappings":{"get":{"tags":["Catalogs"],"summary":"Get all mappings","description":"Retrieve all mappings from the Workspace.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_MAPPING_CATALOG_READ`\n\n**User role permission required:** `assets_catalogs: read`\n","operationId":"getMappingsByBP","security":[{"JWT":[]}],"responses":{"200":{"description":"List of mappings","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"A list of mappings","items":{"$ref":"#/components/schemas/catalogs-mapper"}},"metaData":{"$ref":"#/components/schemas/catalogs-responseMeta"}}}}}},"401":{"$ref":"#/components/responses/catalogs-401"},"403":{"$ref":"#/components/responses/catalogs-403"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/getMappingsByBP"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url https://api.synerise.com/catalogs/mappings \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/catalogs/mappings\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/catalogs/mappings\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/mappings\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/mappings');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/catalogs/mappings\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/catalogs/mappings/{bpActionParamKey}":{"delete":{"tags":["Catalogs"],"summary":"Delete mapping","description":"Delete a single mapping.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_MAPPING_CATALOG_DELETE`\n\n**User role permission required:** `assets_catalogs: delete`\n","operationId":"deleteMappingBykey","security":[{"JWT":[]}],"parameters":[{"in":"path","name":"bpActionParamKey","description":"The unique identifier of the mapping","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Deletion status","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"boolean","description":"`true` if successful"},"metaData":{"$ref":"#/components/schemas/catalogs-responseMeta"}}}}}},"401":{"$ref":"#/components/responses/catalogs-401"},"403":{"$ref":"#/components/responses/catalogs-403"},"404":{"$ref":"#/components/responses/catalogs-404"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/deleteMappingBykey"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request DELETE \\\n --url https://api.synerise.com/catalogs/mappings/%7BbpActionParamKey%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"DELETE\", \"/catalogs/mappings/%7BbpActionParamKey%7D\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.synerise.com/catalogs/mappings/%7BbpActionParamKey%7D\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/mappings/%7BbpActionParamKey%7D\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/mappings/%7BbpActionParamKey%7D');\n$request->setMethod(HTTP_METH_DELETE);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.delete(\"https://api.synerise.com/catalogs/mappings/%7BbpActionParamKey%7D\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/catalogs/itemDetail":{"get":{"tags":["Catalogs"],"summary":"Get single item by unique key","description":"Retrieve a single item from a catalog by using the value of the unique identifier (key) in the catalog. If you want to retrieve an item by its ID in the Synerise database, use [/bags/{catalogId}/items/{itemId}](#operation/getItem).\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_COLLECTOR_CATALOG_READ`\n\n**User role permission required:** `assets_catalogs: read`\n","operationId":"getItemDetailByKey","security":[{"JWT":[]}],"parameters":[{"name":"catalogName","in":"query","required":true,"description":"Name of the catalog","schema":{"type":"string"}},{"name":"key","in":"query","required":true,"description":"Value of the unique identifier of the item in the catalog. When you retrieve an item using [this endpoint](#operation/getItemsByBag), the identifier is in the `itemKey` field.\n\n```\n{\n \"creationDate\": \"2020-09-30T11:31:16.314Z\",\n \"id\": 73753,\n \"itemKey\": \"uniqueValue\", // this is the value of the key\n \"lastModified\": null,\n \"value\": \"{\\\"exampleKey\\\":\\\"uniqueValue\\\",\\\"exampleKey2\\\":\\\"exampleValue\\\"}\",\n \"bag\": {\n \"author\": \"authorName\",\n \"creationDate\": \"2020-09-30T10:52:31.264Z\",\n \"id\": 1053,\n \"lastModified\": \"2020-09-30T11:41:11.808Z\",\n \"name\": \"sampleCatalog\"\n }\n},\n```\n","schema":{"type":"string"}}],"responses":{"200":{"description":"A single item","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","description":"The column values from this item's catalog row.","properties":{"itemId":{"type":"string","description":"Unique ID, equal to the `itemKey` used in the request to this endpoint."}},"additionalProperties":{"description":"Column values"}},"metaData":{"$ref":"#/components/schemas/catalogs-responseMeta"}}}}}},"401":{"$ref":"#/components/responses/catalogs-401"},"403":{"$ref":"#/components/responses/catalogs-403"},"404":{"$ref":"#/components/responses/catalogs-404"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/getItemDetailByKey"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/catalogs/itemDetail?catalogName=SOME_STRING_VALUE&key=SOME_STRING_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/catalogs/itemDetail?catalogName=SOME_STRING_VALUE&key=SOME_STRING_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/catalogs/itemDetail?catalogName=SOME_STRING_VALUE&key=SOME_STRING_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/itemDetail?catalogName=SOME_STRING_VALUE&key=SOME_STRING_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/itemDetail');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'catalogName' => 'SOME_STRING_VALUE',\n 'key' => 'SOME_STRING_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/catalogs/itemDetail?catalogName=SOME_STRING_VALUE&key=SOME_STRING_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/catalogs/v2/bags/{catalogId}/items":{"delete":{"tags":["Catalogs"],"summary":"Delete all items from a catalog","description":"Delete all the contents of a catalog.\n\nInformation about the keys (columns) remains.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_DELETE`\n\n**User role permission required:** `assets_catalogs: delete`\n","operationId":"deleteBagsItemsV2","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"}],"responses":{"200":{"description":"Items deleted. The `metaData` object always shows a `totalCount` of 1, regardless of the number of deleted items.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"string","format":"uuid","description":"ID of the deletion job"},"metaData":{"$ref":"#/components/schemas/catalogs-responseMeta"}}}}}},"4xx":{"$ref":"#/components/responses/catalogs-400generic"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/deleteBagsItemsV2"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request DELETE \\\n --url https://api.synerise.com/catalogs/v2/bags/%7BcatalogId%7D/items \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"DELETE\", \"/catalogs/v2/bags/%7BcatalogId%7D/items\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.synerise.com/catalogs/v2/bags/%7BcatalogId%7D/items\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/v2/bags/%7BcatalogId%7D/items\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/v2/bags/%7BcatalogId%7D/items');\n$request->setMethod(HTTP_METH_DELETE);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.delete(\"https://api.synerise.com/catalogs/v2/bags/%7BcatalogId%7D/items\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/catalogs/v2/bags/{catalogId}/items/batch":{"delete":{"tags":["Catalogs"],"summary":"Delete items by itemKeys","description":"Delete items by itemKeys (unique identifier of an item in the catalog, for example a product's SKU). In the Synerise Portal, it's called the **Primary key**.\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_DELETE`\n\n**User role permission required:** `assets_catalogs: delete`\n","operationId":"deleteItemsByItemKeys","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"}],"requestBody":{"description":"Array of itemKeys","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/catalogs-401"},"403":{"$ref":"#/components/responses/catalogs-403"},"404":{"$ref":"#/components/responses/catalogs-404"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/deleteItemsByItemKeys"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request DELETE \\\n --url https://api.synerise.com/catalogs/v2/bags/%7BcatalogId%7D/items/batch \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '[\"string\"]'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"[\\\"string\\\"]\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"DELETE\", \"/catalogs/v2/bags/%7BcatalogId%7D/items/batch\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify([\n \"string\"\n]);\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"DELETE\", \"https://api.synerise.com/catalogs/v2/bags/%7BcatalogId%7D/items/batch\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"DELETE\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/v2/bags/%7BcatalogId%7D/items/batch\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify(['string']));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/v2/bags/%7BcatalogId%7D/items/batch');\n$request->setMethod(HTTP_METH_DELETE);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('[\"string\"]');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.delete(\"https://api.synerise.com/catalogs/v2/bags/%7BcatalogId%7D/items/batch\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"[\\\"string\\\"]\")\n .asString();"}]}},"/catalogs/v2/bags/{catalogId}/enable/filtering":{"patch":{"tags":["Catalogs"],"summary":"Enable filtering","description":"Enable filtering for a catalog on selected fields\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_UPDATE`\n\n**User role permission required:** `assets_catalogs: update`\n","operationId":"enableFilteringV2","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/catalogs-enableFilteringRequest"}}}},"responses":{"200":{"description":"Upload status","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"string","format":"uuid"},"metaData":{"$ref":"#/components/schemas/catalogs-responseMeta"}}}}}}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/enableFilteringV2"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request PATCH \\\n --url https://api.synerise.com/catalogs/v2/bags/%7BcatalogId%7D/enable/filtering \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"fields\":[\"string\"]}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"fields\\\":[\\\"string\\\"]}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"PATCH\", \"/catalogs/v2/bags/%7BcatalogId%7D/enable/filtering\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"fields\": [\n \"string\"\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PATCH\", \"https://api.synerise.com/catalogs/v2/bags/%7BcatalogId%7D/enable/filtering\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/v2/bags/%7BcatalogId%7D/enable/filtering\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({fields: ['string']}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/v2/bags/%7BcatalogId%7D/enable/filtering');\n$request->setMethod(HttpRequest::HTTP_METH_PATCH);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"fields\":[\"string\"]}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.patch(\"https://api.synerise.com/catalogs/v2/bags/%7BcatalogId%7D/enable/filtering\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"fields\\\":[\\\"string\\\"]}\")\n .asString();"}]}},"/catalogs/v2/bags/{catalogId}/disable/filtering":{"patch":{"tags":["Catalogs"],"summary":"Disable filtering","description":"Disable filtering for a catalog on selected fields\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CATALOGS_CATALOG_UPDATE`\n\n**User role permission required:** `assets_catalogs: update`\n","operationId":"disableFilteringV2","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/catalogs-disableFilteringRequest"}}}},"responses":{"200":{"description":"Number of rows changed","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"integer"},"metaData":{"$ref":"#/components/schemas/catalogs-responseMeta"}}}}}}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/disableFilteringV2"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request PATCH \\\n --url https://api.synerise.com/catalogs/v2/bags/%7BcatalogId%7D/disable/filtering \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"removeFilters\":true}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"removeFilters\\\":true}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"PATCH\", \"/catalogs/v2/bags/%7BcatalogId%7D/disable/filtering\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"removeFilters\": true\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PATCH\", \"https://api.synerise.com/catalogs/v2/bags/%7BcatalogId%7D/disable/filtering\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/v2/bags/%7BcatalogId%7D/disable/filtering\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({removeFilters: true}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/v2/bags/%7BcatalogId%7D/disable/filtering');\n$request->setMethod(HttpRequest::HTTP_METH_PATCH);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"removeFilters\":true}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.patch(\"https://api.synerise.com/catalogs/v2/bags/%7BcatalogId%7D/disable/filtering\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"removeFilters\\\":true}\")\n .asString();"}]}},"/catalogs/v1/async/bags/{catalogId}/item":{"post":{"tags":["Catalogs"],"summary":"Add or update item asynchronously","description":"Add a single item asynchronously to the catalog. If the item already exists, it's entirely overwritten by the item you send.\n\nAsynchronous requests are processed according to the time they reach the service. \nThis means that requests to synchronous endpoints (for example, [`/bags/{catalogId}/items/{itemId}`](#operation/updateItem) may overwrite asynchronous operations which were sent earlier and queued due to high traffic. \nThis behavior also applies to requests from Automation and AI feed synchronization, which use the asynchronous mechanism.\n\nThe request body can't exceed 256KB.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `CATALOGS_ITEM_BATCH_CREATE`, `CATALOGS_ITEM_BATCH_CATALOG_CREATE`\n\n**User role permission required:** `assets_catalogs: create`\n","operationId":"addItemAsync","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"}],"requestBody":{"description":"JSON object with any number of key/value pairs","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/catalogs-addItem"}}}},"responses":{"204":{"description":"Operation added to queue"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/addItemAsync"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/catalogs/v1/async/bags/%7BcatalogId%7D/item \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"itemKey\":\"sku1357\",\"value\":{\"itemCategory\":\"smartphone\",\"itemColor\":\"blue\"}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"itemKey\\\":\\\"sku1357\\\",\\\"value\\\":{\\\"itemCategory\\\":\\\"smartphone\\\",\\\"itemColor\\\":\\\"blue\\\"}}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/catalogs/v1/async/bags/%7BcatalogId%7D/item\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"itemKey\": \"sku1357\",\n \"value\": {\n \"itemCategory\": \"smartphone\",\n \"itemColor\": \"blue\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/catalogs/v1/async/bags/%7BcatalogId%7D/item\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/v1/async/bags/%7BcatalogId%7D/item\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({itemKey: 'sku1357', value: {itemCategory: 'smartphone', itemColor: 'blue'}}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/v1/async/bags/%7BcatalogId%7D/item');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"itemKey\":\"sku1357\",\"value\":{\"itemCategory\":\"smartphone\",\"itemColor\":\"blue\"}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/catalogs/v1/async/bags/%7BcatalogId%7D/item\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"itemKey\\\":\\\"sku1357\\\",\\\"value\\\":{\\\"itemCategory\\\":\\\"smartphone\\\",\\\"itemColor\\\":\\\"blue\\\"}}\")\n .asString();"}]},"patch":{"tags":["Catalogs"],"summary":"Add or update (partial) item asynchronously","description":"Update a single item asynchronously to the catalog. If the item doesn't exist, it will be created.\n\nThis endpoint allows you to perform partial updates - you can send only the properties that you want to add/modify, instead of sending the entire item.\n\nAsynchronous requests are processed according to the time they reach the service. \nThis means that requests to synchronous endpoints (for example, [`/bags/{catalogId}/items/{itemId}`](#operation/updateItem) may overwrite asynchronous operations which were sent earlier and queued due to high traffic. \nThis behavior also applies to requests from Automation and AI feed synchronization, which use the asynchronous mechanism.\n\nThe request body can't exceed 256KB.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `CATALOGS_ITEM_BATCH_UPDATE`, `CATALOGS_ITEM_BATCH_CATALOG_UPDATE`\n\n**User role permission required:** `assets_catalogs: update`\n","operationId":"updateItemAsync","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"}],"requestBody":{"description":"JSON object with any number of key/value pairs","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/catalogs-addItem"}}}},"responses":{"204":{"description":"Operation added to queue"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/updateItemAsync"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request PATCH \\\n --url https://api.synerise.com/catalogs/v1/async/bags/%7BcatalogId%7D/item \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"itemKey\":\"sku1357\",\"value\":{\"itemCategory\":\"smartphone\",\"itemColor\":\"blue\"}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"itemKey\\\":\\\"sku1357\\\",\\\"value\\\":{\\\"itemCategory\\\":\\\"smartphone\\\",\\\"itemColor\\\":\\\"blue\\\"}}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"PATCH\", \"/catalogs/v1/async/bags/%7BcatalogId%7D/item\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"itemKey\": \"sku1357\",\n \"value\": {\n \"itemCategory\": \"smartphone\",\n \"itemColor\": \"blue\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PATCH\", \"https://api.synerise.com/catalogs/v1/async/bags/%7BcatalogId%7D/item\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/v1/async/bags/%7BcatalogId%7D/item\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({itemKey: 'sku1357', value: {itemCategory: 'smartphone', itemColor: 'blue'}}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/v1/async/bags/%7BcatalogId%7D/item');\n$request->setMethod(HttpRequest::HTTP_METH_PATCH);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"itemKey\":\"sku1357\",\"value\":{\"itemCategory\":\"smartphone\",\"itemColor\":\"blue\"}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.patch(\"https://api.synerise.com/catalogs/v1/async/bags/%7BcatalogId%7D/item\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"itemKey\\\":\\\"sku1357\\\",\\\"value\\\":{\\\"itemCategory\\\":\\\"smartphone\\\",\\\"itemColor\\\":\\\"blue\\\"}}\")\n .asString();"}]}},"/catalogs/v1/async/bags/{catalogId}/items":{"post":{"tags":["Catalogs"],"summary":"Batch add or update items asynchronously","description":"Add a number of items asynchronously at once. If an item already exists, it's entirely overwritten by the item you send.\n\nAsynchronous requests are processed according to the time they reach the service. \nThis means that requests to synchronous endpoints (for example, [`/bags/{catalogId}/items/{itemId}`](#operation/updateItem) may overwrite asynchronous operations which were sent earlier and queued due to high traffic. \nThis behavior also applies to requests from Automation and AI feed synchronization, which use the asynchronous mechanism.\n\nThe request body can't exceed 256KB.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `CATALOGS_ITEM_BATCH_CREATE`, `CATALOGS_ITEM_BATCH_CATALOG_CREATE`\n\n**User role permission required:** `assets_catalogs: create`\n","operationId":"addItemsBatchAsync","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"}],"requestBody":{"description":"JSON object with any number of key/value pairs","required":true,"content":{"application/json":{"schema":{"type":"array","maxItems":200,"items":{"$ref":"#/components/schemas/catalogs-addItem"}}}}},"responses":{"204":{"description":"Operation added to queue"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/addItemsBatchAsync"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/catalogs/v1/async/bags/%7BcatalogId%7D/items \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '[{\"itemKey\":\"sku1357\",\"value\":{\"itemCategory\":\"smartphone\",\"itemColor\":\"blue\"}}]'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"[{\\\"itemKey\\\":\\\"sku1357\\\",\\\"value\\\":{\\\"itemCategory\\\":\\\"smartphone\\\",\\\"itemColor\\\":\\\"blue\\\"}}]\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/catalogs/v1/async/bags/%7BcatalogId%7D/items\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify([\n {\n \"itemKey\": \"sku1357\",\n \"value\": {\n \"itemCategory\": \"smartphone\",\n \"itemColor\": \"blue\"\n }\n }\n]);\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/catalogs/v1/async/bags/%7BcatalogId%7D/items\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/v1/async/bags/%7BcatalogId%7D/items\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify([{itemKey: 'sku1357', value: {itemCategory: 'smartphone', itemColor: 'blue'}}]));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/v1/async/bags/%7BcatalogId%7D/items');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('[{\"itemKey\":\"sku1357\",\"value\":{\"itemCategory\":\"smartphone\",\"itemColor\":\"blue\"}}]');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/catalogs/v1/async/bags/%7BcatalogId%7D/items\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"[{\\\"itemKey\\\":\\\"sku1357\\\",\\\"value\\\":{\\\"itemCategory\\\":\\\"smartphone\\\",\\\"itemColor\\\":\\\"blue\\\"}}]\")\n .asString();"}]},"patch":{"tags":["Catalogs"],"summary":"Batch add or update (partial) items asynchronously","description":"Update a number of items asynchronously at once. If an item doesn't exist, it will be created.\n\nThis endpoint allows you to perform partial updates - you can send only the properties that you want to add/modify, instead of sending the entire item.\n\nAsynchronous requests are processed according to the time they reach the service. \nThis means that requests to synchronous endpoints (for example, [`/bags/{catalogId}/items/{itemId}`](#operation/updateItem) may overwrite asynchronous operations which were sent earlier and queued due to high traffic. \nThis behavior also applies to requests from Automation and AI feed synchronization, which use the asynchronous mechanism.\n\nThe request body can't exceed 256KB.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permissions required (at least one):** `CATALOGS_ITEM_BATCH_UPDATE`, `CATALOGS_ITEM_BATCH_CATALOG_UPDATE`\n\n**User role permission required:** `assets_catalogs: update`\n","operationId":"updateItemsBatchAsync","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/catalogs-pathCatalogId"}],"requestBody":{"description":"JSON object with any number of key/value pairs","required":true,"content":{"application/json":{"schema":{"type":"array","maxItems":200,"items":{"$ref":"#/components/schemas/catalogs-addItem"}}}}},"responses":{"204":{"description":"Operation added to queue"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Catalogs/operation/updateItemsBatchAsync"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request PATCH \\\n --url https://api.synerise.com/catalogs/v1/async/bags/%7BcatalogId%7D/items \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '[{\"itemKey\":\"sku1357\",\"value\":{\"itemCategory\":\"smartphone\",\"itemColor\":\"blue\"}}]'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"[{\\\"itemKey\\\":\\\"sku1357\\\",\\\"value\\\":{\\\"itemCategory\\\":\\\"smartphone\\\",\\\"itemColor\\\":\\\"blue\\\"}}]\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"PATCH\", \"/catalogs/v1/async/bags/%7BcatalogId%7D/items\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify([\n {\n \"itemKey\": \"sku1357\",\n \"value\": {\n \"itemCategory\": \"smartphone\",\n \"itemColor\": \"blue\"\n }\n }\n]);\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PATCH\", \"https://api.synerise.com/catalogs/v1/async/bags/%7BcatalogId%7D/items\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"PATCH\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/catalogs/v1/async/bags/%7BcatalogId%7D/items\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify([{itemKey: 'sku1357', value: {itemCategory: 'smartphone', itemColor: 'blue'}}]));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/catalogs/v1/async/bags/%7BcatalogId%7D/items');\n$request->setMethod(HttpRequest::HTTP_METH_PATCH);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('[{\"itemKey\":\"sku1357\",\"value\":{\"itemCategory\":\"smartphone\",\"itemColor\":\"blue\"}}]');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.patch(\"https://api.synerise.com/catalogs/v1/async/bags/%7BcatalogId%7D/items\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"[{\\\"itemKey\\\":\\\"sku1357\\\",\\\"value\\\":{\\\"itemCategory\\\":\\\"smartphone\\\",\\\"itemColor\\\":\\\"blue\\\"}}]\")\n .asString();"}]}},"/crm/v1/clients/{clientId}/contacts":{"get":{"deprecated":true,"tags":["Profile management"],"summary":"Get Profile details","description":"This method is deprecated. It will be disabled on August 30, 2026. \n\nYou can use these methods instead:\n - [GET /v4/clients/{clientId}](#operation/GetClientData)\n - [GET /v4/clients/{identifierType}/{identifierValue}](#operation/FindAClient)\n\nRetrieve the details of a Profile.\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CRM_DETAILS_CLIENT_READ`\n\n**User role permission required:** `client_info: read`\n","operationId":"getClient","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/crm-pathClientId"}],"responses":{"200":{"description":"Profile details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/crm-ClientDetails"}}}},"404":{"$ref":"#/components/responses/crm-404-pii"}},"x-snr-doc-urls":["/api-reference/data-management#tag/Profile-management/operation/getClient"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url https://api.synerise.com/crm/v1/clients/%7BclientId%7D/contacts \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/crm/v1/clients/%7BclientId%7D/contacts\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/crm/v1/clients/%7BclientId%7D/contacts\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/crm/v1/clients/%7BclientId%7D/contacts\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/crm/v1/clients/%7BclientId%7D/contacts');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/crm/v1/clients/%7BclientId%7D/contacts\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]}},"/crm/v1/contacts/{clientId}":{"put":{"deprecated":true,"tags":["Profile management"],"summary":"Update Profile","description":"This method is deprecated. It will be disabled on August 16, 2026 \nUse one of these endpoints instead:\n - [POST /v4/clients/{clientId}](#operation/UpdateAClient)\n - [POST /v4/clients/by-email/{clientEmail}](#operation/UpdateAClientByEmail)\n - [POST /v4/clients/by-customid/{customId}](#operation/UpdateAClientByCustomId)\n\nSending a null value **deletes** an attribute (if it's a custom attribute) or **sets it to null/default value** (if the attribute is Synerise-native)\n\n\n---\n\n**API consumers:** Synerise User, Workspace (Business Profile)\n\n**API key permission required:** `CRM_CLIENT_UPDATE`\n\n**User role permission required:** `client_management: update`\n","operationId":"updateClient","security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/crm-pathClientId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/crm-CustomerCommon"}}},"required":true},"responses":{"200":{"description":"Profile details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/crm-ClientDetails"}}}}},"x-snr-doc-urls":["/api-reference/data-management#tag/Profile-management/operation/updateClient"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request PUT \\\n --url https://api.synerise.com/crm/v1/contacts/%7BclientId%7D \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\",\"firstname\":\"string\",\"lastName\":\"string\",\"custom_identify\":\"string\",\"company\":\"string\",\"phone\":\"string\",\"address\":\"string\",\"birthdate\":\"2019-08-24\",\"city\":\"string\",\"zipCode\":\"string\",\"province\":\"string\",\"country_id\":\"string\",\"countryCode\":\"PL\",\"avatarUrl\":\"string\",\"sex\":\"0\",\"tags\":[\"string\"],\"additionalProperties\":null}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\",\\\"firstname\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"custom_identify\\\":\\\"string\\\",\\\"company\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"address\\\":\\\"string\\\",\\\"birthdate\\\":\\\"2019-08-24\\\",\\\"city\\\":\\\"string\\\",\\\"zipCode\\\":\\\"string\\\",\\\"province\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"countryCode\\\":\\\"PL\\\",\\\"avatarUrl\\\":\\\"string\\\",\\\"sex\\\":\\\"0\\\",\\\"tags\\\":[\\\"string\\\"],\\\"additionalProperties\\\":null}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"PUT\", \"/crm/v1/contacts/%7BclientId%7D\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"uuid\": \"07243772-008a-42e1-ba37-c3807cebde8f\",\n \"email\": \"string\",\n \"firstname\": \"string\",\n \"lastName\": \"string\",\n \"custom_identify\": \"string\",\n \"company\": \"string\",\n \"phone\": \"string\",\n \"address\": \"string\",\n \"birthdate\": \"2019-08-24\",\n \"city\": \"string\",\n \"zipCode\": \"string\",\n \"province\": \"string\",\n \"country_id\": \"string\",\n \"countryCode\": \"PL\",\n \"avatarUrl\": \"string\",\n \"sex\": \"0\",\n \"tags\": [\n \"string\"\n ],\n \"additionalProperties\": null\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"PUT\", \"https://api.synerise.com/crm/v1/contacts/%7BclientId%7D\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"PUT\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/crm/v1/contacts/%7BclientId%7D\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n uuid: '07243772-008a-42e1-ba37-c3807cebde8f',\n email: 'string',\n firstname: 'string',\n lastName: 'string',\n custom_identify: 'string',\n company: 'string',\n phone: 'string',\n address: 'string',\n birthdate: '2019-08-24',\n city: 'string',\n zipCode: 'string',\n province: 'string',\n country_id: 'string',\n countryCode: 'PL',\n avatarUrl: 'string',\n sex: '0',\n tags: ['string'],\n additionalProperties: null\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/crm/v1/contacts/%7BclientId%7D');\n$request->setMethod(HTTP_METH_PUT);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"uuid\":\"07243772-008a-42e1-ba37-c3807cebde8f\",\"email\":\"string\",\"firstname\":\"string\",\"lastName\":\"string\",\"custom_identify\":\"string\",\"company\":\"string\",\"phone\":\"string\",\"address\":\"string\",\"birthdate\":\"2019-08-24\",\"city\":\"string\",\"zipCode\":\"string\",\"province\":\"string\",\"country_id\":\"string\",\"countryCode\":\"PL\",\"avatarUrl\":\"string\",\"sex\":\"0\",\"tags\":[\"string\"],\"additionalProperties\":null}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.put(\"https://api.synerise.com/crm/v1/contacts/%7BclientId%7D\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"uuid\\\":\\\"07243772-008a-42e1-ba37-c3807cebde8f\\\",\\\"email\\\":\\\"string\\\",\\\"firstname\\\":\\\"string\\\",\\\"lastName\\\":\\\"string\\\",\\\"custom_identify\\\":\\\"string\\\",\\\"company\\\":\\\"string\\\",\\\"phone\\\":\\\"string\\\",\\\"address\\\":\\\"string\\\",\\\"birthdate\\\":\\\"2019-08-24\\\",\\\"city\\\":\\\"string\\\",\\\"zipCode\\\":\\\"string\\\",\\\"province\\\":\\\"string\\\",\\\"country_id\\\":\\\"string\\\",\\\"countryCode\\\":\\\"PL\\\",\\\"avatarUrl\\\":\\\"string\\\",\\\"sex\\\":\\\"0\\\",\\\"tags\\\":[\\\"string\\\"],\\\"additionalProperties\\\":null}\")\n .asString();"}]}},"/items/v2/filter/validate":{"post":{"summary":"Validate item filter","description":"This endpoint lets you validate the syntax of a filter and preview its results.\n\nThe `parserResult` object in the response validates only the IQL syntax, it does not check if the attributes or contexts referenced in the IQL query exist!\n\n\n---\n\n**API consumers:** Workspace (Business Profile), Synerise User\n\n**API key permission required:** `ITEMS_FILTER_VALIDATE_READ`\n\n**User role permission required:** `campaigns_recommendations: read`\n","operationId":"ValidateItemFilter","tags":["Item filters"],"security":[{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/items-filter-all-itemsCatalogId"},{"$ref":"#/components/parameters/items-filter-all-exampleItems"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-filter-all-ValidateItemsFilterRequestBody"}}}},"responses":{"200":{"description":"Validation response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-filter-all-FilterValidateResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-filter-all-Error"}}}},"500":{"description":"Service not available","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-filter-all-Error"}}}},"502":{"description":"Catalog not ready","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-filter-all-Error"}}}}},"x-snr-doc-urls":["/api-reference/ai-suite#tag/Item-filters/operation/ValidateItemFilter"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url 'https://api.synerise.com/items/v2/filter/validate?itemsCatalogId=SOME_STRING_VALUE&exampleItems=SOME_INTEGER_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"filteringString\":\"IF(\\\"abcd\\\" IN client.tags,discount == 0,discount > 0)\",\"clientUUID\":\"68df2317-0edb-4cc9-8b39-5ab68325f891\",\"contextItems\":[\"12345\"],\"inventoryContext\":{\"channelIds\":[\"string\"]},\"candidateItems\":[\"67890\"]}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"filteringString\\\":\\\"IF(\\\\\\\"abcd\\\\\\\" IN client.tags,discount == 0,discount > 0)\\\",\\\"clientUUID\\\":\\\"68df2317-0edb-4cc9-8b39-5ab68325f891\\\",\\\"contextItems\\\":[\\\"12345\\\"],\\\"inventoryContext\\\":{\\\"channelIds\\\":[\\\"string\\\"]},\\\"candidateItems\\\":[\\\"67890\\\"]}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/items/v2/filter/validate?itemsCatalogId=SOME_STRING_VALUE&exampleItems=SOME_INTEGER_VALUE\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"filteringString\": \"IF(\\\"abcd\\\" IN client.tags,discount == 0,discount > 0)\",\n \"clientUUID\": \"68df2317-0edb-4cc9-8b39-5ab68325f891\",\n \"contextItems\": [\n \"12345\"\n ],\n \"inventoryContext\": {\n \"channelIds\": [\n \"string\"\n ]\n },\n \"candidateItems\": [\n \"67890\"\n ]\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/items/v2/filter/validate?itemsCatalogId=SOME_STRING_VALUE&exampleItems=SOME_INTEGER_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/items/v2/filter/validate?itemsCatalogId=SOME_STRING_VALUE&exampleItems=SOME_INTEGER_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n filteringString: 'IF(\"abcd\" IN client.tags,discount == 0,discount > 0)',\n clientUUID: '68df2317-0edb-4cc9-8b39-5ab68325f891',\n contextItems: ['12345'],\n inventoryContext: {channelIds: ['string']},\n candidateItems: ['67890']\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/items/v2/filter/validate');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setQueryData([\n 'itemsCatalogId' => 'SOME_STRING_VALUE',\n 'exampleItems' => 'SOME_INTEGER_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"filteringString\":\"IF(\\\\\"abcd\\\\\" IN client.tags,discount == 0,discount > 0)\",\"clientUUID\":\"68df2317-0edb-4cc9-8b39-5ab68325f891\",\"contextItems\":[\"12345\"],\"inventoryContext\":{\"channelIds\":[\"string\"]},\"candidateItems\":[\"67890\"]}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/items/v2/filter/validate?itemsCatalogId=SOME_STRING_VALUE&exampleItems=SOME_INTEGER_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"filteringString\\\":\\\"IF(\\\\\\\"abcd\\\\\\\" IN client.tags,discount == 0,discount > 0)\\\",\\\"clientUUID\\\":\\\"68df2317-0edb-4cc9-8b39-5ab68325f891\\\",\\\"contextItems\\\":[\\\"12345\\\"],\\\"inventoryContext\\\":{\\\"channelIds\\\":[\\\"string\\\"]},\\\"candidateItems\\\":[\\\"67890\\\"]}\")\n .asString();"}]}},"/search/v2/indices/{indexId}/visual":{"get":{"summary":"Visual items search","description":"Retrieves items that match an image. The results can be filtered and sorted.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","operationId":"SearchVisualGet","tags":["Visual Search"],"security":[{"TrackerKey":[]},{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/items-search-imageUrl"},{"$ref":"#/components/parameters/items-search-inPathIndexId"},{"$ref":"#/components/parameters/items-search-clientUUID"},{"$ref":"#/components/parameters/items-search-personalize"},{"$ref":"#/components/parameters/items-search-correlationId"},{"$ref":"#/components/parameters/items-search-searchId"},{"$ref":"#/components/parameters/items-search-sortByMetric"},{"$ref":"#/components/parameters/items-search-sortByGeoPoint"},{"$ref":"#/components/parameters/items-search-filterGeoPoints"},{"$ref":"#/components/parameters/items-search-filterAroundRadius"},{"$ref":"#/components/parameters/items-search-filterAnchor"},{"$ref":"#/components/parameters/items-search-filters"},{"$ref":"#/components/parameters/items-search-facets"},{"$ref":"#/components/parameters/items-search-facetsSize"},{"$ref":"#/components/parameters/items-search-maxValuesPerFacet"},{"$ref":"#/components/parameters/items-search-caseSensitiveFacetValues"},{"$ref":"#/components/parameters/items-search-displayAttributes"},{"$ref":"#/components/parameters/items-search-context"},{"$ref":"#/components/parameters/items-search-includeFacets"},{"$ref":"#/components/parameters/items-search-facetsOrderBy"},{"$ref":"#/components/parameters/items-search-paginationPage"},{"$ref":"#/components/parameters/items-search-paginationLimit"},{"$ref":"#/components/parameters/items-search-paginationSortBy"},{"$ref":"#/components/parameters/items-search-paginationOrdering"},{"$ref":"#/components/parameters/items-search-paginationIncludeMeta"},{"$ref":"#/components/parameters/items-search-ignoreQueryRules"},{"$ref":"#/components/parameters/items-search-excludeQueryRules"},{"$ref":"#/components/parameters/items-search-params"}],"responses":{"200":{"description":"Search response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-VisualSearchResponse"}}}},"500":{"description":"Service not available","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-Error"}}}}},"x-snr-doc-urls":["/api-reference/ai-search#tag/Visual-Search/operation/SearchVisualGet"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/search/v2/indices/%7BindexId%7D/visual?url=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filterAnchor=0.2%2C0.8&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5¶ms=source%3Amobile' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/search/v2/indices/%7BindexId%7D/visual?url=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filterAnchor=0.2%2C0.8&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5¶ms=source%3Amobile\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/search/v2/indices/%7BindexId%7D/visual?url=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filterAnchor=0.2%2C0.8&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5¶ms=source%3Amobile\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/search/v2/indices/%7BindexId%7D/visual?url=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filterAnchor=0.2%2C0.8&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5¶ms=source%3Amobile\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/search/v2/indices/%7BindexId%7D/visual');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'url' => 'SOME_STRING_VALUE',\n 'clientUUID' => 'SOME_STRING_VALUE',\n 'personalize' => 'SOME_BOOLEAN_VALUE',\n 'correlationId' => 'SOME_STRING_VALUE',\n 'searchId' => 'SOME_STRING_VALUE',\n 'sortByMetric' => 'SOME_STRING_VALUE',\n 'sortByGeoPoint' => '34.052235,-118.243685',\n 'filterGeoPoints' => [\n '34.052235,-118.243685',\n '15.0,65.0'\n ],\n 'filterAroundRadius' => '5000',\n 'filterAnchor' => '0.2,0.8',\n 'filters' => 'SOME_STRING_VALUE',\n 'facets' => 'SOME_ARRAY_VALUE',\n 'facetsSize' => 'SOME_INTEGER_VALUE',\n 'maxValuesPerFacet' => 'SOME_INTEGER_VALUE',\n 'caseSensitiveFacetValues' => 'SOME_BOOLEAN_VALUE',\n 'displayAttributes' => [\n 'title',\n 'price'\n ],\n 'context' => [\n 'mobile',\n 'listing'\n ],\n 'includeFacets' => 'SOME_STRING_VALUE',\n 'facetsOrderBy' => 'SOME_STRING_VALUE',\n 'page' => '4',\n 'limit' => '10',\n 'sortBy' => 'SOME_STRING_VALUE',\n 'ordering' => 'SOME_STRING_VALUE',\n 'includeMeta' => 'SOME_BOOLEAN_VALUE',\n 'ignoreQueryRules' => 'SOME_BOOLEAN_VALUE',\n 'excludeQueryRules' => [\n '2',\n '5'\n ],\n 'params' => 'source:mobile'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/search/v2/indices/%7BindexId%7D/visual?url=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filterAnchor=0.2%2C0.8&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5¶ms=source%3Amobile\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]},"post":{"summary":"Visual items search","description":"Retrieves items that match an image. The results can be filtered and sorted.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","operationId":"SearchVisualPost","tags":["Visual Search"],"security":[{"TrackerKey":[]},{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/items-search-inPathIndexId"}],"requestBody":{"description":"Request for performing visual search","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-VisualSearchRequest"}},"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary","description":"Uploaded image to be used in the visual search"},"params":{"type":"object","description":"Parameters of the search","properties":{"page":{"$ref":"#/components/schemas/items-search-PaginationPage"},"limit":{"$ref":"#/components/schemas/items-search-PaginationLimit"},"sortBy":{"$ref":"#/components/schemas/items-search-PaginationSortBy"},"ordering":{"$ref":"#/components/schemas/items-search-PaginationOrdering"},"includeMeta":{"$ref":"#/components/schemas/items-search-PaginationIncludeMeta"},"clientUUID":{"$ref":"#/components/schemas/items-search-ClientUUID"},"correlationId":{"$ref":"#/components/schemas/items-search-CorrelationId"},"searchId":{"$ref":"#/components/schemas/items-search-SearchId"},"sortByMetric":{"$ref":"#/components/schemas/items-search-SortByMetric"},"sortByGeoPoints":{"$ref":"#/components/schemas/items-search-SortByGeoPoint"},"filterGeoPoints":{"$ref":"#/components/schemas/items-search-FilterGeoPoints"},"filterAroundRadius":{"$ref":"#/components/schemas/items-search-FilterAroundRadius"},"filterAnchor":{"$ref":"#/components/schemas/items-search-FilterAnchor"},"filters":{"$ref":"#/components/schemas/items-search-Filters"},"facets":{"$ref":"#/components/schemas/items-search-Facets"},"facetsSize":{"$ref":"#/components/schemas/items-search-FacetsSize"},"maxValuesPerFacet":{"$ref":"#/components/schemas/items-search-MaxValuesPerFacet"},"caseSensitiveFacetValues":{"$ref":"#/components/schemas/items-search-CaseSensitiveFacetValues"},"includeFacets":{"$ref":"#/components/schemas/items-search-IncludeFacets"},"facetsOrderBy":{"$ref":"#/components/schemas/items-search-FacetsOrdering"},"context":{"$ref":"#/components/schemas/items-search-Context"},"displayAttributes":{"$ref":"#/components/schemas/items-search-DisplayAttributes"},"ignoreQueryRules":{"$ref":"#/components/schemas/items-search-IgnoreQueryRules"},"excludeQueryRules":{"$ref":"#/components/schemas/items-search-ExcludeQueryRules"},"params":{"$ref":"#/components/schemas/items-search-Params"}}}}}}}},"responses":{"200":{"description":"Search response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-VisualSearchResponse"}}}},"500":{"description":"Service not available","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-Error"}}}}},"x-snr-doc-urls":["/api-reference/ai-search#tag/Visual-Search/operation/SearchVisualPost"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/search/v2/indices/%7BindexId%7D/visual \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"url\":\"string\",\"page\":0,\"limit\":10,\"sortBy\":\"string\",\"ordering\":\"desc\",\"includeMeta\":true,\"clientUUID\":\"string\",\"personalize\":true,\"correlationId\":\"string\",\"searchId\":\"string\",\"sortByMetric\":\"TransactionsPopularity\",\"sortByGeoPoints\":\"34.052235,-118.243685\",\"filterGeoPoints\":[\"34.052235,-118.243685\",\"15.0,65.0\"],\"filterAroundRadius\":2000,\"filterAnchor\":\"0.2,0.8\",\"filters\":\"string\",\"facets\":[\"string\"],\"customFilteredFacets\":{\"brand\":\"price > 100\",\"price\":\"brand == foo\"},\"facetsSize\":2000,\"maxValuesPerFacet\":50,\"caseSensitiveFacetValues\":false,\"includeFacets\":\"all\",\"facetsOrderBy\":\"coverage\",\"context\":[\"mobile\",\"listing\"],\"displayAttributes\":[\"title\",\"price\"],\"ignoreQueryRules\":false,\"excludeQueryRules\":[2,5],\"params\":{\"source\":\"mobile\"}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"url\\\":\\\"string\\\",\\\"page\\\":0,\\\"limit\\\":10,\\\"sortBy\\\":\\\"string\\\",\\\"ordering\\\":\\\"desc\\\",\\\"includeMeta\\\":true,\\\"clientUUID\\\":\\\"string\\\",\\\"personalize\\\":true,\\\"correlationId\\\":\\\"string\\\",\\\"searchId\\\":\\\"string\\\",\\\"sortByMetric\\\":\\\"TransactionsPopularity\\\",\\\"sortByGeoPoints\\\":\\\"34.052235,-118.243685\\\",\\\"filterGeoPoints\\\":[\\\"34.052235,-118.243685\\\",\\\"15.0,65.0\\\"],\\\"filterAroundRadius\\\":2000,\\\"filterAnchor\\\":\\\"0.2,0.8\\\",\\\"filters\\\":\\\"string\\\",\\\"facets\\\":[\\\"string\\\"],\\\"customFilteredFacets\\\":{\\\"brand\\\":\\\"price > 100\\\",\\\"price\\\":\\\"brand == foo\\\"},\\\"facetsSize\\\":2000,\\\"maxValuesPerFacet\\\":50,\\\"caseSensitiveFacetValues\\\":false,\\\"includeFacets\\\":\\\"all\\\",\\\"facetsOrderBy\\\":\\\"coverage\\\",\\\"context\\\":[\\\"mobile\\\",\\\"listing\\\"],\\\"displayAttributes\\\":[\\\"title\\\",\\\"price\\\"],\\\"ignoreQueryRules\\\":false,\\\"excludeQueryRules\\\":[2,5],\\\"params\\\":{\\\"source\\\":\\\"mobile\\\"}}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/search/v2/indices/%7BindexId%7D/visual\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"url\": \"string\",\n \"page\": 0,\n \"limit\": 10,\n \"sortBy\": \"string\",\n \"ordering\": \"desc\",\n \"includeMeta\": true,\n \"clientUUID\": \"string\",\n \"personalize\": true,\n \"correlationId\": \"string\",\n \"searchId\": \"string\",\n \"sortByMetric\": \"TransactionsPopularity\",\n \"sortByGeoPoints\": \"34.052235,-118.243685\",\n \"filterGeoPoints\": [\n \"34.052235,-118.243685\",\n \"15.0,65.0\"\n ],\n \"filterAroundRadius\": 2000,\n \"filterAnchor\": \"0.2,0.8\",\n \"filters\": \"string\",\n \"facets\": [\n \"string\"\n ],\n \"customFilteredFacets\": {\n \"brand\": \"price > 100\",\n \"price\": \"brand == foo\"\n },\n \"facetsSize\": 2000,\n \"maxValuesPerFacet\": 50,\n \"caseSensitiveFacetValues\": false,\n \"includeFacets\": \"all\",\n \"facetsOrderBy\": \"coverage\",\n \"context\": [\n \"mobile\",\n \"listing\"\n ],\n \"displayAttributes\": [\n \"title\",\n \"price\"\n ],\n \"ignoreQueryRules\": false,\n \"excludeQueryRules\": [\n 2,\n 5\n ],\n \"params\": {\n \"source\": \"mobile\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/search/v2/indices/%7BindexId%7D/visual\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/search/v2/indices/%7BindexId%7D/visual\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n url: 'string',\n page: 0,\n limit: 10,\n sortBy: 'string',\n ordering: 'desc',\n includeMeta: true,\n clientUUID: 'string',\n personalize: true,\n correlationId: 'string',\n searchId: 'string',\n sortByMetric: 'TransactionsPopularity',\n sortByGeoPoints: '34.052235,-118.243685',\n filterGeoPoints: ['34.052235,-118.243685', '15.0,65.0'],\n filterAroundRadius: 2000,\n filterAnchor: '0.2,0.8',\n filters: 'string',\n facets: ['string'],\n customFilteredFacets: {brand: 'price > 100', price: 'brand == foo'},\n facetsSize: 2000,\n maxValuesPerFacet: 50,\n caseSensitiveFacetValues: false,\n includeFacets: 'all',\n facetsOrderBy: 'coverage',\n context: ['mobile', 'listing'],\n displayAttributes: ['title', 'price'],\n ignoreQueryRules: false,\n excludeQueryRules: [2, 5],\n params: {source: 'mobile'}\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/search/v2/indices/%7BindexId%7D/visual');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"url\":\"string\",\"page\":0,\"limit\":10,\"sortBy\":\"string\",\"ordering\":\"desc\",\"includeMeta\":true,\"clientUUID\":\"string\",\"personalize\":true,\"correlationId\":\"string\",\"searchId\":\"string\",\"sortByMetric\":\"TransactionsPopularity\",\"sortByGeoPoints\":\"34.052235,-118.243685\",\"filterGeoPoints\":[\"34.052235,-118.243685\",\"15.0,65.0\"],\"filterAroundRadius\":2000,\"filterAnchor\":\"0.2,0.8\",\"filters\":\"string\",\"facets\":[\"string\"],\"customFilteredFacets\":{\"brand\":\"price > 100\",\"price\":\"brand == foo\"},\"facetsSize\":2000,\"maxValuesPerFacet\":50,\"caseSensitiveFacetValues\":false,\"includeFacets\":\"all\",\"facetsOrderBy\":\"coverage\",\"context\":[\"mobile\",\"listing\"],\"displayAttributes\":[\"title\",\"price\"],\"ignoreQueryRules\":false,\"excludeQueryRules\":[2,5],\"params\":{\"source\":\"mobile\"}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/search/v2/indices/%7BindexId%7D/visual\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"url\\\":\\\"string\\\",\\\"page\\\":0,\\\"limit\\\":10,\\\"sortBy\\\":\\\"string\\\",\\\"ordering\\\":\\\"desc\\\",\\\"includeMeta\\\":true,\\\"clientUUID\\\":\\\"string\\\",\\\"personalize\\\":true,\\\"correlationId\\\":\\\"string\\\",\\\"searchId\\\":\\\"string\\\",\\\"sortByMetric\\\":\\\"TransactionsPopularity\\\",\\\"sortByGeoPoints\\\":\\\"34.052235,-118.243685\\\",\\\"filterGeoPoints\\\":[\\\"34.052235,-118.243685\\\",\\\"15.0,65.0\\\"],\\\"filterAroundRadius\\\":2000,\\\"filterAnchor\\\":\\\"0.2,0.8\\\",\\\"filters\\\":\\\"string\\\",\\\"facets\\\":[\\\"string\\\"],\\\"customFilteredFacets\\\":{\\\"brand\\\":\\\"price > 100\\\",\\\"price\\\":\\\"brand == foo\\\"},\\\"facetsSize\\\":2000,\\\"maxValuesPerFacet\\\":50,\\\"caseSensitiveFacetValues\\\":false,\\\"includeFacets\\\":\\\"all\\\",\\\"facetsOrderBy\\\":\\\"coverage\\\",\\\"context\\\":[\\\"mobile\\\",\\\"listing\\\"],\\\"displayAttributes\\\":[\\\"title\\\",\\\"price\\\"],\\\"ignoreQueryRules\\\":false,\\\"excludeQueryRules\\\":[2,5],\\\"params\\\":{\\\"source\\\":\\\"mobile\\\"}}\")\n .asString();"},{"lang":"shell_curl","label":"Shell + Curl","source":"curl --request POST \\\n --url https://api.synerise.com/search/v2/indices/%7BindexId%7D/visual \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: multipart/form-data' \\\n --form image=string \\\n --form 'params={\"page\":0,\"limit\":10,\"sortBy\":\"string\",\"ordering\":\"desc\",\"includeMeta\":true,\"clientUUID\":\"string\",\"correlationId\":\"string\",\"searchId\":\"string\",\"sortByMetric\":\"TransactionsPopularity\",\"sortByGeoPoints\":\"34.052235,-118.243685\",\"filterGeoPoints\":[\"34.052235,-118.243685\",\"15.0,65.0\"],\"filterAroundRadius\":2000,\"filterAnchor\":\"0.2,0.8\",\"filters\":\"string\",\"facets\":[\"string\"],\"facetsSize\":2000,\"maxValuesPerFacet\":50,\"caseSensitiveFacetValues\":false,\"includeFacets\":\"all\",\"facetsOrderBy\":\"coverage\",\"context\":[\"mobile\",\"listing\"],\"displayAttributes\":[\"title\",\"price\"],\"ignoreQueryRules\":false,\"excludeQueryRules\":[2,5],\"params\":{\"source\":\"mobile\"}}'"},{"lang":"python_python3","label":"Python + Python3","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"-----011000010111000001101001\\r\\nContent-Disposition: form-data; name=\\\"image\\\"\\r\\n\\r\\nstring\\r\\n-----011000010111000001101001\\r\\nContent-Disposition: form-data; name=\\\"params\\\"\\r\\n\\r\\n{\\\"page\\\":0,\\\"limit\\\":10,\\\"sortBy\\\":\\\"string\\\",\\\"ordering\\\":\\\"desc\\\",\\\"includeMeta\\\":true,\\\"clientUUID\\\":\\\"string\\\",\\\"correlationId\\\":\\\"string\\\",\\\"searchId\\\":\\\"string\\\",\\\"sortByMetric\\\":\\\"TransactionsPopularity\\\",\\\"sortByGeoPoints\\\":\\\"34.052235,-118.243685\\\",\\\"filterGeoPoints\\\":[\\\"34.052235,-118.243685\\\",\\\"15.0,65.0\\\"],\\\"filterAroundRadius\\\":2000,\\\"filterAnchor\\\":\\\"0.2,0.8\\\",\\\"filters\\\":\\\"string\\\",\\\"facets\\\":[\\\"string\\\"],\\\"facetsSize\\\":2000,\\\"maxValuesPerFacet\\\":50,\\\"caseSensitiveFacetValues\\\":false,\\\"includeFacets\\\":\\\"all\\\",\\\"facetsOrderBy\\\":\\\"coverage\\\",\\\"context\\\":[\\\"mobile\\\",\\\"listing\\\"],\\\"displayAttributes\\\":[\\\"title\\\",\\\"price\\\"],\\\"ignoreQueryRules\\\":false,\\\"excludeQueryRules\\\":[2,5],\\\"params\\\":{\\\"source\\\":\\\"mobile\\\"}}\\r\\n-----011000010111000001101001--\\r\\n\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"multipart/form-data\"\n }\n\nconn.request(\"POST\", \"/search/v2/indices/%7BindexId%7D/visual\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"javascript_xhr","label":"Javascript + Xhr","source":"const data = new FormData();\ndata.append(\"image\", \"string\");\ndata.append(\"params\", \"{\\\"page\\\":0,\\\"limit\\\":10,\\\"sortBy\\\":\\\"string\\\",\\\"ordering\\\":\\\"desc\\\",\\\"includeMeta\\\":true,\\\"clientUUID\\\":\\\"string\\\",\\\"correlationId\\\":\\\"string\\\",\\\"searchId\\\":\\\"string\\\",\\\"sortByMetric\\\":\\\"TransactionsPopularity\\\",\\\"sortByGeoPoints\\\":\\\"34.052235,-118.243685\\\",\\\"filterGeoPoints\\\":[\\\"34.052235,-118.243685\\\",\\\"15.0,65.0\\\"],\\\"filterAroundRadius\\\":2000,\\\"filterAnchor\\\":\\\"0.2,0.8\\\",\\\"filters\\\":\\\"string\\\",\\\"facets\\\":[\\\"string\\\"],\\\"facetsSize\\\":2000,\\\"maxValuesPerFacet\\\":50,\\\"caseSensitiveFacetValues\\\":false,\\\"includeFacets\\\":\\\"all\\\",\\\"facetsOrderBy\\\":\\\"coverage\\\",\\\"context\\\":[\\\"mobile\\\",\\\"listing\\\"],\\\"displayAttributes\\\":[\\\"title\\\",\\\"price\\\"],\\\"ignoreQueryRules\\\":false,\\\"excludeQueryRules\\\":[2,5],\\\"params\\\":{\\\"source\\\":\\\"mobile\\\"}}\");\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/search/v2/indices/%7BindexId%7D/visual\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"node_native","label":"Node + Native","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/search/v2/indices/%7BindexId%7D/visual\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(\"-----011000010111000001101001\\r\\nContent-Disposition: form-data; name=\\\"image\\\"\\r\\n\\r\\nstring\\r\\n-----011000010111000001101001\\r\\nContent-Disposition: form-data; name=\\\"params\\\"\\r\\n\\r\\n{\\\"page\\\":0,\\\"limit\\\":10,\\\"sortBy\\\":\\\"string\\\",\\\"ordering\\\":\\\"desc\\\",\\\"includeMeta\\\":true,\\\"clientUUID\\\":\\\"string\\\",\\\"correlationId\\\":\\\"string\\\",\\\"searchId\\\":\\\"string\\\",\\\"sortByMetric\\\":\\\"TransactionsPopularity\\\",\\\"sortByGeoPoints\\\":\\\"34.052235,-118.243685\\\",\\\"filterGeoPoints\\\":[\\\"34.052235,-118.243685\\\",\\\"15.0,65.0\\\"],\\\"filterAroundRadius\\\":2000,\\\"filterAnchor\\\":\\\"0.2,0.8\\\",\\\"filters\\\":\\\"string\\\",\\\"facets\\\":[\\\"string\\\"],\\\"facetsSize\\\":2000,\\\"maxValuesPerFacet\\\":50,\\\"caseSensitiveFacetValues\\\":false,\\\"includeFacets\\\":\\\"all\\\",\\\"facetsOrderBy\\\":\\\"coverage\\\",\\\"context\\\":[\\\"mobile\\\",\\\"listing\\\"],\\\"displayAttributes\\\":[\\\"title\\\",\\\"price\\\"],\\\"ignoreQueryRules\\\":false,\\\"excludeQueryRules\\\":[2,5],\\\"params\\\":{\\\"source\\\":\\\"mobile\\\"}}\\r\\n-----011000010111000001101001--\\r\\n\");\nreq.end();"},{"lang":"php_http1","label":"Php + Http1","source":"setUrl('https://api.synerise.com/search/v2/indices/%7BindexId%7D/visual');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'multipart/form-data'\n]);\n\n$request->setBody('-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\nstring\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"params\"\r\n\r\n{\"page\":0,\"limit\":10,\"sortBy\":\"string\",\"ordering\":\"desc\",\"includeMeta\":true,\"clientUUID\":\"string\",\"correlationId\":\"string\",\"searchId\":\"string\",\"sortByMetric\":\"TransactionsPopularity\",\"sortByGeoPoints\":\"34.052235,-118.243685\",\"filterGeoPoints\":[\"34.052235,-118.243685\",\"15.0,65.0\"],\"filterAroundRadius\":2000,\"filterAnchor\":\"0.2,0.8\",\"filters\":\"string\",\"facets\":[\"string\"],\"facetsSize\":2000,\"maxValuesPerFacet\":50,\"caseSensitiveFacetValues\":false,\"includeFacets\":\"all\",\"facetsOrderBy\":\"coverage\",\"context\":[\"mobile\",\"listing\"],\"displayAttributes\":[\"title\",\"price\"],\"ignoreQueryRules\":false,\"excludeQueryRules\":[2,5],\"params\":{\"source\":\"mobile\"}}\r\n-----011000010111000001101001--\r\n');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"java_unirest","label":"Java + Unirest","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/search/v2/indices/%7BindexId%7D/visual\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .body(\"-----011000010111000001101001\\r\\nContent-Disposition: form-data; name=\\\"image\\\"\\r\\n\\r\\nstring\\r\\n-----011000010111000001101001\\r\\nContent-Disposition: form-data; name=\\\"params\\\"\\r\\n\\r\\n{\\\"page\\\":0,\\\"limit\\\":10,\\\"sortBy\\\":\\\"string\\\",\\\"ordering\\\":\\\"desc\\\",\\\"includeMeta\\\":true,\\\"clientUUID\\\":\\\"string\\\",\\\"correlationId\\\":\\\"string\\\",\\\"searchId\\\":\\\"string\\\",\\\"sortByMetric\\\":\\\"TransactionsPopularity\\\",\\\"sortByGeoPoints\\\":\\\"34.052235,-118.243685\\\",\\\"filterGeoPoints\\\":[\\\"34.052235,-118.243685\\\",\\\"15.0,65.0\\\"],\\\"filterAroundRadius\\\":2000,\\\"filterAnchor\\\":\\\"0.2,0.8\\\",\\\"filters\\\":\\\"string\\\",\\\"facets\\\":[\\\"string\\\"],\\\"facetsSize\\\":2000,\\\"maxValuesPerFacet\\\":50,\\\"caseSensitiveFacetValues\\\":false,\\\"includeFacets\\\":\\\"all\\\",\\\"facetsOrderBy\\\":\\\"coverage\\\",\\\"context\\\":[\\\"mobile\\\",\\\"listing\\\"],\\\"displayAttributes\\\":[\\\"title\\\",\\\"price\\\"],\\\"ignoreQueryRules\\\":false,\\\"excludeQueryRules\\\":[2,5],\\\"params\\\":{\\\"source\\\":\\\"mobile\\\"}}\\r\\n-----011000010111000001101001--\\r\\n\")\n .asString();"}]}},"/search/v2/indices/{indexId}/visual/explain":{"get":{"summary":"Explained visual items search","description":"Retrieves items that match an image. The results can be filtered and sorted. The response contains an explanation of the factors that influenced the result.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","operationId":"SearchVisualGetWithExplanation","tags":["Visual Search"],"security":[{"TrackerKey":[]},{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/items-search-imageUrl"},{"$ref":"#/components/parameters/items-search-inPathIndexId"},{"$ref":"#/components/parameters/items-search-clientUUID"},{"$ref":"#/components/parameters/items-search-personalize"},{"$ref":"#/components/parameters/items-search-correlationId"},{"$ref":"#/components/parameters/items-search-searchId"},{"$ref":"#/components/parameters/items-search-sortByMetric"},{"$ref":"#/components/parameters/items-search-sortByGeoPoint"},{"$ref":"#/components/parameters/items-search-filterGeoPoints"},{"$ref":"#/components/parameters/items-search-filterAroundRadius"},{"$ref":"#/components/parameters/items-search-filterAnchor"},{"$ref":"#/components/parameters/items-search-filters"},{"$ref":"#/components/parameters/items-search-facets"},{"$ref":"#/components/parameters/items-search-facetsSize"},{"$ref":"#/components/parameters/items-search-maxValuesPerFacet"},{"$ref":"#/components/parameters/items-search-caseSensitiveFacetValues"},{"$ref":"#/components/parameters/items-search-displayAttributes"},{"$ref":"#/components/parameters/items-search-context"},{"$ref":"#/components/parameters/items-search-includeFacets"},{"$ref":"#/components/parameters/items-search-facetsOrderBy"},{"$ref":"#/components/parameters/items-search-paginationPage"},{"$ref":"#/components/parameters/items-search-paginationLimit"},{"$ref":"#/components/parameters/items-search-paginationSortBy"},{"$ref":"#/components/parameters/items-search-paginationOrdering"},{"$ref":"#/components/parameters/items-search-paginationIncludeMeta"},{"$ref":"#/components/parameters/items-search-ignoreQueryRules"},{"$ref":"#/components/parameters/items-search-excludeQueryRules"},{"$ref":"#/components/parameters/items-search-crossWorkspaceModeEnabled"},{"$ref":"#/components/parameters/items-search-params"}],"responses":{"200":{"description":"Search response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-VisualSearchResponseWithExplanation"}}}},"500":{"description":"Service not available","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-Error"}}}}},"x-snr-doc-urls":["/api-reference/ai-search#tag/Visual-Search/operation/SearchVisualGetWithExplanation"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/search/v2/indices/%7BindexId%7D/visual/explain?url=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filterAnchor=0.2%2C0.8&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5&crossWorkspaceModeEnabled=SOME_BOOLEAN_VALUE¶ms=source%3Amobile' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/search/v2/indices/%7BindexId%7D/visual/explain?url=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filterAnchor=0.2%2C0.8&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5&crossWorkspaceModeEnabled=SOME_BOOLEAN_VALUE¶ms=source%3Amobile\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/search/v2/indices/%7BindexId%7D/visual/explain?url=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filterAnchor=0.2%2C0.8&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5&crossWorkspaceModeEnabled=SOME_BOOLEAN_VALUE¶ms=source%3Amobile\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/search/v2/indices/%7BindexId%7D/visual/explain?url=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filterAnchor=0.2%2C0.8&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5&crossWorkspaceModeEnabled=SOME_BOOLEAN_VALUE¶ms=source%3Amobile\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/search/v2/indices/%7BindexId%7D/visual/explain');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'url' => 'SOME_STRING_VALUE',\n 'clientUUID' => 'SOME_STRING_VALUE',\n 'personalize' => 'SOME_BOOLEAN_VALUE',\n 'correlationId' => 'SOME_STRING_VALUE',\n 'searchId' => 'SOME_STRING_VALUE',\n 'sortByMetric' => 'SOME_STRING_VALUE',\n 'sortByGeoPoint' => '34.052235,-118.243685',\n 'filterGeoPoints' => [\n '34.052235,-118.243685',\n '15.0,65.0'\n ],\n 'filterAroundRadius' => '5000',\n 'filterAnchor' => '0.2,0.8',\n 'filters' => 'SOME_STRING_VALUE',\n 'facets' => 'SOME_ARRAY_VALUE',\n 'facetsSize' => 'SOME_INTEGER_VALUE',\n 'maxValuesPerFacet' => 'SOME_INTEGER_VALUE',\n 'caseSensitiveFacetValues' => 'SOME_BOOLEAN_VALUE',\n 'displayAttributes' => [\n 'title',\n 'price'\n ],\n 'context' => [\n 'mobile',\n 'listing'\n ],\n 'includeFacets' => 'SOME_STRING_VALUE',\n 'facetsOrderBy' => 'SOME_STRING_VALUE',\n 'page' => '4',\n 'limit' => '10',\n 'sortBy' => 'SOME_STRING_VALUE',\n 'ordering' => 'SOME_STRING_VALUE',\n 'includeMeta' => 'SOME_BOOLEAN_VALUE',\n 'ignoreQueryRules' => 'SOME_BOOLEAN_VALUE',\n 'excludeQueryRules' => [\n '2',\n '5'\n ],\n 'crossWorkspaceModeEnabled' => 'SOME_BOOLEAN_VALUE',\n 'params' => 'source:mobile'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/search/v2/indices/%7BindexId%7D/visual/explain?url=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filterAnchor=0.2%2C0.8&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5&crossWorkspaceModeEnabled=SOME_BOOLEAN_VALUE¶ms=source%3Amobile\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]},"post":{"summary":"Explained visual items search","description":"Retrieves items that match an image. The results can be filtered and sorted. The response contains an explanation of the factors that influenced the result.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","operationId":"SearchVisualPostWithExplanation","tags":["Visual Search"],"security":[{"TrackerKey":[]},{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/items-search-inPathIndexId"}],"requestBody":{"description":"Request for performing visual search with explanation","required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/items-search-VisualSearchRequest"},{"type":"object","properties":{"crossWorkspaceMode":{"$ref":"#/components/schemas/items-search-CrossWorkspaceMode"}}}]}}}},"responses":{"200":{"description":"Search response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-VisualSearchResponseWithExplanation"}}}},"500":{"description":"Service not available","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-Error"}}}}},"x-snr-doc-urls":["/api-reference/ai-search#tag/Visual-Search/operation/SearchVisualPostWithExplanation"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/search/v2/indices/%7BindexId%7D/visual/explain \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"url\":\"string\",\"page\":0,\"limit\":10,\"sortBy\":\"string\",\"ordering\":\"desc\",\"includeMeta\":true,\"clientUUID\":\"string\",\"personalize\":true,\"correlationId\":\"string\",\"searchId\":\"string\",\"sortByMetric\":\"TransactionsPopularity\",\"sortByGeoPoints\":\"34.052235,-118.243685\",\"filterGeoPoints\":[\"34.052235,-118.243685\",\"15.0,65.0\"],\"filterAroundRadius\":2000,\"filterAnchor\":\"0.2,0.8\",\"filters\":\"string\",\"facets\":[\"string\"],\"customFilteredFacets\":{\"brand\":\"price > 100\",\"price\":\"brand == foo\"},\"facetsSize\":2000,\"maxValuesPerFacet\":50,\"caseSensitiveFacetValues\":false,\"includeFacets\":\"all\",\"facetsOrderBy\":\"coverage\",\"context\":[\"mobile\",\"listing\"],\"displayAttributes\":[\"title\",\"price\"],\"ignoreQueryRules\":false,\"excludeQueryRules\":[2,5],\"params\":{\"source\":\"mobile\"},\"crossWorkspaceMode\":{\"enabled\":true}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"url\\\":\\\"string\\\",\\\"page\\\":0,\\\"limit\\\":10,\\\"sortBy\\\":\\\"string\\\",\\\"ordering\\\":\\\"desc\\\",\\\"includeMeta\\\":true,\\\"clientUUID\\\":\\\"string\\\",\\\"personalize\\\":true,\\\"correlationId\\\":\\\"string\\\",\\\"searchId\\\":\\\"string\\\",\\\"sortByMetric\\\":\\\"TransactionsPopularity\\\",\\\"sortByGeoPoints\\\":\\\"34.052235,-118.243685\\\",\\\"filterGeoPoints\\\":[\\\"34.052235,-118.243685\\\",\\\"15.0,65.0\\\"],\\\"filterAroundRadius\\\":2000,\\\"filterAnchor\\\":\\\"0.2,0.8\\\",\\\"filters\\\":\\\"string\\\",\\\"facets\\\":[\\\"string\\\"],\\\"customFilteredFacets\\\":{\\\"brand\\\":\\\"price > 100\\\",\\\"price\\\":\\\"brand == foo\\\"},\\\"facetsSize\\\":2000,\\\"maxValuesPerFacet\\\":50,\\\"caseSensitiveFacetValues\\\":false,\\\"includeFacets\\\":\\\"all\\\",\\\"facetsOrderBy\\\":\\\"coverage\\\",\\\"context\\\":[\\\"mobile\\\",\\\"listing\\\"],\\\"displayAttributes\\\":[\\\"title\\\",\\\"price\\\"],\\\"ignoreQueryRules\\\":false,\\\"excludeQueryRules\\\":[2,5],\\\"params\\\":{\\\"source\\\":\\\"mobile\\\"},\\\"crossWorkspaceMode\\\":{\\\"enabled\\\":true}}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/search/v2/indices/%7BindexId%7D/visual/explain\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"url\": \"string\",\n \"page\": 0,\n \"limit\": 10,\n \"sortBy\": \"string\",\n \"ordering\": \"desc\",\n \"includeMeta\": true,\n \"clientUUID\": \"string\",\n \"personalize\": true,\n \"correlationId\": \"string\",\n \"searchId\": \"string\",\n \"sortByMetric\": \"TransactionsPopularity\",\n \"sortByGeoPoints\": \"34.052235,-118.243685\",\n \"filterGeoPoints\": [\n \"34.052235,-118.243685\",\n \"15.0,65.0\"\n ],\n \"filterAroundRadius\": 2000,\n \"filterAnchor\": \"0.2,0.8\",\n \"filters\": \"string\",\n \"facets\": [\n \"string\"\n ],\n \"customFilteredFacets\": {\n \"brand\": \"price > 100\",\n \"price\": \"brand == foo\"\n },\n \"facetsSize\": 2000,\n \"maxValuesPerFacet\": 50,\n \"caseSensitiveFacetValues\": false,\n \"includeFacets\": \"all\",\n \"facetsOrderBy\": \"coverage\",\n \"context\": [\n \"mobile\",\n \"listing\"\n ],\n \"displayAttributes\": [\n \"title\",\n \"price\"\n ],\n \"ignoreQueryRules\": false,\n \"excludeQueryRules\": [\n 2,\n 5\n ],\n \"params\": {\n \"source\": \"mobile\"\n },\n \"crossWorkspaceMode\": {\n \"enabled\": true\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/search/v2/indices/%7BindexId%7D/visual/explain\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/search/v2/indices/%7BindexId%7D/visual/explain\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n url: 'string',\n page: 0,\n limit: 10,\n sortBy: 'string',\n ordering: 'desc',\n includeMeta: true,\n clientUUID: 'string',\n personalize: true,\n correlationId: 'string',\n searchId: 'string',\n sortByMetric: 'TransactionsPopularity',\n sortByGeoPoints: '34.052235,-118.243685',\n filterGeoPoints: ['34.052235,-118.243685', '15.0,65.0'],\n filterAroundRadius: 2000,\n filterAnchor: '0.2,0.8',\n filters: 'string',\n facets: ['string'],\n customFilteredFacets: {brand: 'price > 100', price: 'brand == foo'},\n facetsSize: 2000,\n maxValuesPerFacet: 50,\n caseSensitiveFacetValues: false,\n includeFacets: 'all',\n facetsOrderBy: 'coverage',\n context: ['mobile', 'listing'],\n displayAttributes: ['title', 'price'],\n ignoreQueryRules: false,\n excludeQueryRules: [2, 5],\n params: {source: 'mobile'},\n crossWorkspaceMode: {enabled: true}\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/search/v2/indices/%7BindexId%7D/visual/explain');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"url\":\"string\",\"page\":0,\"limit\":10,\"sortBy\":\"string\",\"ordering\":\"desc\",\"includeMeta\":true,\"clientUUID\":\"string\",\"personalize\":true,\"correlationId\":\"string\",\"searchId\":\"string\",\"sortByMetric\":\"TransactionsPopularity\",\"sortByGeoPoints\":\"34.052235,-118.243685\",\"filterGeoPoints\":[\"34.052235,-118.243685\",\"15.0,65.0\"],\"filterAroundRadius\":2000,\"filterAnchor\":\"0.2,0.8\",\"filters\":\"string\",\"facets\":[\"string\"],\"customFilteredFacets\":{\"brand\":\"price > 100\",\"price\":\"brand == foo\"},\"facetsSize\":2000,\"maxValuesPerFacet\":50,\"caseSensitiveFacetValues\":false,\"includeFacets\":\"all\",\"facetsOrderBy\":\"coverage\",\"context\":[\"mobile\",\"listing\"],\"displayAttributes\":[\"title\",\"price\"],\"ignoreQueryRules\":false,\"excludeQueryRules\":[2,5],\"params\":{\"source\":\"mobile\"},\"crossWorkspaceMode\":{\"enabled\":true}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/search/v2/indices/%7BindexId%7D/visual/explain\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"url\\\":\\\"string\\\",\\\"page\\\":0,\\\"limit\\\":10,\\\"sortBy\\\":\\\"string\\\",\\\"ordering\\\":\\\"desc\\\",\\\"includeMeta\\\":true,\\\"clientUUID\\\":\\\"string\\\",\\\"personalize\\\":true,\\\"correlationId\\\":\\\"string\\\",\\\"searchId\\\":\\\"string\\\",\\\"sortByMetric\\\":\\\"TransactionsPopularity\\\",\\\"sortByGeoPoints\\\":\\\"34.052235,-118.243685\\\",\\\"filterGeoPoints\\\":[\\\"34.052235,-118.243685\\\",\\\"15.0,65.0\\\"],\\\"filterAroundRadius\\\":2000,\\\"filterAnchor\\\":\\\"0.2,0.8\\\",\\\"filters\\\":\\\"string\\\",\\\"facets\\\":[\\\"string\\\"],\\\"customFilteredFacets\\\":{\\\"brand\\\":\\\"price > 100\\\",\\\"price\\\":\\\"brand == foo\\\"},\\\"facetsSize\\\":2000,\\\"maxValuesPerFacet\\\":50,\\\"caseSensitiveFacetValues\\\":false,\\\"includeFacets\\\":\\\"all\\\",\\\"facetsOrderBy\\\":\\\"coverage\\\",\\\"context\\\":[\\\"mobile\\\",\\\"listing\\\"],\\\"displayAttributes\\\":[\\\"title\\\",\\\"price\\\"],\\\"ignoreQueryRules\\\":false,\\\"excludeQueryRules\\\":[2,5],\\\"params\\\":{\\\"source\\\":\\\"mobile\\\"},\\\"crossWorkspaceMode\\\":{\\\"enabled\\\":true}}\")\n .asString();"}]}},"/search/v2/indices/{indexId}/query":{"get":{"summary":"Full-text items search","description":"Retrieves items that match a full-text query from a search index or a suggestion index. The results can be filtered and sorted.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","operationId":"SearchFullTextGet","tags":["Search"],"security":[{"TrackerKey":[]},{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/items-search-searchQuery"},{"$ref":"#/components/parameters/items-search-inPathIndexId"},{"$ref":"#/components/parameters/items-search-clientUUID"},{"$ref":"#/components/parameters/items-search-personalize"},{"$ref":"#/components/parameters/items-search-correlationId"},{"$ref":"#/components/parameters/items-search-searchId"},{"$ref":"#/components/parameters/items-search-sortByMetric"},{"$ref":"#/components/parameters/items-search-sortByGeoPoint"},{"$ref":"#/components/parameters/items-search-filterGeoPoints"},{"$ref":"#/components/parameters/items-search-filterAroundRadius"},{"$ref":"#/components/parameters/items-search-filters"},{"$ref":"#/components/parameters/items-search-facets"},{"$ref":"#/components/parameters/items-search-facetsSize"},{"$ref":"#/components/parameters/items-search-maxValuesPerFacet"},{"$ref":"#/components/parameters/items-search-caseSensitiveFacetValues"},{"$ref":"#/components/parameters/items-search-displayAttributes"},{"$ref":"#/components/parameters/items-search-context"},{"$ref":"#/components/parameters/items-search-includeFacets"},{"$ref":"#/components/parameters/items-search-facetsOrderBy"},{"$ref":"#/components/parameters/items-search-paginationPage"},{"$ref":"#/components/parameters/items-search-paginationLimit"},{"$ref":"#/components/parameters/items-search-paginationSortBy"},{"$ref":"#/components/parameters/items-search-paginationOrdering"},{"$ref":"#/components/parameters/items-search-paginationIncludeMeta"},{"$ref":"#/components/parameters/items-search-distinctFilter"},{"$ref":"#/components/parameters/items-search-ignoreQueryRules"},{"$ref":"#/components/parameters/items-search-excludeQueryRules"},{"$ref":"#/components/parameters/items-search-disableQueryClassification"},{"$ref":"#/components/parameters/items-search-disableDynamicReranker"},{"$ref":"#/components/parameters/items-search-params"}],"responses":{"200":{"$ref":"#/components/responses/items-search-FullTextSearchResponse200"},"500":{"description":"Service not available","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-Error"}}}}},"x-snr-doc-urls":["/api-reference/ai-search#tag/Search/operation/SearchFullTextGet"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/search/v2/indices/%7BindexId%7D/query?query=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5&disableQueryClassification=SOME_BOOLEAN_VALUE&disableDynamicReranker=SOME_BOOLEAN_VALUE¶ms=source%3Amobile' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/search/v2/indices/%7BindexId%7D/query?query=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5&disableQueryClassification=SOME_BOOLEAN_VALUE&disableDynamicReranker=SOME_BOOLEAN_VALUE¶ms=source%3Amobile\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/search/v2/indices/%7BindexId%7D/query?query=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5&disableQueryClassification=SOME_BOOLEAN_VALUE&disableDynamicReranker=SOME_BOOLEAN_VALUE¶ms=source%3Amobile\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/search/v2/indices/%7BindexId%7D/query?query=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5&disableQueryClassification=SOME_BOOLEAN_VALUE&disableDynamicReranker=SOME_BOOLEAN_VALUE¶ms=source%3Amobile\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/search/v2/indices/%7BindexId%7D/query');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'query' => 'SOME_STRING_VALUE',\n 'clientUUID' => 'SOME_STRING_VALUE',\n 'personalize' => 'SOME_BOOLEAN_VALUE',\n 'correlationId' => 'SOME_STRING_VALUE',\n 'searchId' => 'SOME_STRING_VALUE',\n 'sortByMetric' => 'SOME_STRING_VALUE',\n 'sortByGeoPoint' => '34.052235,-118.243685',\n 'filterGeoPoints' => [\n '34.052235,-118.243685',\n '15.0,65.0'\n ],\n 'filterAroundRadius' => '5000',\n 'filters' => 'SOME_STRING_VALUE',\n 'facets' => 'SOME_ARRAY_VALUE',\n 'facetsSize' => 'SOME_INTEGER_VALUE',\n 'maxValuesPerFacet' => 'SOME_INTEGER_VALUE',\n 'caseSensitiveFacetValues' => 'SOME_BOOLEAN_VALUE',\n 'displayAttributes' => [\n 'title',\n 'price'\n ],\n 'context' => [\n 'mobile',\n 'listing'\n ],\n 'includeFacets' => 'SOME_STRING_VALUE',\n 'facetsOrderBy' => 'SOME_STRING_VALUE',\n 'page' => '4',\n 'limit' => '10',\n 'sortBy' => 'SOME_STRING_VALUE',\n 'ordering' => 'SOME_STRING_VALUE',\n 'includeMeta' => 'SOME_BOOLEAN_VALUE',\n 'distinctFilter' => '{\"attribute\": \"color\", \"maxNumItems\": 3}',\n 'ignoreQueryRules' => 'SOME_BOOLEAN_VALUE',\n 'excludeQueryRules' => [\n '2',\n '5'\n ],\n 'disableQueryClassification' => 'SOME_BOOLEAN_VALUE',\n 'disableDynamicReranker' => 'SOME_BOOLEAN_VALUE',\n 'params' => 'source:mobile'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/search/v2/indices/%7BindexId%7D/query?query=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5&disableQueryClassification=SOME_BOOLEAN_VALUE&disableDynamicReranker=SOME_BOOLEAN_VALUE¶ms=source%3Amobile\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]},"post":{"summary":"Full-text items search","description":"Retrieves items that match a full-text query from a search index or a suggestion index. The results can be filtered and sorted.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","operationId":"SearchFullTextPost","tags":["Search"],"security":[{"TrackerKey":[]},{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/items-search-inPathIndexId"}],"requestBody":{"description":"Request for performing full-text search","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-FullTextSearchRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/items-search-FullTextSearchResponse200"},"500":{"description":"Service not available","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-Error"}}}}},"x-snr-doc-urls":["/api-reference/ai-search#tag/Search/operation/SearchFullTextPost"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/search/v2/indices/%7BindexId%7D/query \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"query\":\"string\",\"page\":0,\"limit\":10,\"sortBy\":\"string\",\"ordering\":\"desc\",\"includeMeta\":true,\"clientUUID\":\"string\",\"personalize\":true,\"correlationId\":\"string\",\"searchId\":\"string\",\"sortByMetric\":\"TransactionsPopularity\",\"sortByGeoPoints\":\"34.052235,-118.243685\",\"filterGeoPoints\":[\"34.052235,-118.243685\",\"15.0,65.0\"],\"filterAroundRadius\":2000,\"filters\":\"string\",\"facets\":[\"string\"],\"customFilteredFacets\":{\"brand\":\"price > 100\",\"price\":\"brand == foo\"},\"facetsSize\":2000,\"maxValuesPerFacet\":50,\"caseSensitiveFacetValues\":false,\"includeFacets\":\"all\",\"facetsOrderBy\":\"coverage\",\"context\":[\"mobile\",\"listing\"],\"displayAttributes\":[\"title\",\"price\"],\"distinctFilter\":{\"attribute\":\"string\",\"maxNumItems\":1,\"levelRangeModifier\":0},\"ignoreQueryRules\":false,\"excludeQueryRules\":[2,5],\"params\":{\"source\":\"mobile\"},\"disableQueryClassification\":false,\"disableDynamicReranker\":false}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"query\\\":\\\"string\\\",\\\"page\\\":0,\\\"limit\\\":10,\\\"sortBy\\\":\\\"string\\\",\\\"ordering\\\":\\\"desc\\\",\\\"includeMeta\\\":true,\\\"clientUUID\\\":\\\"string\\\",\\\"personalize\\\":true,\\\"correlationId\\\":\\\"string\\\",\\\"searchId\\\":\\\"string\\\",\\\"sortByMetric\\\":\\\"TransactionsPopularity\\\",\\\"sortByGeoPoints\\\":\\\"34.052235,-118.243685\\\",\\\"filterGeoPoints\\\":[\\\"34.052235,-118.243685\\\",\\\"15.0,65.0\\\"],\\\"filterAroundRadius\\\":2000,\\\"filters\\\":\\\"string\\\",\\\"facets\\\":[\\\"string\\\"],\\\"customFilteredFacets\\\":{\\\"brand\\\":\\\"price > 100\\\",\\\"price\\\":\\\"brand == foo\\\"},\\\"facetsSize\\\":2000,\\\"maxValuesPerFacet\\\":50,\\\"caseSensitiveFacetValues\\\":false,\\\"includeFacets\\\":\\\"all\\\",\\\"facetsOrderBy\\\":\\\"coverage\\\",\\\"context\\\":[\\\"mobile\\\",\\\"listing\\\"],\\\"displayAttributes\\\":[\\\"title\\\",\\\"price\\\"],\\\"distinctFilter\\\":{\\\"attribute\\\":\\\"string\\\",\\\"maxNumItems\\\":1,\\\"levelRangeModifier\\\":0},\\\"ignoreQueryRules\\\":false,\\\"excludeQueryRules\\\":[2,5],\\\"params\\\":{\\\"source\\\":\\\"mobile\\\"},\\\"disableQueryClassification\\\":false,\\\"disableDynamicReranker\\\":false}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/search/v2/indices/%7BindexId%7D/query\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"query\": \"string\",\n \"page\": 0,\n \"limit\": 10,\n \"sortBy\": \"string\",\n \"ordering\": \"desc\",\n \"includeMeta\": true,\n \"clientUUID\": \"string\",\n \"personalize\": true,\n \"correlationId\": \"string\",\n \"searchId\": \"string\",\n \"sortByMetric\": \"TransactionsPopularity\",\n \"sortByGeoPoints\": \"34.052235,-118.243685\",\n \"filterGeoPoints\": [\n \"34.052235,-118.243685\",\n \"15.0,65.0\"\n ],\n \"filterAroundRadius\": 2000,\n \"filters\": \"string\",\n \"facets\": [\n \"string\"\n ],\n \"customFilteredFacets\": {\n \"brand\": \"price > 100\",\n \"price\": \"brand == foo\"\n },\n \"facetsSize\": 2000,\n \"maxValuesPerFacet\": 50,\n \"caseSensitiveFacetValues\": false,\n \"includeFacets\": \"all\",\n \"facetsOrderBy\": \"coverage\",\n \"context\": [\n \"mobile\",\n \"listing\"\n ],\n \"displayAttributes\": [\n \"title\",\n \"price\"\n ],\n \"distinctFilter\": {\n \"attribute\": \"string\",\n \"maxNumItems\": 1,\n \"levelRangeModifier\": 0\n },\n \"ignoreQueryRules\": false,\n \"excludeQueryRules\": [\n 2,\n 5\n ],\n \"params\": {\n \"source\": \"mobile\"\n },\n \"disableQueryClassification\": false,\n \"disableDynamicReranker\": false\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/search/v2/indices/%7BindexId%7D/query\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/search/v2/indices/%7BindexId%7D/query\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n query: 'string',\n page: 0,\n limit: 10,\n sortBy: 'string',\n ordering: 'desc',\n includeMeta: true,\n clientUUID: 'string',\n personalize: true,\n correlationId: 'string',\n searchId: 'string',\n sortByMetric: 'TransactionsPopularity',\n sortByGeoPoints: '34.052235,-118.243685',\n filterGeoPoints: ['34.052235,-118.243685', '15.0,65.0'],\n filterAroundRadius: 2000,\n filters: 'string',\n facets: ['string'],\n customFilteredFacets: {brand: 'price > 100', price: 'brand == foo'},\n facetsSize: 2000,\n maxValuesPerFacet: 50,\n caseSensitiveFacetValues: false,\n includeFacets: 'all',\n facetsOrderBy: 'coverage',\n context: ['mobile', 'listing'],\n displayAttributes: ['title', 'price'],\n distinctFilter: {attribute: 'string', maxNumItems: 1, levelRangeModifier: 0},\n ignoreQueryRules: false,\n excludeQueryRules: [2, 5],\n params: {source: 'mobile'},\n disableQueryClassification: false,\n disableDynamicReranker: false\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/search/v2/indices/%7BindexId%7D/query');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"query\":\"string\",\"page\":0,\"limit\":10,\"sortBy\":\"string\",\"ordering\":\"desc\",\"includeMeta\":true,\"clientUUID\":\"string\",\"personalize\":true,\"correlationId\":\"string\",\"searchId\":\"string\",\"sortByMetric\":\"TransactionsPopularity\",\"sortByGeoPoints\":\"34.052235,-118.243685\",\"filterGeoPoints\":[\"34.052235,-118.243685\",\"15.0,65.0\"],\"filterAroundRadius\":2000,\"filters\":\"string\",\"facets\":[\"string\"],\"customFilteredFacets\":{\"brand\":\"price > 100\",\"price\":\"brand == foo\"},\"facetsSize\":2000,\"maxValuesPerFacet\":50,\"caseSensitiveFacetValues\":false,\"includeFacets\":\"all\",\"facetsOrderBy\":\"coverage\",\"context\":[\"mobile\",\"listing\"],\"displayAttributes\":[\"title\",\"price\"],\"distinctFilter\":{\"attribute\":\"string\",\"maxNumItems\":1,\"levelRangeModifier\":0},\"ignoreQueryRules\":false,\"excludeQueryRules\":[2,5],\"params\":{\"source\":\"mobile\"},\"disableQueryClassification\":false,\"disableDynamicReranker\":false}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/search/v2/indices/%7BindexId%7D/query\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"query\\\":\\\"string\\\",\\\"page\\\":0,\\\"limit\\\":10,\\\"sortBy\\\":\\\"string\\\",\\\"ordering\\\":\\\"desc\\\",\\\"includeMeta\\\":true,\\\"clientUUID\\\":\\\"string\\\",\\\"personalize\\\":true,\\\"correlationId\\\":\\\"string\\\",\\\"searchId\\\":\\\"string\\\",\\\"sortByMetric\\\":\\\"TransactionsPopularity\\\",\\\"sortByGeoPoints\\\":\\\"34.052235,-118.243685\\\",\\\"filterGeoPoints\\\":[\\\"34.052235,-118.243685\\\",\\\"15.0,65.0\\\"],\\\"filterAroundRadius\\\":2000,\\\"filters\\\":\\\"string\\\",\\\"facets\\\":[\\\"string\\\"],\\\"customFilteredFacets\\\":{\\\"brand\\\":\\\"price > 100\\\",\\\"price\\\":\\\"brand == foo\\\"},\\\"facetsSize\\\":2000,\\\"maxValuesPerFacet\\\":50,\\\"caseSensitiveFacetValues\\\":false,\\\"includeFacets\\\":\\\"all\\\",\\\"facetsOrderBy\\\":\\\"coverage\\\",\\\"context\\\":[\\\"mobile\\\",\\\"listing\\\"],\\\"displayAttributes\\\":[\\\"title\\\",\\\"price\\\"],\\\"distinctFilter\\\":{\\\"attribute\\\":\\\"string\\\",\\\"maxNumItems\\\":1,\\\"levelRangeModifier\\\":0},\\\"ignoreQueryRules\\\":false,\\\"excludeQueryRules\\\":[2,5],\\\"params\\\":{\\\"source\\\":\\\"mobile\\\"},\\\"disableQueryClassification\\\":false,\\\"disableDynamicReranker\\\":false}\")\n .asString();"}]}},"/search/v2/indices/{indexId}/query/explain":{"get":{"summary":"Explained full-text items search","description":"Retrieves items that match a full-text query from a search index or a suggestion index. The results can be filtered and sorted. The response contains an explanation of the factors that influenced the result.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","operationId":"SearchFullTextGetWithExplanation","tags":["Search"],"security":[{"TrackerKey":[]},{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/items-search-searchQuery"},{"$ref":"#/components/parameters/items-search-inPathIndexId"},{"$ref":"#/components/parameters/items-search-clientUUID"},{"$ref":"#/components/parameters/items-search-personalize"},{"$ref":"#/components/parameters/items-search-correlationId"},{"$ref":"#/components/parameters/items-search-searchId"},{"$ref":"#/components/parameters/items-search-sortByMetric"},{"$ref":"#/components/parameters/items-search-sortByGeoPoint"},{"$ref":"#/components/parameters/items-search-filterGeoPoints"},{"$ref":"#/components/parameters/items-search-filterAroundRadius"},{"$ref":"#/components/parameters/items-search-filters"},{"$ref":"#/components/parameters/items-search-facets"},{"$ref":"#/components/parameters/items-search-facetsSize"},{"$ref":"#/components/parameters/items-search-maxValuesPerFacet"},{"$ref":"#/components/parameters/items-search-caseSensitiveFacetValues"},{"$ref":"#/components/parameters/items-search-displayAttributes"},{"$ref":"#/components/parameters/items-search-context"},{"$ref":"#/components/parameters/items-search-includeFacets"},{"$ref":"#/components/parameters/items-search-facetsOrderBy"},{"$ref":"#/components/parameters/items-search-paginationPage"},{"$ref":"#/components/parameters/items-search-paginationLimit"},{"$ref":"#/components/parameters/items-search-paginationSortBy"},{"$ref":"#/components/parameters/items-search-paginationOrdering"},{"$ref":"#/components/parameters/items-search-paginationIncludeMeta"},{"$ref":"#/components/parameters/items-search-distinctFilter"},{"$ref":"#/components/parameters/items-search-ignoreQueryRules"},{"$ref":"#/components/parameters/items-search-disableQueryClassification"},{"$ref":"#/components/parameters/items-search-disableDynamicReranker"},{"$ref":"#/components/parameters/items-search-excludeQueryRules"},{"$ref":"#/components/parameters/items-search-crossWorkspaceModeEnabled"},{"$ref":"#/components/parameters/items-search-params"}],"responses":{"200":{"$ref":"#/components/responses/items-search-FullTextSearchResponse200WithExplanation"},"500":{"description":"Service not available","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-Error"}}}}},"x-snr-doc-urls":["/api-reference/ai-search#tag/Search/operation/SearchFullTextGetWithExplanation"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/search/v2/indices/%7BindexId%7D/query/explain?query=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&disableQueryClassification=SOME_BOOLEAN_VALUE&disableDynamicReranker=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5&crossWorkspaceModeEnabled=SOME_BOOLEAN_VALUE¶ms=source%3Amobile' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/search/v2/indices/%7BindexId%7D/query/explain?query=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&disableQueryClassification=SOME_BOOLEAN_VALUE&disableDynamicReranker=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5&crossWorkspaceModeEnabled=SOME_BOOLEAN_VALUE¶ms=source%3Amobile\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/search/v2/indices/%7BindexId%7D/query/explain?query=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&disableQueryClassification=SOME_BOOLEAN_VALUE&disableDynamicReranker=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5&crossWorkspaceModeEnabled=SOME_BOOLEAN_VALUE¶ms=source%3Amobile\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/search/v2/indices/%7BindexId%7D/query/explain?query=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&disableQueryClassification=SOME_BOOLEAN_VALUE&disableDynamicReranker=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5&crossWorkspaceModeEnabled=SOME_BOOLEAN_VALUE¶ms=source%3Amobile\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/search/v2/indices/%7BindexId%7D/query/explain');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'query' => 'SOME_STRING_VALUE',\n 'clientUUID' => 'SOME_STRING_VALUE',\n 'personalize' => 'SOME_BOOLEAN_VALUE',\n 'correlationId' => 'SOME_STRING_VALUE',\n 'searchId' => 'SOME_STRING_VALUE',\n 'sortByMetric' => 'SOME_STRING_VALUE',\n 'sortByGeoPoint' => '34.052235,-118.243685',\n 'filterGeoPoints' => [\n '34.052235,-118.243685',\n '15.0,65.0'\n ],\n 'filterAroundRadius' => '5000',\n 'filters' => 'SOME_STRING_VALUE',\n 'facets' => 'SOME_ARRAY_VALUE',\n 'facetsSize' => 'SOME_INTEGER_VALUE',\n 'maxValuesPerFacet' => 'SOME_INTEGER_VALUE',\n 'caseSensitiveFacetValues' => 'SOME_BOOLEAN_VALUE',\n 'displayAttributes' => [\n 'title',\n 'price'\n ],\n 'context' => [\n 'mobile',\n 'listing'\n ],\n 'includeFacets' => 'SOME_STRING_VALUE',\n 'facetsOrderBy' => 'SOME_STRING_VALUE',\n 'page' => '4',\n 'limit' => '10',\n 'sortBy' => 'SOME_STRING_VALUE',\n 'ordering' => 'SOME_STRING_VALUE',\n 'includeMeta' => 'SOME_BOOLEAN_VALUE',\n 'distinctFilter' => '{\"attribute\": \"color\", \"maxNumItems\": 3}',\n 'ignoreQueryRules' => 'SOME_BOOLEAN_VALUE',\n 'disableQueryClassification' => 'SOME_BOOLEAN_VALUE',\n 'disableDynamicReranker' => 'SOME_BOOLEAN_VALUE',\n 'excludeQueryRules' => [\n '2',\n '5'\n ],\n 'crossWorkspaceModeEnabled' => 'SOME_BOOLEAN_VALUE',\n 'params' => 'source:mobile'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/search/v2/indices/%7BindexId%7D/query/explain?query=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&disableQueryClassification=SOME_BOOLEAN_VALUE&disableDynamicReranker=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5&crossWorkspaceModeEnabled=SOME_BOOLEAN_VALUE¶ms=source%3Amobile\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]},"post":{"summary":"Explained full-text items search","description":"Retrieves items that match a full-text query from a search index or a suggestion index. The results can be filtered and sorted. The response contains an explanation of the factors that influenced the result.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","operationId":"SearchFullTextPostWithExplanation","tags":["Search"],"security":[{"TrackerKey":[]},{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/items-search-inPathIndexId"}],"requestBody":{"description":"Request for performing full-text search with explanation","required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/items-search-FullTextSearchRequest"},{"type":"object","properties":{"crossWorkspaceMode":{"$ref":"#/components/schemas/items-search-CrossWorkspaceMode"}}}]}}}},"responses":{"200":{"$ref":"#/components/responses/items-search-FullTextSearchResponse200WithExplanation"},"500":{"description":"Service not available","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-Error"}}}}},"x-snr-doc-urls":["/api-reference/ai-search#tag/Search/operation/SearchFullTextPostWithExplanation"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/search/v2/indices/%7BindexId%7D/query/explain \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"query\":\"string\",\"page\":0,\"limit\":10,\"sortBy\":\"string\",\"ordering\":\"desc\",\"includeMeta\":true,\"clientUUID\":\"string\",\"personalize\":true,\"correlationId\":\"string\",\"searchId\":\"string\",\"sortByMetric\":\"TransactionsPopularity\",\"sortByGeoPoints\":\"34.052235,-118.243685\",\"filterGeoPoints\":[\"34.052235,-118.243685\",\"15.0,65.0\"],\"filterAroundRadius\":2000,\"filters\":\"string\",\"facets\":[\"string\"],\"customFilteredFacets\":{\"brand\":\"price > 100\",\"price\":\"brand == foo\"},\"facetsSize\":2000,\"maxValuesPerFacet\":50,\"caseSensitiveFacetValues\":false,\"includeFacets\":\"all\",\"facetsOrderBy\":\"coverage\",\"context\":[\"mobile\",\"listing\"],\"displayAttributes\":[\"title\",\"price\"],\"distinctFilter\":{\"attribute\":\"string\",\"maxNumItems\":1,\"levelRangeModifier\":0},\"ignoreQueryRules\":false,\"excludeQueryRules\":[2,5],\"params\":{\"source\":\"mobile\"},\"disableQueryClassification\":false,\"disableDynamicReranker\":false,\"crossWorkspaceMode\":{\"enabled\":true}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"query\\\":\\\"string\\\",\\\"page\\\":0,\\\"limit\\\":10,\\\"sortBy\\\":\\\"string\\\",\\\"ordering\\\":\\\"desc\\\",\\\"includeMeta\\\":true,\\\"clientUUID\\\":\\\"string\\\",\\\"personalize\\\":true,\\\"correlationId\\\":\\\"string\\\",\\\"searchId\\\":\\\"string\\\",\\\"sortByMetric\\\":\\\"TransactionsPopularity\\\",\\\"sortByGeoPoints\\\":\\\"34.052235,-118.243685\\\",\\\"filterGeoPoints\\\":[\\\"34.052235,-118.243685\\\",\\\"15.0,65.0\\\"],\\\"filterAroundRadius\\\":2000,\\\"filters\\\":\\\"string\\\",\\\"facets\\\":[\\\"string\\\"],\\\"customFilteredFacets\\\":{\\\"brand\\\":\\\"price > 100\\\",\\\"price\\\":\\\"brand == foo\\\"},\\\"facetsSize\\\":2000,\\\"maxValuesPerFacet\\\":50,\\\"caseSensitiveFacetValues\\\":false,\\\"includeFacets\\\":\\\"all\\\",\\\"facetsOrderBy\\\":\\\"coverage\\\",\\\"context\\\":[\\\"mobile\\\",\\\"listing\\\"],\\\"displayAttributes\\\":[\\\"title\\\",\\\"price\\\"],\\\"distinctFilter\\\":{\\\"attribute\\\":\\\"string\\\",\\\"maxNumItems\\\":1,\\\"levelRangeModifier\\\":0},\\\"ignoreQueryRules\\\":false,\\\"excludeQueryRules\\\":[2,5],\\\"params\\\":{\\\"source\\\":\\\"mobile\\\"},\\\"disableQueryClassification\\\":false,\\\"disableDynamicReranker\\\":false,\\\"crossWorkspaceMode\\\":{\\\"enabled\\\":true}}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/search/v2/indices/%7BindexId%7D/query/explain\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"query\": \"string\",\n \"page\": 0,\n \"limit\": 10,\n \"sortBy\": \"string\",\n \"ordering\": \"desc\",\n \"includeMeta\": true,\n \"clientUUID\": \"string\",\n \"personalize\": true,\n \"correlationId\": \"string\",\n \"searchId\": \"string\",\n \"sortByMetric\": \"TransactionsPopularity\",\n \"sortByGeoPoints\": \"34.052235,-118.243685\",\n \"filterGeoPoints\": [\n \"34.052235,-118.243685\",\n \"15.0,65.0\"\n ],\n \"filterAroundRadius\": 2000,\n \"filters\": \"string\",\n \"facets\": [\n \"string\"\n ],\n \"customFilteredFacets\": {\n \"brand\": \"price > 100\",\n \"price\": \"brand == foo\"\n },\n \"facetsSize\": 2000,\n \"maxValuesPerFacet\": 50,\n \"caseSensitiveFacetValues\": false,\n \"includeFacets\": \"all\",\n \"facetsOrderBy\": \"coverage\",\n \"context\": [\n \"mobile\",\n \"listing\"\n ],\n \"displayAttributes\": [\n \"title\",\n \"price\"\n ],\n \"distinctFilter\": {\n \"attribute\": \"string\",\n \"maxNumItems\": 1,\n \"levelRangeModifier\": 0\n },\n \"ignoreQueryRules\": false,\n \"excludeQueryRules\": [\n 2,\n 5\n ],\n \"params\": {\n \"source\": \"mobile\"\n },\n \"disableQueryClassification\": false,\n \"disableDynamicReranker\": false,\n \"crossWorkspaceMode\": {\n \"enabled\": true\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/search/v2/indices/%7BindexId%7D/query/explain\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/search/v2/indices/%7BindexId%7D/query/explain\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n query: 'string',\n page: 0,\n limit: 10,\n sortBy: 'string',\n ordering: 'desc',\n includeMeta: true,\n clientUUID: 'string',\n personalize: true,\n correlationId: 'string',\n searchId: 'string',\n sortByMetric: 'TransactionsPopularity',\n sortByGeoPoints: '34.052235,-118.243685',\n filterGeoPoints: ['34.052235,-118.243685', '15.0,65.0'],\n filterAroundRadius: 2000,\n filters: 'string',\n facets: ['string'],\n customFilteredFacets: {brand: 'price > 100', price: 'brand == foo'},\n facetsSize: 2000,\n maxValuesPerFacet: 50,\n caseSensitiveFacetValues: false,\n includeFacets: 'all',\n facetsOrderBy: 'coverage',\n context: ['mobile', 'listing'],\n displayAttributes: ['title', 'price'],\n distinctFilter: {attribute: 'string', maxNumItems: 1, levelRangeModifier: 0},\n ignoreQueryRules: false,\n excludeQueryRules: [2, 5],\n params: {source: 'mobile'},\n disableQueryClassification: false,\n disableDynamicReranker: false,\n crossWorkspaceMode: {enabled: true}\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/search/v2/indices/%7BindexId%7D/query/explain');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"query\":\"string\",\"page\":0,\"limit\":10,\"sortBy\":\"string\",\"ordering\":\"desc\",\"includeMeta\":true,\"clientUUID\":\"string\",\"personalize\":true,\"correlationId\":\"string\",\"searchId\":\"string\",\"sortByMetric\":\"TransactionsPopularity\",\"sortByGeoPoints\":\"34.052235,-118.243685\",\"filterGeoPoints\":[\"34.052235,-118.243685\",\"15.0,65.0\"],\"filterAroundRadius\":2000,\"filters\":\"string\",\"facets\":[\"string\"],\"customFilteredFacets\":{\"brand\":\"price > 100\",\"price\":\"brand == foo\"},\"facetsSize\":2000,\"maxValuesPerFacet\":50,\"caseSensitiveFacetValues\":false,\"includeFacets\":\"all\",\"facetsOrderBy\":\"coverage\",\"context\":[\"mobile\",\"listing\"],\"displayAttributes\":[\"title\",\"price\"],\"distinctFilter\":{\"attribute\":\"string\",\"maxNumItems\":1,\"levelRangeModifier\":0},\"ignoreQueryRules\":false,\"excludeQueryRules\":[2,5],\"params\":{\"source\":\"mobile\"},\"disableQueryClassification\":false,\"disableDynamicReranker\":false,\"crossWorkspaceMode\":{\"enabled\":true}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/search/v2/indices/%7BindexId%7D/query/explain\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"query\\\":\\\"string\\\",\\\"page\\\":0,\\\"limit\\\":10,\\\"sortBy\\\":\\\"string\\\",\\\"ordering\\\":\\\"desc\\\",\\\"includeMeta\\\":true,\\\"clientUUID\\\":\\\"string\\\",\\\"personalize\\\":true,\\\"correlationId\\\":\\\"string\\\",\\\"searchId\\\":\\\"string\\\",\\\"sortByMetric\\\":\\\"TransactionsPopularity\\\",\\\"sortByGeoPoints\\\":\\\"34.052235,-118.243685\\\",\\\"filterGeoPoints\\\":[\\\"34.052235,-118.243685\\\",\\\"15.0,65.0\\\"],\\\"filterAroundRadius\\\":2000,\\\"filters\\\":\\\"string\\\",\\\"facets\\\":[\\\"string\\\"],\\\"customFilteredFacets\\\":{\\\"brand\\\":\\\"price > 100\\\",\\\"price\\\":\\\"brand == foo\\\"},\\\"facetsSize\\\":2000,\\\"maxValuesPerFacet\\\":50,\\\"caseSensitiveFacetValues\\\":false,\\\"includeFacets\\\":\\\"all\\\",\\\"facetsOrderBy\\\":\\\"coverage\\\",\\\"context\\\":[\\\"mobile\\\",\\\"listing\\\"],\\\"displayAttributes\\\":[\\\"title\\\",\\\"price\\\"],\\\"distinctFilter\\\":{\\\"attribute\\\":\\\"string\\\",\\\"maxNumItems\\\":1,\\\"levelRangeModifier\\\":0},\\\"ignoreQueryRules\\\":false,\\\"excludeQueryRules\\\":[2,5],\\\"params\\\":{\\\"source\\\":\\\"mobile\\\"},\\\"disableQueryClassification\\\":false,\\\"disableDynamicReranker\\\":false,\\\"crossWorkspaceMode\\\":{\\\"enabled\\\":true}}\")\n .asString();"}]}},"/search/v2/indices/{indexId}/autocomplete":{"get":{"summary":"Autocomplete items search","description":"Retrieves items that match a query from a search index or a suggestion index. The results can be filtered and sorted. The results of this search type are not cached.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","operationId":"SearchAutocompleteGet","tags":["Search"],"security":[{"TrackerKey":[]},{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/items-search-searchQuery"},{"$ref":"#/components/parameters/items-search-inPathIndexId"},{"$ref":"#/components/parameters/items-search-clientUUID"},{"$ref":"#/components/parameters/items-search-personalize"},{"$ref":"#/components/parameters/items-search-sortByMetric"},{"$ref":"#/components/parameters/items-search-sortByGeoPoint"},{"$ref":"#/components/parameters/items-search-filterGeoPoints"},{"$ref":"#/components/parameters/items-search-filterAroundRadius"},{"$ref":"#/components/parameters/items-search-filters"},{"$ref":"#/components/parameters/items-search-facets"},{"$ref":"#/components/parameters/items-search-facetsSize"},{"$ref":"#/components/parameters/items-search-maxValuesPerFacet"},{"$ref":"#/components/parameters/items-search-caseSensitiveFacetValues"},{"$ref":"#/components/parameters/items-search-displayAttributes"},{"$ref":"#/components/parameters/items-search-context"},{"$ref":"#/components/parameters/items-search-includeFacets"},{"$ref":"#/components/parameters/items-search-facetsOrderBy"},{"$ref":"#/components/parameters/items-search-paginationPage"},{"$ref":"#/components/parameters/items-search-paginationLimit"},{"$ref":"#/components/parameters/items-search-paginationSortBy"},{"$ref":"#/components/parameters/items-search-paginationOrdering"},{"$ref":"#/components/parameters/items-search-paginationIncludeMeta"},{"$ref":"#/components/parameters/items-search-distinctFilter"},{"$ref":"#/components/parameters/items-search-ignoreQueryRules"},{"$ref":"#/components/parameters/items-search-excludeQueryRules"},{"$ref":"#/components/parameters/items-search-params"},{"$ref":"#/components/parameters/items-search-disableQueryClassification"},{"$ref":"#/components/parameters/items-search-disableDynamicReranker"}],"responses":{"200":{"$ref":"#/components/responses/items-search-AutocompleteSearchResponse200"},"500":{"description":"Service not available","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-Error"}}}}},"x-snr-doc-urls":["/api-reference/ai-search#tag/Search/operation/SearchAutocompleteGet"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/search/v2/indices/%7BindexId%7D/autocomplete?query=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5¶ms=source%3Amobile&disableQueryClassification=SOME_BOOLEAN_VALUE&disableDynamicReranker=SOME_BOOLEAN_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/search/v2/indices/%7BindexId%7D/autocomplete?query=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5¶ms=source%3Amobile&disableQueryClassification=SOME_BOOLEAN_VALUE&disableDynamicReranker=SOME_BOOLEAN_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/search/v2/indices/%7BindexId%7D/autocomplete?query=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5¶ms=source%3Amobile&disableQueryClassification=SOME_BOOLEAN_VALUE&disableDynamicReranker=SOME_BOOLEAN_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/search/v2/indices/%7BindexId%7D/autocomplete?query=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5¶ms=source%3Amobile&disableQueryClassification=SOME_BOOLEAN_VALUE&disableDynamicReranker=SOME_BOOLEAN_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/search/v2/indices/%7BindexId%7D/autocomplete');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'query' => 'SOME_STRING_VALUE',\n 'clientUUID' => 'SOME_STRING_VALUE',\n 'personalize' => 'SOME_BOOLEAN_VALUE',\n 'sortByMetric' => 'SOME_STRING_VALUE',\n 'sortByGeoPoint' => '34.052235,-118.243685',\n 'filterGeoPoints' => [\n '34.052235,-118.243685',\n '15.0,65.0'\n ],\n 'filterAroundRadius' => '5000',\n 'filters' => 'SOME_STRING_VALUE',\n 'facets' => 'SOME_ARRAY_VALUE',\n 'facetsSize' => 'SOME_INTEGER_VALUE',\n 'maxValuesPerFacet' => 'SOME_INTEGER_VALUE',\n 'caseSensitiveFacetValues' => 'SOME_BOOLEAN_VALUE',\n 'displayAttributes' => [\n 'title',\n 'price'\n ],\n 'context' => [\n 'mobile',\n 'listing'\n ],\n 'includeFacets' => 'SOME_STRING_VALUE',\n 'facetsOrderBy' => 'SOME_STRING_VALUE',\n 'page' => '4',\n 'limit' => '10',\n 'sortBy' => 'SOME_STRING_VALUE',\n 'ordering' => 'SOME_STRING_VALUE',\n 'includeMeta' => 'SOME_BOOLEAN_VALUE',\n 'distinctFilter' => '{\"attribute\": \"color\", \"maxNumItems\": 3}',\n 'ignoreQueryRules' => 'SOME_BOOLEAN_VALUE',\n 'excludeQueryRules' => [\n '2',\n '5'\n ],\n 'params' => 'source:mobile',\n 'disableQueryClassification' => 'SOME_BOOLEAN_VALUE',\n 'disableDynamicReranker' => 'SOME_BOOLEAN_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/search/v2/indices/%7BindexId%7D/autocomplete?query=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5¶ms=source%3Amobile&disableQueryClassification=SOME_BOOLEAN_VALUE&disableDynamicReranker=SOME_BOOLEAN_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]},"post":{"summary":"Autocomplete items search","description":"Retrieves items that match a query from a search index or a suggestion index. The results can be filtered and sorted. The results of this search type are not cached.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","operationId":"SearchAutocompletePost","tags":["Search"],"security":[{"TrackerKey":[]},{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/items-search-inPathIndexId"}],"requestBody":{"description":"Request for performing an autocomplete search","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-AutocompleteRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/items-search-AutocompleteSearchResponse200"},"500":{"description":"Service not available","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-Error"}}}}},"x-snr-doc-urls":["/api-reference/ai-search#tag/Search/operation/SearchAutocompletePost"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/search/v2/indices/%7BindexId%7D/autocomplete \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"query\":\"string\",\"page\":0,\"limit\":10,\"sortBy\":\"string\",\"ordering\":\"desc\",\"includeMeta\":true,\"clientUUID\":\"string\",\"sortByMetric\":\"TransactionsPopularity\",\"sortByGeoPoints\":\"34.052235,-118.243685\",\"filterGeoPoints\":[\"34.052235,-118.243685\",\"15.0,65.0\"],\"filterAroundRadius\":2000,\"filters\":\"string\",\"facets\":[\"string\"],\"customFilteredFacets\":{\"brand\":\"price > 100\",\"price\":\"brand == foo\"},\"facetsSize\":2000,\"maxValuesPerFacet\":50,\"caseSensitiveFacetValues\":false,\"includeFacets\":\"all\",\"facetsOrderBy\":\"coverage\",\"context\":[\"mobile\",\"listing\"],\"displayAttributes\":[\"title\",\"price\"],\"distinctFilter\":{\"attribute\":\"string\",\"maxNumItems\":1,\"levelRangeModifier\":0},\"ignoreQueryRules\":false,\"excludeQueryRules\":[2,5],\"params\":{\"source\":\"mobile\"},\"disableQueryClassification\":false,\"disableDynamicReranker\":false}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"query\\\":\\\"string\\\",\\\"page\\\":0,\\\"limit\\\":10,\\\"sortBy\\\":\\\"string\\\",\\\"ordering\\\":\\\"desc\\\",\\\"includeMeta\\\":true,\\\"clientUUID\\\":\\\"string\\\",\\\"sortByMetric\\\":\\\"TransactionsPopularity\\\",\\\"sortByGeoPoints\\\":\\\"34.052235,-118.243685\\\",\\\"filterGeoPoints\\\":[\\\"34.052235,-118.243685\\\",\\\"15.0,65.0\\\"],\\\"filterAroundRadius\\\":2000,\\\"filters\\\":\\\"string\\\",\\\"facets\\\":[\\\"string\\\"],\\\"customFilteredFacets\\\":{\\\"brand\\\":\\\"price > 100\\\",\\\"price\\\":\\\"brand == foo\\\"},\\\"facetsSize\\\":2000,\\\"maxValuesPerFacet\\\":50,\\\"caseSensitiveFacetValues\\\":false,\\\"includeFacets\\\":\\\"all\\\",\\\"facetsOrderBy\\\":\\\"coverage\\\",\\\"context\\\":[\\\"mobile\\\",\\\"listing\\\"],\\\"displayAttributes\\\":[\\\"title\\\",\\\"price\\\"],\\\"distinctFilter\\\":{\\\"attribute\\\":\\\"string\\\",\\\"maxNumItems\\\":1,\\\"levelRangeModifier\\\":0},\\\"ignoreQueryRules\\\":false,\\\"excludeQueryRules\\\":[2,5],\\\"params\\\":{\\\"source\\\":\\\"mobile\\\"},\\\"disableQueryClassification\\\":false,\\\"disableDynamicReranker\\\":false}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/search/v2/indices/%7BindexId%7D/autocomplete\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"query\": \"string\",\n \"page\": 0,\n \"limit\": 10,\n \"sortBy\": \"string\",\n \"ordering\": \"desc\",\n \"includeMeta\": true,\n \"clientUUID\": \"string\",\n \"sortByMetric\": \"TransactionsPopularity\",\n \"sortByGeoPoints\": \"34.052235,-118.243685\",\n \"filterGeoPoints\": [\n \"34.052235,-118.243685\",\n \"15.0,65.0\"\n ],\n \"filterAroundRadius\": 2000,\n \"filters\": \"string\",\n \"facets\": [\n \"string\"\n ],\n \"customFilteredFacets\": {\n \"brand\": \"price > 100\",\n \"price\": \"brand == foo\"\n },\n \"facetsSize\": 2000,\n \"maxValuesPerFacet\": 50,\n \"caseSensitiveFacetValues\": false,\n \"includeFacets\": \"all\",\n \"facetsOrderBy\": \"coverage\",\n \"context\": [\n \"mobile\",\n \"listing\"\n ],\n \"displayAttributes\": [\n \"title\",\n \"price\"\n ],\n \"distinctFilter\": {\n \"attribute\": \"string\",\n \"maxNumItems\": 1,\n \"levelRangeModifier\": 0\n },\n \"ignoreQueryRules\": false,\n \"excludeQueryRules\": [\n 2,\n 5\n ],\n \"params\": {\n \"source\": \"mobile\"\n },\n \"disableQueryClassification\": false,\n \"disableDynamicReranker\": false\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/search/v2/indices/%7BindexId%7D/autocomplete\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/search/v2/indices/%7BindexId%7D/autocomplete\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n query: 'string',\n page: 0,\n limit: 10,\n sortBy: 'string',\n ordering: 'desc',\n includeMeta: true,\n clientUUID: 'string',\n sortByMetric: 'TransactionsPopularity',\n sortByGeoPoints: '34.052235,-118.243685',\n filterGeoPoints: ['34.052235,-118.243685', '15.0,65.0'],\n filterAroundRadius: 2000,\n filters: 'string',\n facets: ['string'],\n customFilteredFacets: {brand: 'price > 100', price: 'brand == foo'},\n facetsSize: 2000,\n maxValuesPerFacet: 50,\n caseSensitiveFacetValues: false,\n includeFacets: 'all',\n facetsOrderBy: 'coverage',\n context: ['mobile', 'listing'],\n displayAttributes: ['title', 'price'],\n distinctFilter: {attribute: 'string', maxNumItems: 1, levelRangeModifier: 0},\n ignoreQueryRules: false,\n excludeQueryRules: [2, 5],\n params: {source: 'mobile'},\n disableQueryClassification: false,\n disableDynamicReranker: false\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/search/v2/indices/%7BindexId%7D/autocomplete');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"query\":\"string\",\"page\":0,\"limit\":10,\"sortBy\":\"string\",\"ordering\":\"desc\",\"includeMeta\":true,\"clientUUID\":\"string\",\"sortByMetric\":\"TransactionsPopularity\",\"sortByGeoPoints\":\"34.052235,-118.243685\",\"filterGeoPoints\":[\"34.052235,-118.243685\",\"15.0,65.0\"],\"filterAroundRadius\":2000,\"filters\":\"string\",\"facets\":[\"string\"],\"customFilteredFacets\":{\"brand\":\"price > 100\",\"price\":\"brand == foo\"},\"facetsSize\":2000,\"maxValuesPerFacet\":50,\"caseSensitiveFacetValues\":false,\"includeFacets\":\"all\",\"facetsOrderBy\":\"coverage\",\"context\":[\"mobile\",\"listing\"],\"displayAttributes\":[\"title\",\"price\"],\"distinctFilter\":{\"attribute\":\"string\",\"maxNumItems\":1,\"levelRangeModifier\":0},\"ignoreQueryRules\":false,\"excludeQueryRules\":[2,5],\"params\":{\"source\":\"mobile\"},\"disableQueryClassification\":false,\"disableDynamicReranker\":false}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/search/v2/indices/%7BindexId%7D/autocomplete\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"query\\\":\\\"string\\\",\\\"page\\\":0,\\\"limit\\\":10,\\\"sortBy\\\":\\\"string\\\",\\\"ordering\\\":\\\"desc\\\",\\\"includeMeta\\\":true,\\\"clientUUID\\\":\\\"string\\\",\\\"sortByMetric\\\":\\\"TransactionsPopularity\\\",\\\"sortByGeoPoints\\\":\\\"34.052235,-118.243685\\\",\\\"filterGeoPoints\\\":[\\\"34.052235,-118.243685\\\",\\\"15.0,65.0\\\"],\\\"filterAroundRadius\\\":2000,\\\"filters\\\":\\\"string\\\",\\\"facets\\\":[\\\"string\\\"],\\\"customFilteredFacets\\\":{\\\"brand\\\":\\\"price > 100\\\",\\\"price\\\":\\\"brand == foo\\\"},\\\"facetsSize\\\":2000,\\\"maxValuesPerFacet\\\":50,\\\"caseSensitiveFacetValues\\\":false,\\\"includeFacets\\\":\\\"all\\\",\\\"facetsOrderBy\\\":\\\"coverage\\\",\\\"context\\\":[\\\"mobile\\\",\\\"listing\\\"],\\\"displayAttributes\\\":[\\\"title\\\",\\\"price\\\"],\\\"distinctFilter\\\":{\\\"attribute\\\":\\\"string\\\",\\\"maxNumItems\\\":1,\\\"levelRangeModifier\\\":0},\\\"ignoreQueryRules\\\":false,\\\"excludeQueryRules\\\":[2,5],\\\"params\\\":{\\\"source\\\":\\\"mobile\\\"},\\\"disableQueryClassification\\\":false,\\\"disableDynamicReranker\\\":false}\")\n .asString();"}]}},"/search/v2/indices/{indexId}/autocomplete/explain":{"get":{"summary":"Explained autocomplete items search","description":"Retrieves items that match a query from a search index or a suggestion index. The results can be filtered and sorted. The results of this search type are not cached. The response contains an explanation of the factors that influenced the result.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","operationId":"SearchAutocompleteGetWithExplanation","tags":["Search"],"security":[{"TrackerKey":[]},{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/items-search-searchQuery"},{"$ref":"#/components/parameters/items-search-inPathIndexId"},{"$ref":"#/components/parameters/items-search-clientUUID"},{"$ref":"#/components/parameters/items-search-personalize"},{"$ref":"#/components/parameters/items-search-sortByMetric"},{"$ref":"#/components/parameters/items-search-sortByGeoPoint"},{"$ref":"#/components/parameters/items-search-filterGeoPoints"},{"$ref":"#/components/parameters/items-search-filterAroundRadius"},{"$ref":"#/components/parameters/items-search-filters"},{"$ref":"#/components/parameters/items-search-facets"},{"$ref":"#/components/parameters/items-search-facetsSize"},{"$ref":"#/components/parameters/items-search-maxValuesPerFacet"},{"$ref":"#/components/parameters/items-search-caseSensitiveFacetValues"},{"$ref":"#/components/parameters/items-search-displayAttributes"},{"$ref":"#/components/parameters/items-search-context"},{"$ref":"#/components/parameters/items-search-includeFacets"},{"$ref":"#/components/parameters/items-search-facetsOrderBy"},{"$ref":"#/components/parameters/items-search-paginationPage"},{"$ref":"#/components/parameters/items-search-paginationLimit"},{"$ref":"#/components/parameters/items-search-paginationSortBy"},{"$ref":"#/components/parameters/items-search-paginationOrdering"},{"$ref":"#/components/parameters/items-search-paginationIncludeMeta"},{"$ref":"#/components/parameters/items-search-distinctFilter"},{"$ref":"#/components/parameters/items-search-ignoreQueryRules"},{"$ref":"#/components/parameters/items-search-excludeQueryRules"},{"$ref":"#/components/parameters/items-search-crossWorkspaceModeEnabled"},{"$ref":"#/components/parameters/items-search-params"},{"$ref":"#/components/parameters/items-search-disableQueryClassification"},{"$ref":"#/components/parameters/items-search-disableDynamicReranker"}],"responses":{"200":{"$ref":"#/components/responses/items-search-AutocompleteSearchResponse200WithExplanation"},"500":{"description":"Service not available","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-Error"}}}}},"x-snr-doc-urls":["/api-reference/ai-search#tag/Search/operation/SearchAutocompleteGetWithExplanation"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/search/v2/indices/%7BindexId%7D/autocomplete/explain?query=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5&crossWorkspaceModeEnabled=SOME_BOOLEAN_VALUE¶ms=source%3Amobile&disableQueryClassification=SOME_BOOLEAN_VALUE&disableDynamicReranker=SOME_BOOLEAN_VALUE' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/search/v2/indices/%7BindexId%7D/autocomplete/explain?query=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5&crossWorkspaceModeEnabled=SOME_BOOLEAN_VALUE¶ms=source%3Amobile&disableQueryClassification=SOME_BOOLEAN_VALUE&disableDynamicReranker=SOME_BOOLEAN_VALUE\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/search/v2/indices/%7BindexId%7D/autocomplete/explain?query=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5&crossWorkspaceModeEnabled=SOME_BOOLEAN_VALUE¶ms=source%3Amobile&disableQueryClassification=SOME_BOOLEAN_VALUE&disableDynamicReranker=SOME_BOOLEAN_VALUE\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/search/v2/indices/%7BindexId%7D/autocomplete/explain?query=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5&crossWorkspaceModeEnabled=SOME_BOOLEAN_VALUE¶ms=source%3Amobile&disableQueryClassification=SOME_BOOLEAN_VALUE&disableDynamicReranker=SOME_BOOLEAN_VALUE\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/search/v2/indices/%7BindexId%7D/autocomplete/explain');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'query' => 'SOME_STRING_VALUE',\n 'clientUUID' => 'SOME_STRING_VALUE',\n 'personalize' => 'SOME_BOOLEAN_VALUE',\n 'sortByMetric' => 'SOME_STRING_VALUE',\n 'sortByGeoPoint' => '34.052235,-118.243685',\n 'filterGeoPoints' => [\n '34.052235,-118.243685',\n '15.0,65.0'\n ],\n 'filterAroundRadius' => '5000',\n 'filters' => 'SOME_STRING_VALUE',\n 'facets' => 'SOME_ARRAY_VALUE',\n 'facetsSize' => 'SOME_INTEGER_VALUE',\n 'maxValuesPerFacet' => 'SOME_INTEGER_VALUE',\n 'caseSensitiveFacetValues' => 'SOME_BOOLEAN_VALUE',\n 'displayAttributes' => [\n 'title',\n 'price'\n ],\n 'context' => [\n 'mobile',\n 'listing'\n ],\n 'includeFacets' => 'SOME_STRING_VALUE',\n 'facetsOrderBy' => 'SOME_STRING_VALUE',\n 'page' => '4',\n 'limit' => '10',\n 'sortBy' => 'SOME_STRING_VALUE',\n 'ordering' => 'SOME_STRING_VALUE',\n 'includeMeta' => 'SOME_BOOLEAN_VALUE',\n 'distinctFilter' => '{\"attribute\": \"color\", \"maxNumItems\": 3}',\n 'ignoreQueryRules' => 'SOME_BOOLEAN_VALUE',\n 'excludeQueryRules' => [\n '2',\n '5'\n ],\n 'crossWorkspaceModeEnabled' => 'SOME_BOOLEAN_VALUE',\n 'params' => 'source:mobile',\n 'disableQueryClassification' => 'SOME_BOOLEAN_VALUE',\n 'disableDynamicReranker' => 'SOME_BOOLEAN_VALUE'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/search/v2/indices/%7BindexId%7D/autocomplete/explain?query=SOME_STRING_VALUE&clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5&crossWorkspaceModeEnabled=SOME_BOOLEAN_VALUE¶ms=source%3Amobile&disableQueryClassification=SOME_BOOLEAN_VALUE&disableDynamicReranker=SOME_BOOLEAN_VALUE\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]},"post":{"summary":"Explained autocomplete items search","description":"Retrieves items that match a query from a search index or a suggestion index. The results can be filtered and sorted. The results of this search type are not cached. The response contains an explanation of the factors that influenced the result.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","operationId":"SearchAutocompletePostWithExplanation","tags":["Search"],"security":[{"TrackerKey":[]},{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/items-search-inPathIndexId"}],"requestBody":{"description":"Request for performing an autocomplete search with explanation","required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/items-search-AutocompleteRequest"},{"type":"object","properties":{"crossWorkspaceMode":{"$ref":"#/components/schemas/items-search-CrossWorkspaceMode"}}}]}}}},"responses":{"200":{"$ref":"#/components/responses/items-search-AutocompleteSearchResponse200WithExplanation"},"500":{"description":"Service not available","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-Error"}}}}},"x-snr-doc-urls":["/api-reference/ai-search#tag/Search/operation/SearchAutocompletePostWithExplanation"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/search/v2/indices/%7BindexId%7D/autocomplete/explain \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"query\":\"string\",\"page\":0,\"limit\":10,\"sortBy\":\"string\",\"ordering\":\"desc\",\"includeMeta\":true,\"clientUUID\":\"string\",\"sortByMetric\":\"TransactionsPopularity\",\"sortByGeoPoints\":\"34.052235,-118.243685\",\"filterGeoPoints\":[\"34.052235,-118.243685\",\"15.0,65.0\"],\"filterAroundRadius\":2000,\"filters\":\"string\",\"facets\":[\"string\"],\"customFilteredFacets\":{\"brand\":\"price > 100\",\"price\":\"brand == foo\"},\"facetsSize\":2000,\"maxValuesPerFacet\":50,\"caseSensitiveFacetValues\":false,\"includeFacets\":\"all\",\"facetsOrderBy\":\"coverage\",\"context\":[\"mobile\",\"listing\"],\"displayAttributes\":[\"title\",\"price\"],\"distinctFilter\":{\"attribute\":\"string\",\"maxNumItems\":1,\"levelRangeModifier\":0},\"ignoreQueryRules\":false,\"excludeQueryRules\":[2,5],\"params\":{\"source\":\"mobile\"},\"disableQueryClassification\":false,\"disableDynamicReranker\":false,\"crossWorkspaceMode\":{\"enabled\":true}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"query\\\":\\\"string\\\",\\\"page\\\":0,\\\"limit\\\":10,\\\"sortBy\\\":\\\"string\\\",\\\"ordering\\\":\\\"desc\\\",\\\"includeMeta\\\":true,\\\"clientUUID\\\":\\\"string\\\",\\\"sortByMetric\\\":\\\"TransactionsPopularity\\\",\\\"sortByGeoPoints\\\":\\\"34.052235,-118.243685\\\",\\\"filterGeoPoints\\\":[\\\"34.052235,-118.243685\\\",\\\"15.0,65.0\\\"],\\\"filterAroundRadius\\\":2000,\\\"filters\\\":\\\"string\\\",\\\"facets\\\":[\\\"string\\\"],\\\"customFilteredFacets\\\":{\\\"brand\\\":\\\"price > 100\\\",\\\"price\\\":\\\"brand == foo\\\"},\\\"facetsSize\\\":2000,\\\"maxValuesPerFacet\\\":50,\\\"caseSensitiveFacetValues\\\":false,\\\"includeFacets\\\":\\\"all\\\",\\\"facetsOrderBy\\\":\\\"coverage\\\",\\\"context\\\":[\\\"mobile\\\",\\\"listing\\\"],\\\"displayAttributes\\\":[\\\"title\\\",\\\"price\\\"],\\\"distinctFilter\\\":{\\\"attribute\\\":\\\"string\\\",\\\"maxNumItems\\\":1,\\\"levelRangeModifier\\\":0},\\\"ignoreQueryRules\\\":false,\\\"excludeQueryRules\\\":[2,5],\\\"params\\\":{\\\"source\\\":\\\"mobile\\\"},\\\"disableQueryClassification\\\":false,\\\"disableDynamicReranker\\\":false,\\\"crossWorkspaceMode\\\":{\\\"enabled\\\":true}}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/search/v2/indices/%7BindexId%7D/autocomplete/explain\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"query\": \"string\",\n \"page\": 0,\n \"limit\": 10,\n \"sortBy\": \"string\",\n \"ordering\": \"desc\",\n \"includeMeta\": true,\n \"clientUUID\": \"string\",\n \"sortByMetric\": \"TransactionsPopularity\",\n \"sortByGeoPoints\": \"34.052235,-118.243685\",\n \"filterGeoPoints\": [\n \"34.052235,-118.243685\",\n \"15.0,65.0\"\n ],\n \"filterAroundRadius\": 2000,\n \"filters\": \"string\",\n \"facets\": [\n \"string\"\n ],\n \"customFilteredFacets\": {\n \"brand\": \"price > 100\",\n \"price\": \"brand == foo\"\n },\n \"facetsSize\": 2000,\n \"maxValuesPerFacet\": 50,\n \"caseSensitiveFacetValues\": false,\n \"includeFacets\": \"all\",\n \"facetsOrderBy\": \"coverage\",\n \"context\": [\n \"mobile\",\n \"listing\"\n ],\n \"displayAttributes\": [\n \"title\",\n \"price\"\n ],\n \"distinctFilter\": {\n \"attribute\": \"string\",\n \"maxNumItems\": 1,\n \"levelRangeModifier\": 0\n },\n \"ignoreQueryRules\": false,\n \"excludeQueryRules\": [\n 2,\n 5\n ],\n \"params\": {\n \"source\": \"mobile\"\n },\n \"disableQueryClassification\": false,\n \"disableDynamicReranker\": false,\n \"crossWorkspaceMode\": {\n \"enabled\": true\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/search/v2/indices/%7BindexId%7D/autocomplete/explain\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/search/v2/indices/%7BindexId%7D/autocomplete/explain\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n query: 'string',\n page: 0,\n limit: 10,\n sortBy: 'string',\n ordering: 'desc',\n includeMeta: true,\n clientUUID: 'string',\n sortByMetric: 'TransactionsPopularity',\n sortByGeoPoints: '34.052235,-118.243685',\n filterGeoPoints: ['34.052235,-118.243685', '15.0,65.0'],\n filterAroundRadius: 2000,\n filters: 'string',\n facets: ['string'],\n customFilteredFacets: {brand: 'price > 100', price: 'brand == foo'},\n facetsSize: 2000,\n maxValuesPerFacet: 50,\n caseSensitiveFacetValues: false,\n includeFacets: 'all',\n facetsOrderBy: 'coverage',\n context: ['mobile', 'listing'],\n displayAttributes: ['title', 'price'],\n distinctFilter: {attribute: 'string', maxNumItems: 1, levelRangeModifier: 0},\n ignoreQueryRules: false,\n excludeQueryRules: [2, 5],\n params: {source: 'mobile'},\n disableQueryClassification: false,\n disableDynamicReranker: false,\n crossWorkspaceMode: {enabled: true}\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/search/v2/indices/%7BindexId%7D/autocomplete/explain');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"query\":\"string\",\"page\":0,\"limit\":10,\"sortBy\":\"string\",\"ordering\":\"desc\",\"includeMeta\":true,\"clientUUID\":\"string\",\"sortByMetric\":\"TransactionsPopularity\",\"sortByGeoPoints\":\"34.052235,-118.243685\",\"filterGeoPoints\":[\"34.052235,-118.243685\",\"15.0,65.0\"],\"filterAroundRadius\":2000,\"filters\":\"string\",\"facets\":[\"string\"],\"customFilteredFacets\":{\"brand\":\"price > 100\",\"price\":\"brand == foo\"},\"facetsSize\":2000,\"maxValuesPerFacet\":50,\"caseSensitiveFacetValues\":false,\"includeFacets\":\"all\",\"facetsOrderBy\":\"coverage\",\"context\":[\"mobile\",\"listing\"],\"displayAttributes\":[\"title\",\"price\"],\"distinctFilter\":{\"attribute\":\"string\",\"maxNumItems\":1,\"levelRangeModifier\":0},\"ignoreQueryRules\":false,\"excludeQueryRules\":[2,5],\"params\":{\"source\":\"mobile\"},\"disableQueryClassification\":false,\"disableDynamicReranker\":false,\"crossWorkspaceMode\":{\"enabled\":true}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/search/v2/indices/%7BindexId%7D/autocomplete/explain\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"query\\\":\\\"string\\\",\\\"page\\\":0,\\\"limit\\\":10,\\\"sortBy\\\":\\\"string\\\",\\\"ordering\\\":\\\"desc\\\",\\\"includeMeta\\\":true,\\\"clientUUID\\\":\\\"string\\\",\\\"sortByMetric\\\":\\\"TransactionsPopularity\\\",\\\"sortByGeoPoints\\\":\\\"34.052235,-118.243685\\\",\\\"filterGeoPoints\\\":[\\\"34.052235,-118.243685\\\",\\\"15.0,65.0\\\"],\\\"filterAroundRadius\\\":2000,\\\"filters\\\":\\\"string\\\",\\\"facets\\\":[\\\"string\\\"],\\\"customFilteredFacets\\\":{\\\"brand\\\":\\\"price > 100\\\",\\\"price\\\":\\\"brand == foo\\\"},\\\"facetsSize\\\":2000,\\\"maxValuesPerFacet\\\":50,\\\"caseSensitiveFacetValues\\\":false,\\\"includeFacets\\\":\\\"all\\\",\\\"facetsOrderBy\\\":\\\"coverage\\\",\\\"context\\\":[\\\"mobile\\\",\\\"listing\\\"],\\\"displayAttributes\\\":[\\\"title\\\",\\\"price\\\"],\\\"distinctFilter\\\":{\\\"attribute\\\":\\\"string\\\",\\\"maxNumItems\\\":1,\\\"levelRangeModifier\\\":0},\\\"ignoreQueryRules\\\":false,\\\"excludeQueryRules\\\":[2,5],\\\"params\\\":{\\\"source\\\":\\\"mobile\\\"},\\\"disableQueryClassification\\\":false,\\\"disableDynamicReranker\\\":false,\\\"crossWorkspaceMode\\\":{\\\"enabled\\\":true}}\")\n .asString();"}]}},"/search/v2/indices/{indexId}/list":{"get":{"summary":"Items listing","description":"Retrieves item listing, which is a search without a query. The results can be filtered and sorted.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","operationId":"ListingGet","tags":["Listing"],"security":[{"TrackerKey":[]},{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/items-search-inPathIndexId"},{"$ref":"#/components/parameters/items-search-clientUUID"},{"$ref":"#/components/parameters/items-search-personalize"},{"$ref":"#/components/parameters/items-search-correlationId"},{"$ref":"#/components/parameters/items-search-searchId"},{"$ref":"#/components/parameters/items-search-sortByMetric"},{"$ref":"#/components/parameters/items-search-sortByGeoPoint"},{"$ref":"#/components/parameters/items-search-filterGeoPoints"},{"$ref":"#/components/parameters/items-search-filterAroundRadius"},{"$ref":"#/components/parameters/items-search-filters"},{"$ref":"#/components/parameters/items-search-facets"},{"$ref":"#/components/parameters/items-search-facetsSize"},{"$ref":"#/components/parameters/items-search-maxValuesPerFacet"},{"$ref":"#/components/parameters/items-search-caseSensitiveFacetValues"},{"$ref":"#/components/parameters/items-search-displayAttributes"},{"$ref":"#/components/parameters/items-search-context"},{"$ref":"#/components/parameters/items-search-includeFacets"},{"$ref":"#/components/parameters/items-search-facetsOrderBy"},{"$ref":"#/components/parameters/items-search-paginationPage"},{"$ref":"#/components/parameters/items-search-paginationLimit"},{"$ref":"#/components/parameters/items-search-paginationSortBy"},{"$ref":"#/components/parameters/items-search-paginationOrdering"},{"$ref":"#/components/parameters/items-search-paginationIncludeMeta"},{"$ref":"#/components/parameters/items-search-distinctFilter"},{"$ref":"#/components/parameters/items-search-ignoreQueryRules"},{"$ref":"#/components/parameters/items-search-excludeQueryRules"},{"$ref":"#/components/parameters/items-search-params"}],"responses":{"200":{"$ref":"#/components/responses/items-search-ListingResponse200"},"500":{"description":"Service not available","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-Error"}}}}},"x-snr-doc-urls":["/api-reference/ai-search#tag/Listing/operation/ListingGet"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request GET \\\n --url 'https://api.synerise.com/search/v2/indices/%7BindexId%7D/list?clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5¶ms=source%3Amobile' \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\nheaders = { 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\" }\n\nconn.request(\"GET\", \"/search/v2/indices/%7BindexId%7D/list?clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5¶ms=source%3Amobile\", headers=headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"GET\", \"https://api.synerise.com/search/v2/indices/%7BindexId%7D/list?clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5¶ms=source%3Amobile\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"GET\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/search/v2/indices/%7BindexId%7D/list?clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5¶ms=source%3Amobile\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/search/v2/indices/%7BindexId%7D/list');\n$request->setMethod(HTTP_METH_GET);\n\n$request->setQueryData([\n 'clientUUID' => 'SOME_STRING_VALUE',\n 'personalize' => 'SOME_BOOLEAN_VALUE',\n 'correlationId' => 'SOME_STRING_VALUE',\n 'searchId' => 'SOME_STRING_VALUE',\n 'sortByMetric' => 'SOME_STRING_VALUE',\n 'sortByGeoPoint' => '34.052235,-118.243685',\n 'filterGeoPoints' => [\n '34.052235,-118.243685',\n '15.0,65.0'\n ],\n 'filterAroundRadius' => '5000',\n 'filters' => 'SOME_STRING_VALUE',\n 'facets' => 'SOME_ARRAY_VALUE',\n 'facetsSize' => 'SOME_INTEGER_VALUE',\n 'maxValuesPerFacet' => 'SOME_INTEGER_VALUE',\n 'caseSensitiveFacetValues' => 'SOME_BOOLEAN_VALUE',\n 'displayAttributes' => [\n 'title',\n 'price'\n ],\n 'context' => [\n 'mobile',\n 'listing'\n ],\n 'includeFacets' => 'SOME_STRING_VALUE',\n 'facetsOrderBy' => 'SOME_STRING_VALUE',\n 'page' => '4',\n 'limit' => '10',\n 'sortBy' => 'SOME_STRING_VALUE',\n 'ordering' => 'SOME_STRING_VALUE',\n 'includeMeta' => 'SOME_BOOLEAN_VALUE',\n 'distinctFilter' => '{\"attribute\": \"color\", \"maxNumItems\": 3}',\n 'ignoreQueryRules' => 'SOME_BOOLEAN_VALUE',\n 'excludeQueryRules' => [\n '2',\n '5'\n ],\n 'params' => 'source:mobile'\n]);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN'\n]);\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.get(\"https://api.synerise.com/search/v2/indices/%7BindexId%7D/list?clientUUID=SOME_STRING_VALUE&personalize=SOME_BOOLEAN_VALUE&correlationId=SOME_STRING_VALUE&searchId=SOME_STRING_VALUE&sortByMetric=SOME_STRING_VALUE&sortByGeoPoint=34.052235%2C-118.243685&filterGeoPoints=34.052235%2C-118.243685&filterGeoPoints=15.0%2C65.0&filterAroundRadius=5000&filters=SOME_STRING_VALUE&facets=SOME_ARRAY_VALUE&facetsSize=SOME_INTEGER_VALUE&maxValuesPerFacet=SOME_INTEGER_VALUE&caseSensitiveFacetValues=SOME_BOOLEAN_VALUE&displayAttributes=title&displayAttributes=price&context=mobile&context=listing&includeFacets=SOME_STRING_VALUE&facetsOrderBy=SOME_STRING_VALUE&page=4&limit=10&sortBy=SOME_STRING_VALUE&ordering=SOME_STRING_VALUE&includeMeta=SOME_BOOLEAN_VALUE&distinctFilter=%7B%22attribute%22%3A%20%22color%22%2C%20%22maxNumItems%22%3A%203%7D&ignoreQueryRules=SOME_BOOLEAN_VALUE&excludeQueryRules=2&excludeQueryRules=5¶ms=source%3Amobile\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"}]},"post":{"summary":"Items listing","description":"Retrieves item listing, which is a search without a query. The results can be filtered and sorted.\n\n---\n\n**API consumers:** AI API key (legacy), Web SDK Tracker, Workspace (Business Profile)\n\n**API key permission required:** `ITEMS_SEARCH_SEARCH_READ`\n","operationId":"ListingPost","tags":["Listing"],"security":[{"TrackerKey":[]},{"JWT":[]}],"parameters":[{"$ref":"#/components/parameters/items-search-inPathIndexId"}],"requestBody":{"description":"Request for item listing","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-ListingRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/items-search-ListingResponse200"},"500":{"description":"Service not available","content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-search-Error"}}}}},"x-snr-doc-urls":["/api-reference/ai-search#tag/Listing/operation/ListingPost"],"x-codeSamples":[{"lang":"cURL","label":"cURL","source":"curl --request POST \\\n --url https://api.synerise.com/search/v2/indices/%7BindexId%7D/list \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"page\":0,\"limit\":10,\"sortBy\":\"string\",\"ordering\":\"desc\",\"includeMeta\":true,\"clientUUID\":\"string\",\"personalize\":true,\"correlationId\":\"string\",\"searchId\":\"string\",\"sortByMetric\":\"TransactionsPopularity\",\"sortByGeoPoints\":\"34.052235,-118.243685\",\"filterGeoPoints\":[\"34.052235,-118.243685\",\"15.0,65.0\"],\"filterAroundRadius\":2000,\"filters\":\"string\",\"facets\":[\"string\"],\"customFilteredFacets\":{\"brand\":\"price > 100\",\"price\":\"brand == foo\"},\"facetsSize\":2000,\"maxValuesPerFacet\":50,\"caseSensitiveFacetValues\":false,\"includeFacets\":\"all\",\"facetsOrderBy\":\"coverage\",\"context\":[\"mobile\",\"listing\"],\"displayAttributes\":[\"title\",\"price\"],\"distinctFilter\":{\"attribute\":\"string\",\"maxNumItems\":1,\"levelRangeModifier\":0},\"ignoreQueryRules\":false,\"excludeQueryRules\":[2,5],\"params\":{\"source\":\"mobile\"}}'"},{"lang":"Python","label":"Python","source":"import http.client\n\nconn = http.client.HTTPSConnection(\"api.synerise.com\")\n\npayload = \"{\\\"page\\\":0,\\\"limit\\\":10,\\\"sortBy\\\":\\\"string\\\",\\\"ordering\\\":\\\"desc\\\",\\\"includeMeta\\\":true,\\\"clientUUID\\\":\\\"string\\\",\\\"personalize\\\":true,\\\"correlationId\\\":\\\"string\\\",\\\"searchId\\\":\\\"string\\\",\\\"sortByMetric\\\":\\\"TransactionsPopularity\\\",\\\"sortByGeoPoints\\\":\\\"34.052235,-118.243685\\\",\\\"filterGeoPoints\\\":[\\\"34.052235,-118.243685\\\",\\\"15.0,65.0\\\"],\\\"filterAroundRadius\\\":2000,\\\"filters\\\":\\\"string\\\",\\\"facets\\\":[\\\"string\\\"],\\\"customFilteredFacets\\\":{\\\"brand\\\":\\\"price > 100\\\",\\\"price\\\":\\\"brand == foo\\\"},\\\"facetsSize\\\":2000,\\\"maxValuesPerFacet\\\":50,\\\"caseSensitiveFacetValues\\\":false,\\\"includeFacets\\\":\\\"all\\\",\\\"facetsOrderBy\\\":\\\"coverage\\\",\\\"context\\\":[\\\"mobile\\\",\\\"listing\\\"],\\\"displayAttributes\\\":[\\\"title\\\",\\\"price\\\"],\\\"distinctFilter\\\":{\\\"attribute\\\":\\\"string\\\",\\\"maxNumItems\\\":1,\\\"levelRangeModifier\\\":0},\\\"ignoreQueryRules\\\":false,\\\"excludeQueryRules\\\":[2,5],\\\"params\\\":{\\\"source\\\":\\\"mobile\\\"}}\"\n\nheaders = {\n 'Authorization': \"Bearer REPLACE_BEARER_TOKEN\",\n 'content-type': \"application/json\"\n }\n\nconn.request(\"POST\", \"/search/v2/indices/%7BindexId%7D/list\", payload, headers)\n\nres = conn.getresponse()\ndata = res.read()\n\nprint(data.decode(\"utf-8\"))"},{"lang":"JavaScript","label":"JavaScript","source":"const data = JSON.stringify({\n \"page\": 0,\n \"limit\": 10,\n \"sortBy\": \"string\",\n \"ordering\": \"desc\",\n \"includeMeta\": true,\n \"clientUUID\": \"string\",\n \"personalize\": true,\n \"correlationId\": \"string\",\n \"searchId\": \"string\",\n \"sortByMetric\": \"TransactionsPopularity\",\n \"sortByGeoPoints\": \"34.052235,-118.243685\",\n \"filterGeoPoints\": [\n \"34.052235,-118.243685\",\n \"15.0,65.0\"\n ],\n \"filterAroundRadius\": 2000,\n \"filters\": \"string\",\n \"facets\": [\n \"string\"\n ],\n \"customFilteredFacets\": {\n \"brand\": \"price > 100\",\n \"price\": \"brand == foo\"\n },\n \"facetsSize\": 2000,\n \"maxValuesPerFacet\": 50,\n \"caseSensitiveFacetValues\": false,\n \"includeFacets\": \"all\",\n \"facetsOrderBy\": \"coverage\",\n \"context\": [\n \"mobile\",\n \"listing\"\n ],\n \"displayAttributes\": [\n \"title\",\n \"price\"\n ],\n \"distinctFilter\": {\n \"attribute\": \"string\",\n \"maxNumItems\": 1,\n \"levelRangeModifier\": 0\n },\n \"ignoreQueryRules\": false,\n \"excludeQueryRules\": [\n 2,\n 5\n ],\n \"params\": {\n \"source\": \"mobile\"\n }\n});\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === this.DONE) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://api.synerise.com/search/v2/indices/%7BindexId%7D/list\");\nxhr.setRequestHeader(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\");\nxhr.setRequestHeader(\"content-type\", \"application/json\");\n\nxhr.send(data);"},{"lang":"Node.js","label":"Node.js","source":"const http = require(\"https\");\n\nconst options = {\n \"method\": \"POST\",\n \"hostname\": \"api.synerise.com\",\n \"port\": null,\n \"path\": \"/search/v2/indices/%7BindexId%7D/list\",\n \"headers\": {\n \"Authorization\": \"Bearer REPLACE_BEARER_TOKEN\",\n \"content-type\": \"application/json\"\n }\n};\n\nconst req = http.request(options, function (res) {\n const chunks = [];\n\n res.on(\"data\", function (chunk) {\n chunks.push(chunk);\n });\n\n res.on(\"end\", function () {\n const body = Buffer.concat(chunks);\n console.log(body.toString());\n });\n});\n\nreq.write(JSON.stringify({\n page: 0,\n limit: 10,\n sortBy: 'string',\n ordering: 'desc',\n includeMeta: true,\n clientUUID: 'string',\n personalize: true,\n correlationId: 'string',\n searchId: 'string',\n sortByMetric: 'TransactionsPopularity',\n sortByGeoPoints: '34.052235,-118.243685',\n filterGeoPoints: ['34.052235,-118.243685', '15.0,65.0'],\n filterAroundRadius: 2000,\n filters: 'string',\n facets: ['string'],\n customFilteredFacets: {brand: 'price > 100', price: 'brand == foo'},\n facetsSize: 2000,\n maxValuesPerFacet: 50,\n caseSensitiveFacetValues: false,\n includeFacets: 'all',\n facetsOrderBy: 'coverage',\n context: ['mobile', 'listing'],\n displayAttributes: ['title', 'price'],\n distinctFilter: {attribute: 'string', maxNumItems: 1, levelRangeModifier: 0},\n ignoreQueryRules: false,\n excludeQueryRules: [2, 5],\n params: {source: 'mobile'}\n}));\nreq.end();"},{"lang":"PHP","label":"PHP","source":"setUrl('https://api.synerise.com/search/v2/indices/%7BindexId%7D/list');\n$request->setMethod(HTTP_METH_POST);\n\n$request->setHeaders([\n 'Authorization' => 'Bearer REPLACE_BEARER_TOKEN',\n 'content-type' => 'application/json'\n]);\n\n$request->setBody('{\"page\":0,\"limit\":10,\"sortBy\":\"string\",\"ordering\":\"desc\",\"includeMeta\":true,\"clientUUID\":\"string\",\"personalize\":true,\"correlationId\":\"string\",\"searchId\":\"string\",\"sortByMetric\":\"TransactionsPopularity\",\"sortByGeoPoints\":\"34.052235,-118.243685\",\"filterGeoPoints\":[\"34.052235,-118.243685\",\"15.0,65.0\"],\"filterAroundRadius\":2000,\"filters\":\"string\",\"facets\":[\"string\"],\"customFilteredFacets\":{\"brand\":\"price > 100\",\"price\":\"brand == foo\"},\"facetsSize\":2000,\"maxValuesPerFacet\":50,\"caseSensitiveFacetValues\":false,\"includeFacets\":\"all\",\"facetsOrderBy\":\"coverage\",\"context\":[\"mobile\",\"listing\"],\"displayAttributes\":[\"title\",\"price\"],\"distinctFilter\":{\"attribute\":\"string\",\"maxNumItems\":1,\"levelRangeModifier\":0},\"ignoreQueryRules\":false,\"excludeQueryRules\":[2,5],\"params\":{\"source\":\"mobile\"}}');\n\ntry {\n $response = $request->send();\n\n echo $response->getBody();\n} catch (HttpException $ex) {\n echo $ex;\n}"},{"lang":"Java","label":"Java","source":"HttpResponse response = Unirest.post(\"https://api.synerise.com/search/v2/indices/%7BindexId%7D/list\")\n .header(\"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .header(\"content-type\", \"application/json\")\n .body(\"{\\\"page\\\":0,\\\"limit\\\":10,\\\"sortBy\\\":\\\"string\\\",\\\"ordering\\\":\\\"desc\\\",\\\"includeMeta\\\":true,\\\"clientUUID\\\":\\\"string\\\",\\\"personalize\\\":true,\\\"correlationId\\\":\\\"string\\\",\\\"searchId\\\":\\\"string\\\",\\\"sortByMetric\\\":\\\"TransactionsPopularity\\\",\\\"sortByGeoPoints\\\":\\\"34.052235,-118.243685\\\",\\\"filterGeoPoints\\\":[\\\"34.052235,-118.243685\\\",\\\"15.0,65.0\\\"],\\\"filterAroundRadius\\\":2000,\\\"filters\\\":\\\"string\\\",\\\"facets\\\":[\\\"string\\\"],\\\"customFilteredFacets\\\":{\\\"brand\\\":\\\"price > 100\\\",\\\"price\\\":\\\"brand == foo\\\"},\\\"facetsSize\\\":2000,\\\"maxValuesPerFacet\\\":50,\\\"caseSensitiveFacetValues\\\":false,\\\"includeFacets\\\":\\\"all\\\",\\\"facetsOrderBy\\\":\\\"coverage\\\",\\\"context\\\":[\\\"mobile\\\",\\\"listing\\\"],\\\"displayAttributes\\\":[\\\"title\\\",\\\"price\\\"],\\\"distinctFilter\\\":{\\\"attribute\\\":\\\"string\\\",\\\"maxNumItems\\\":1,\\\"levelRangeModifier\\\":0},\\\"ignoreQueryRules\\\":false,\\\"excludeQueryRules\\\":[2,5],\\\"params\\\":{\\\"source\\\":\\\"mobile\\\"}}\")\n .asString();"}]}},"/search/v2/indices/{indexId}/list/explain":{"get":{"summary":"Explained items listing","description":"Retrieves item listing, which is a search without a query. The results can be filtered and sorted. The response contains an explanation of the factors that influenced the result.\n\n---\n\n**API consumers:**