diff --git a/elements-metadata.json b/elements-metadata.json index 529189c..8b5337b 100644 --- a/elements-metadata.json +++ b/elements-metadata.json @@ -917,5 +917,17 @@ "vendor_version" : null, "key" : "kissmetrics", "extended" : false + }, + "Mixpanel" : { + "image" : "https://uxcam.com/images/mixpanel-logo.png", + "path" : "mixpanel/element.json", + "hub" : "general", + "author" : "gapking90", + "name" : "Mixpanel", + "active" : true, + "description" : "Add an Mixpanel element to connect to your existing mixpanel account, allowing you to create activities, users and download activities and users", + "vendor_version" : null, + "key" : "mixpanel", + "extended" : false } } \ No newline at end of file diff --git a/mixpanel-clone/README.md b/mixpanel-clone/README.md new file mode 100644 index 0000000..866b3ea --- /dev/null +++ b/mixpanel-clone/README.md @@ -0,0 +1,3 @@ +--------------------------- +Author Name:gapking90 +null \ No newline at end of file diff --git a/mixpanel-clone/element.json b/mixpanel-clone/element.json new file mode 100644 index 0000000..2173715 --- /dev/null +++ b/mixpanel-clone/element.json @@ -0,0 +1 @@ +{"elementMetadata":{"image":"https://uxcam.com/images/mixpanel-logo.png","usage":{"instanceCount":0,"customerCount":1,"traffic":1},"displayOrder":100,"active":true,"description":"Add an Mixpanel element to connect to your existing mixpanel account, allowing you to create activities, users and download activities and users","eventTypes":["unknown"],"hasSandboxWarnings":false,"paginationMetadata":{},"tags":[],"authenticationTypes":["basic"],"hub":"general","discovery":{"nativeObjectMetadataDiscovery":false,"vendorSupportCustomFieldsDiscovery":false,"supportCustomFieldsDiscovery":false,"nativeObjectDiscovery":false,"objectDiscoverySupport":false,"crudsSupported":false},"captured":false,"name":"Mixpanel","api":{"vendorSupportWebhooks":false,"type":"rest"},"extendable":false,"id":52738,"bulk":{"download":true,"upload":false,"ceSupportNativeBulkUpload":false,"vendorSupportNativeBulkDownload":false,"ceSupportNativeBulkDownload":false,"vendorSupportNativeBulkUpload":false},"beta":false,"key":"mixpanel"},"private":true,"configuration":[{"internal":false,"companyConfig":false,"displayOrder":1,"active":true,"description":"Mixpanel API Secret","isPrivate":false,"type":"TEXTFIELD_128","resellerConfig":false,"required":true,"hideFromConsole":false,"name":"API Secret","id":565814,"groupControl":false,"key":"username"},{"internal":false,"companyConfig":false,"defaultValue":"cursor","displayOrder":1,"active":true,"description":"Mixpanel Old Pagination Type","isPrivate":false,"type":"TEXTFIELD_32","resellerConfig":false,"required":false,"hideFromConsole":true,"name":"Pagination Type","id":565813,"groupControl":false,"key":"pagination.type"},{"internal":false,"companyConfig":false,"defaultValue":"true","displayOrder":1,"active":true,"description":"Enables use of global fields query parameter to filter response to only specified fields. This will override any existing vendor functionality on the connector","isPrivate":false,"type":"BOOLEAN","resellerConfig":false,"required":false,"hideFromConsole":true,"name":"Allow Select Fields parameter","id":565812,"groupControl":false,"key":"allow.select.fields"},{"internal":false,"companyConfig":false,"defaultValue":"yyyy-MM-dd","displayOrder":1,"active":true,"description":"Bulk query Date Mask","isPrivate":false,"type":"TEXTFIELD_128","resellerConfig":false,"required":false,"hideFromConsole":true,"name":"Bulk query Date Mask","id":565811,"groupControl":false,"key":"bulk.query.date_mask"},{"internal":false,"companyConfig":false,"displayOrder":1,"active":true,"description":"Bulk query Operator","isPrivate":false,"type":"TEXTFIELD_128","resellerConfig":false,"required":false,"hideFromConsole":true,"name":"Bulk query Operator","id":565810,"groupControl":false,"key":"bulk.query.operator"},{"internal":false,"companyConfig":false,"displayOrder":1,"active":true,"description":"Bulk query FieldName","isPrivate":false,"type":"TEXTFIELD_128","resellerConfig":false,"required":false,"hideFromConsole":true,"name":"Bulk query FieldName","id":565809,"groupControl":false,"key":"bulk.query.field_name"},{"internal":false,"companyConfig":false,"displayOrder":1,"active":true,"description":"Bulk Query Created Field Name","isPrivate":false,"type":"TEXTFIELD_128","resellerConfig":false,"required":false,"hideFromConsole":true,"name":"Bulk query Created Field Name","id":565808,"groupControl":false,"key":"bulk.attribute.created_time"},{"internal":false,"companyConfig":false,"displayOrder":1,"active":true,"description":"Bulk Add Metadata","isPrivate":false,"type":"TEXTFIELD_128","resellerConfig":false,"required":false,"hideFromConsole":true,"name":"Bulk Add Metadata","id":565807,"groupControl":false,"key":"bulk.add_metadata"},{"internal":false,"companyConfig":false,"defaultValue":"JSON","displayOrder":1,"active":true,"description":"Bulk Download Format","isPrivate":false,"type":"TEXTFIELD_128","resellerConfig":false,"required":false,"hideFromConsole":true,"name":"Bulk Download Format","id":565806,"groupControl":false,"key":"bulk.query.download_format"},{"internal":false,"companyConfig":false,"defaultValue":"1000","displayOrder":1,"active":true,"description":"Mixpanel Old Max Page Size (or limit)","isPrivate":false,"type":"TEXTFIELD_32","resellerConfig":false,"required":false,"hideFromConsole":true,"name":"Max Page Size (or limit)","id":565805,"groupControl":false,"key":"pagination.max"},{"internal":false,"companyConfig":false,"defaultValue":"1","displayOrder":1,"active":true,"description":"Mixpanel Old Pagination Start Index","isPrivate":false,"type":"TEXTFIELD_32","resellerConfig":false,"required":false,"hideFromConsole":true,"name":"Pagination Start Index","id":565816,"groupControl":false,"key":"pagination.page.startindex"},{"internal":false,"companyConfig":false,"defaultValue":"https://mixpanel.com/api/2.0","displayOrder":1,"active":true,"description":"Mixpanel Old Base URL","isPrivate":false,"type":"TEXTFIELD_1000","resellerConfig":false,"required":false,"hideFromConsole":true,"name":"Base URL","id":565815,"groupControl":false,"key":"base.url"},{"internal":false,"companyConfig":false,"displayOrder":3,"active":true,"description":"Password, this is blank and not required for provisioning","isPrivate":false,"type":"PASSWORD","resellerConfig":false,"required":false,"hideFromConsole":true,"name":"Password","id":565817,"groupControl":false,"key":"password"},{"internal":false,"companyConfig":false,"displayOrder":4,"active":true,"description":"Token to be used during events tracking","isPrivate":false,"type":"TEXTFIELD_128","resellerConfig":false,"required":false,"hideFromConsole":false,"name":"Token","id":565818,"groupControl":false,"key":"token"},{"internal":false,"companyConfig":false,"displayOrder":11,"active":true,"description":"Mixpanel Event Notification Signature Key","isPrivate":false,"type":"TEXTFIELD_128","resellerConfig":false,"required":false,"hideFromConsole":true,"name":"Event Notification Signature Key","id":565827,"groupControl":false,"key":"event.notification.signature.key"},{"internal":false,"companyConfig":false,"displayOrder":12,"active":true,"description":"Event Notification Callback Headers","isPrivate":false,"type":"TEXTFIELD_128","resellerConfig":false,"required":false,"hideFromConsole":false,"name":"Event Notification Callback Headers","id":565819,"groupControl":false,"key":"event.notification.callback.headers"},{"internal":false,"companyConfig":false,"defaultValue":"true","displayOrder":51,"active":true,"description":"Used to enable/disable filtering of null values from the responses","isPrivate":false,"type":"BOOLEAN","resellerConfig":false,"required":false,"hideFromConsole":false,"name":"Filter null values from the response","id":565820,"groupControl":false,"key":"filter.response.nulls"},{"internal":false,"companyConfig":false,"displayOrder":98,"active":true,"description":"Generic map used to specify default fields for bulk download and GET /all requests. Each key should be the canonical objectName and values may be specified as a comma-delimited string or a list of strings","isPrivate":false,"type":"TEXTAREA","resellerConfig":false,"required":false,"hideFromConsole":true,"name":"Default select fields","id":565821,"groupControl":false,"key":"default.select.fields.map"},{"internal":false,"companyConfig":false,"displayOrder":100,"active":true,"description":"Instance Variables","isPrivate":false,"type":"CODE_EDITOR","resellerConfig":false,"required":false,"hideFromConsole":false,"name":"Instance Variables","id":565822,"groupControl":false,"key":"instance.variables"},{"internal":true,"companyConfig":false,"displayOrder":100,"active":true,"description":"Mixpanel Old Time of Getting Token or Performing Authentication","isPrivate":false,"type":"TEXTFIELD_32","resellerConfig":false,"required":false,"hideFromConsole":true,"name":"Time of Getting Token or Performing Authentication","id":565823,"groupControl":false,"key":"authentication.time"},{"internal":false,"companyConfig":false,"defaultValue":"true","displayOrder":100,"active":true,"description":"Enables synchronous bulk callback notification","isPrivate":false,"type":"BOOLEAN","resellerConfig":false,"required":false,"hideFromConsole":false,"name":"Synchronous Bulk Notification","id":565824,"groupControl":false,"key":"synchronous.bulk.notification"},{"internal":false,"companyConfig":false,"displayOrder":110,"active":true,"description":"Event Notification basic authentication username","isPrivate":false,"type":"TEXTFIELD_1000","resellerConfig":false,"required":false,"hideFromConsole":false,"name":"Event Notification Basic Authentication UserName","id":565825,"groupControl":false,"key":"event.notification.basic.username"},{"internal":false,"companyConfig":false,"displayOrder":112,"active":true,"description":"Event Notification basic authentication password","isPrivate":false,"type":"PASSWORD","resellerConfig":false,"required":false,"hideFromConsole":false,"name":"Event Notification Basic Authentication Password","id":565826,"groupControl":false,"key":"event.notification.basic.password"}],"objects":[{"elementId":52738,"metadataDiscovery":false,"eventsEnabled":false,"eventCreatedSupported":false,"nativeBulkUpload":false,"vendorEventTypes":"unknown","tags":[],"ownerAccountId":35441,"name":"activities","operationsSupported":["unknown"],"eventUpdatedSupported":false,"hulkDownloadEnabled":true,"id":89542,"migrated":false,"nativeBulkDownload":false,"eventDeletedSupported":false,"hulkUploadEnabled":false},{"elementId":52738,"metadataDiscovery":false,"eventsEnabled":false,"eventCreatedSupported":false,"nativeBulkUpload":false,"vendorEventTypes":"unknown","tags":[],"ownerAccountId":35441,"name":"activities_top","operationsSupported":["unknown"],"eventUpdatedSupported":false,"hulkDownloadEnabled":true,"id":89543,"migrated":false,"nativeBulkDownload":false,"eventDeletedSupported":false,"hulkUploadEnabled":false},{"elementId":52738,"metadataDiscovery":false,"eventsEnabled":false,"eventCreatedSupported":false,"nativeBulkUpload":false,"vendorEventTypes":"unknown","tags":[],"ownerAccountId":35441,"name":"users","operationsSupported":["unknown"],"eventUpdatedSupported":false,"hulkDownloadEnabled":true,"id":89544,"migrated":false,"nativeBulkDownload":false,"eventDeletedSupported":false,"hulkUploadEnabled":false}],"description":"Add an Mixpanel element to connect to your existing mixpanel account, allowing you to create activities, users and download activities and users","cloneable":true,"extended":false,"bulkDownloadEnabled":true,"useModelsForMetadata":true,"paginatorVersion":"V2","trialAccount":false,"logo":"mixpanel","id":52738,"hooks":[],"beta":false,"key":"mixpanel","authentication":{"type":"basic"},"bulkUploadEnabled":false,"image":"https://uxcam.com/images/mixpanel-logo.png","active":true,"resources":[{"method":"POST","kind":"eb","description":"Create a(n) activities","updatedDate":"2021-02-15T09:27:40Z","type":"api","vendorPath":"http://api.mixpanel.com/track/","path":"/hubs/general/activities","createdDate":"2021-02-15T09:27:31Z","paginationType":"VENDOR_SUPPORTED","vendorMethod":"GET","response":{"contentTypeAsString":"application/json","contentType":"application/json"},"ownerAccountId":35441,"tryitoutDisable":false,"model":{"requestName":"createActivity","transform":false,"name":"activities","requestSwagger":{"createActivity":{"type":"object","properties":{"event":{"type":"string"},"properties":{"$ref":"#/definitions/properties"}},"required":["event","properties"]},"properties":{"type":"object","properties":{"distinct_id":{"type":"string"},"Referred By":{"type":"string"}}}},"swagger":{"activities":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"id":574422,"hooks":[{"resourceId":574422,"isLegacy":false,"contextParams":"response_body,response_status_code,response_iserror,response_error","id":102818,"mimeType":"application/javascript","body":"if(response_iserror) {\n\tdone({});\n}\n\nif(response_body === '1' || response_body === 1) {\n\tdone({\n\t\t\"response_body\" : {\n\t\t\t\"success\" : true\n\t\t}\n\t});\n}\n\ndone({\n\t\"response_error\" : \"Error while creating activity\",\n\t\"response_status_code\" : 400\n});\t\n\n\n","type":"postRequest"},{"resourceId":574422,"isLegacy":false,"contextParams":"request_body,request_vendor_parameters,configuration","id":102817,"mimeType":"application/javascript","body":"var vendorBody = JSON.parse(request_body);\nif(vendorBody.properties === null || vendorBody.properties === undefined) {\n\tvendorBody.properties = {};\n}\n\nif(vendorBody.properties.token === null || vendorBody.properties.token === undefined) {\n vendorBody.properties.token = configuration['token'];\t\n}\n\nvar params = {};\nparams.data = CE.b64(JSON.stringify(vendorBody));\n\ndone({\n request_vendor_parameters: params\n});","type":"preRequest"}],"parameters":[{"vendorType":"no-op","resourceId":574422,"dataType":"createActivity","description":"The activities object","vendorDataType":"activities","source":"request","updatedDate":"2021-02-15T09:27:40Z","type":"body","vendorName":"activities","required":true,"createdDate":"2021-02-15T09:27:31Z","name":"activities","id":1340644}]},{"method":"GET","kind":"eb","description":"Search for activities","updatedDate":"2021-02-15T09:27:40Z","type":"api","vendorPath":"/events/top/","path":"/hubs/general/activities/top","createdDate":"2021-02-15T09:27:31Z","paginationType":"VENDOR_SUPPORTED","vendorMethod":"GET","response":{"contentTypeAsString":"application/json","contentType":"application/json"},"ownerAccountId":35441,"tryitoutDisable":false,"model":{"transform":false,"name":"activitiesTopList","swagger":{"activitiesTopListObject":{"type":"object","properties":{"amount":{"format":"int32","type":"integer"},"event":{"type":"string"},"percent_change":{"format":"double","type":"number"}}}}},"id":574423,"hooks":[],"parameters":[{"vendorType":"query","resourceId":574423,"converter":"toQueryParameters","dataType":"string","description":"The CEQL search expression. ex: type='general' Valid values for type are \"general\", \"unique\", or \"average\"","vendorDataType":"string","source":"request","updatedDate":"2021-02-15T09:27:40Z","type":"query","vendorName":"converter:toQueryParameters","required":true,"createdDate":"2021-02-15T09:27:31Z","name":"where","id":1340646},{"vendorType":"query","resourceId":574423,"dataType":"string","description":"The number of resources to return in a given page","vendorDataType":"number","source":"request","updatedDate":"2021-02-15T09:27:40Z","type":"query","vendorName":"limit","required":false,"createdDate":"2021-02-15T09:27:31Z","name":"limit","id":1340645}],"rootKey":"|events"},{"method":"GET","kind":"eb","description":"Search for users","updatedDate":"2021-02-15T09:27:40Z","type":"provisionAuthValidation","vendorPath":"https://data.mixpanel.com/api/2.0/export/","path":"/hubs/general/authvalidation","createdDate":"2021-02-15T09:27:31Z","paginationType":"VENDOR_SUPPORTED","vendorMethod":"GET","response":{"contentTypeAsString":"application/json","contentType":"application/json"},"ownerAccountId":35441,"tryitoutDisable":false,"model":{"transform":false,"name":"authvalidation","swagger":{"authvalidation":{"id":"authvalidation","properties":{"event":{"type":"string"},"properties":{"type":"properties"}}},"properties":{"id":"properties","properties":{"distinct_id":{"type":"string"},"Referred By":{"type":"string"},"time":{"format":"int32","type":"integer"}}}}},"id":574424,"hooks":[{"resourceId":574424,"isLegacy":false,"contextParams":"request_vendor_parameters","id":102819,"mimeType":"application/javascript","body":"var date = new Date();\n\nvar dd = date.getDate();\nvar mm = date.getMonth();\nvar yyyy = date.getFullYear();\n\nvar todate = yyyy+'-'+mm+'-'+dd;\n\nvar dd = date.getDate() - 1\n\nvar fromdate = yyyy+'-'+mm+'-'+dd;\n\ndone({\n\trequest_vendor_parameters : {\n\t\t'to_date' : todate,\n\t\t'from_date': fromdate\n\t}\n})\n\n","type":"preRequest"}],"parameters":[{"vendorType":"no-op","resourceId":574424,"converter":"toQueryParameters","dataType":"string","description":"The CEQL search expression. ex: \"$city\" = 'Denver'","vendorDataType":"string","source":"request","updatedDate":"2021-02-15T09:27:40Z","type":"query","vendorName":"converter:toQueryParameters","required":false,"createdDate":"2021-02-15T09:27:31Z","name":"where","id":1340647}]},{"method":"GET","kind":"eb","description":"Search for users","updatedDate":"2021-02-15T09:27:40Z","type":"api","vendorPath":"https://mixpanel.com/api/2.0/engage/","nextPageKey":"body.session_id","path":"/hubs/general/users","createdDate":"2021-02-15T09:27:31Z","paginationType":"VENDOR_SUPPORTED","vendorMethod":"GET","response":{"contentTypeAsString":"application/json","contentType":"application/json"},"ownerAccountId":35441,"tryitoutDisable":false,"model":{"transform":false,"name":"usersList","swagger":{"$properties":{"type":"object","properties":{"$browser_version":{"format":"int32","type":"integer"},"$timezone":{"type":"string"},"gender":{"type":"string"},"$city":{"type":"string"},"$email":{"type":"string"},"$os":{"type":"string"},"$initial_referring_domain":{"type":"string"},"$last_login":{"type":"string"},"$browser":{"type":"string"},"$country_code":{"type":"string"},"Name":{"type":"string"},"$deliveries":{"type":"array","items":{"format":"int64","type":"integer"}},"$region":{"type":"string"},"$campaigns":{"type":"array","items":{"format":"int32","type":"integer"}},"$last_seen":{"type":"string"},"credits":{"format":"int32","type":"integer"},"$initial_referrer":{"type":"string"},"$created":{"type":"string"}}},"usersListObject":{"type":"object","properties":{"$properties":{"$ref":"#/definitions/$properties"},"$distinct_id":{"type":"string"}}}}},"id":574425,"hooks":[{"resourceId":574425,"isLegacy":false,"contextParams":"request_parameters,request_expression,request_vendor_parameters","id":102820,"mimeType":"application/javascript","body":"var params = {};\n\nif(request_vendor_parameters !== null && (request_vendor_parameters.session_id === null || request_vendor_parameters.session_id === undefined)) {\n\tparams.page = null;\n} else if(request_vendor_parameters !== null && request_vendor_parameters.session_id !== null && request_parameters.page !== null && request_parameters.page !== undefined) {\n\tparams.page = request_parameters.page;\n}\n\nif(request_expression !== null && request_expression !== undefined && request_expression.length > 0) {\n\t//construct the where\n\t\n\tvar wherequery = \"(\";\n\tvar nextCall = false;\n\tfor (var index in request_expression) {\n\t\tvar exp = request_expression[index];\n\t\t//If its query ignore others and just use query value for the where\n\t\tif(exp.attribute === 'query') {\n\t\t\twherequery = exp.value;\n\t\t\tnextCall = false;\n\t\t\tbreak;\n\t\t}\n\t\t\n\t\tif(nextCall) {\n\t\t\twherequery += ' and ';\n\t\t}\n\t\t\n\t\tnextCall = true;\n\t\twherequery += 'properties[';\n\t\tif(exp.attribute.indexOf('\"') === 0) {\n\t\t\twherequery += exp.attribute;\n\t\t} else {\n\t\t\twherequery += '\"';\n\t\t\twherequery += exp.attribute;\n\t\t\twherequery += '\"';\n\t\t}\t\t\n\t\twherequery += '] ';\n\t\t\n\t\tvar oper = exp.operator;\n\t\tif(oper === '=') {\n\t\t\toper = '==';\n\t\t}\n\t\twherequery += oper;\n\t\twherequery += ' ';\n\t\tif(exp.value.indexOf('\"') === 0) {\n\t\t\twherequery += exp.value;\n\t\t} else {\n\t\t\twherequery += '\"';\n\t\t\twherequery += exp.value;\n\t\t\twherequery += '\"';\n\t\t}\n\t}\n\t\n\tif(nextCall) {\n\t\twherequery += ')';\t\n\t}\n\t\n\tparams.where = wherequery;\n}\n\ndone({\n\trequest_vendor_parameters: params\n})","type":"preRequest"}],"parameters":[{"vendorType":"query","resourceId":574425,"dataType":"string","description":"The next page token to get the next set of results","vendorDataType":"string","source":"request","updatedDate":"2021-02-15T09:27:40Z","type":"query","vendorName":"session_id","required":false,"createdDate":"2021-02-15T09:27:31Z","name":"nextPage","id":1340649},{"vendorType":"no-op","resourceId":574425,"converter":"toQueryParameters","dataType":"string","description":"The CEQL search expression. ex: \"$city\" = 'Denver' or the expression itself as query = '(properties[\"$created\"] > \"2011-03-15T09:53:54\")'","vendorDataType":"string","source":"request","updatedDate":"2021-02-15T09:27:40Z","type":"query","vendorName":"converter:toQueryParameters","required":false,"createdDate":"2021-02-15T09:27:31Z","name":"where","id":1340648}],"rootKey":"|results"},{"method":"POST","kind":"eb","description":"Create a(n) users","updatedDate":"2021-02-15T09:27:40Z","type":"api","vendorPath":"http://api.mixpanel.com/engage/","path":"/hubs/general/users","createdDate":"2021-02-15T09:27:31Z","paginationType":"VENDOR_SUPPORTED","vendorMethod":"POST","response":{"contentTypeAsString":"application/json","contentType":"application/json"},"ownerAccountId":35441,"tryitoutDisable":false,"model":{"requestName":"createUsers","transform":false,"name":"users","requestSwagger":{"createUsers":{"x-primary-key":["$distinct_id"],"type":"object","properties":{"$distinct_id":{"type":"string"},"$ip":{"type":"string"},"$set":{"$ref":"#/definitions/$set"}},"required":["$distinct_id","$set"]},"$set":{"type":"object","properties":{"Address":{"type":"string"}}}},"swagger":{"users":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"id":574426,"hooks":[{"resourceId":574426,"isLegacy":false,"contextParams":"response_body,response_status_code,response_iserror,response_error","id":102822,"mimeType":"application/javascript","body":"if(response_iserror) {\n\tdone({});\n}\n\nif(response_body === '1' || response_body === 1) {\n\tdone({\n\t\t\"response_body\" : {\n\t\t\t\"success\" : true\n\t\t}\n\t});\n}\n\ndone({\n\t\"response_error\" : \"Error while creating activity\",\n\t\"response_status_code\" : 400\n});\t\n\n\n","type":"postRequest"},{"resourceId":574426,"isLegacy":false,"contextParams":"request_body,request_vendor_parameters,configuration","id":102821,"mimeType":"application/javascript","body":"var vendorBody = JSON.parse(request_body);\n\nif(vendorBody.$token === null || vendorBody.$token === undefined) {\n vendorBody.$token = configuration['token'];\t\n}\n\nvar params = {};\nparams.data = CE.b64(JSON.stringify(vendorBody));\n\ndone({\n request_vendor_parameters: params\n});","type":"preRequest"}],"parameters":[{"vendorType":"no-op","resourceId":574426,"dataType":"createUsers","description":"The users object, if the $distinct_id is existing user gets updated","vendorDataType":"users","source":"request","updatedDate":"2021-02-15T09:27:40Z","type":"body","vendorName":"users","required":true,"createdDate":"2021-02-15T09:27:31Z","name":"users","id":1340650}]},{"method":"DELETE","kind":"eb","description":"Delete a(n) users","updatedDate":"2021-02-15T09:27:40Z","type":"api","vendorPath":"http://api.mixpanel.com/engage/","path":"/hubs/general/users/{id}","createdDate":"2021-02-15T09:27:31Z","paginationType":"VENDOR_SUPPORTED","vendorMethod":"POST","response":{"contentTypeAsString":"application/json","contentType":"application/json"},"ownerAccountId":35441,"tryitoutDisable":false,"model":{"transform":false,"name":"users","swagger":{"users":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"id":574427,"hooks":[{"resourceId":574427,"isLegacy":false,"contextParams":"response_body,response_status_code,response_iserror,response_error","id":102824,"mimeType":"application/javascript","body":"if(response_iserror) {\n\tdone({});\n}\n\nif(response_body === '1' || response_body === 1) {\n\tdone({\n\t\t\"response_body\" : {\n\t\t\t\"success\" : true\n\t\t}\n\t});\n}\n\ndone({\n\t\"response_error\" : \"Error while creating activity\",\n\t\"response_status_code\" : 400\n});","type":"postRequest"},{"resourceId":574427,"isLegacy":false,"contextParams":"request_path,request_vendor_parameters,configuration","id":102823,"mimeType":"application/javascript","body":"var vendorBody = {\n\t$token: configuration['token'],\n\t\"$delete\": \"\"\n};\n\n\nvar path = request_path;\nvendorBody.$distinct_id = path.substring(path.indexOf('users/')+6);\nvar params = {};\nparams.data = CE.b64(JSON.stringify(vendorBody));\n\ndone({\n request_vendor_parameters: params\n});","type":"preRequest"}],"parameters":[{"vendorType":"no-op","resourceId":574427,"dataType":"string","description":"The users ID","vendorDataType":"string","source":"request","updatedDate":"2021-02-15T09:27:40Z","type":"path","vendorName":"id","required":true,"createdDate":"2021-02-15T09:27:31Z","name":"id","id":1340651}]},{"method":"PATCH","kind":"eb","description":"Update a(n) users","updatedDate":"2021-02-15T09:27:40Z","type":"api","vendorPath":"http://api.mixpanel.com/engage/","path":"/hubs/general/users/{id}","createdDate":"2021-02-15T09:27:31Z","paginationType":"VENDOR_SUPPORTED","vendorMethod":"GET","response":{"contentTypeAsString":"application/json","contentType":"application/json"},"ownerAccountId":35441,"tryitoutDisable":false,"model":{"requestName":"updateUsers","transform":false,"name":"users","requestSwagger":{"updateUsers":{"x-primary-key":["$distinct_id"],"type":"object","properties":{"$ip":{"type":"string"},"$set":{"$ref":"#/definitions/$set"}},"required":["$set"]},"$set":{"type":"object","properties":{"Address":{"type":"string"}}}},"swagger":{"users":{"type":"object","properties":{"success":{"type":"boolean"}}}}},"id":574428,"hooks":[{"resourceId":574428,"isLegacy":false,"contextParams":"response_body,response_status_code,response_iserror,response_error","id":102826,"mimeType":"application/javascript","body":"if(response_iserror) {\n\tdone({});\n}\n\nif(response_body === '1' || response_body === 1) {\n\tdone({\n\t\t\"response_body\" : {\n\t\t\t\"success\" : true\n\t\t}\n\t});\n}\n\ndone({\n\t\"response_error\" : \"Error while creating activity\",\n\t\"response_status_code\" : 400\n});\t\n\n\n","type":"postRequest"},{"resourceId":574428,"isLegacy":false,"contextParams":"request_body,request_path,request_vendor_parameters,configuration","id":102825,"mimeType":"application/javascript","body":"var vendorBody = JSON.parse(request_body);\n\nif(vendorBody.$token === null || vendorBody.$token === undefined) {\n vendorBody.$token = configuration['token'];\t\n}\n\nvar path = request_path;\nvendorBody.$distinct_id = path.substring(path.indexOf('users/')+6);\nvar params = {};\nparams.data = CE.b64(JSON.stringify(vendorBody));\n\ndone({\n request_vendor_parameters: params,\n \n});","type":"preRequest"}],"parameters":[{"vendorType":"no-op","resourceId":574428,"dataType":"updateUsers","description":"The users object","vendorDataType":"users","source":"request","updatedDate":"2021-02-15T09:27:40Z","type":"body","vendorName":"users","required":true,"createdDate":"2021-02-15T09:27:31Z","name":"users","id":1340653},{"vendorType":"no-op","resourceId":574428,"dataType":"string","description":"The users ID","vendorDataType":"string","source":"request","updatedDate":"2021-02-15T09:27:40Z","type":"path","vendorName":"id","required":true,"createdDate":"2021-02-15T09:27:31Z","name":"id","id":1340652}]}],"protocolType":"http","transformationsEnabled":true,"childTransformationsEnabled":true,"deleted":false,"hub":"general","typeOauth":false,"name":"Mixpanel","extendable":false,"parameters":[{"elementId":52738,"vendorType":"header","createdDate":"2021-02-15T09:27:40Z","name":"application/json","id":46692,"source":"request","type":"value","vendorName":"Accept","required":false},{"elementId":52738,"vendorType":"header","createdDate":"2021-02-15T09:27:40Z","name":"application/json","id":46691,"source":"request","type":"value","vendorName":"Content-Type","required":false}]} diff --git a/mixpanel-clone/metadata.json b/mixpanel-clone/metadata.json new file mode 100644 index 0000000..e460cbf --- /dev/null +++ b/mixpanel-clone/metadata.json @@ -0,0 +1 @@ +{"key":"mixpanel","authentication":"BASIC"} diff --git a/mixpanel-clone/swagger.json b/mixpanel-clone/swagger.json new file mode 100644 index 0000000..d86c557 --- /dev/null +++ b/mixpanel-clone/swagger.json @@ -0,0 +1 @@ +{"basePath":"/elements/api-v2","paths":{"/activities":{"post":{"summary":"Create a(n) activities","operationId":"createActivity","responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/activities"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"},"404":{"description":"Not found - The requested resource is not found"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"}},"parameters":[{"in":"header","name":"Authorization","description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","type":"string","required":true},{"schema":{"$ref":"#/definitions/createActivity"},"in":"body","name":"activities","description":"The activities object","required":true}],"tags":["activities"]}},"/activities/top":{"get":{"summary":"Search for activities","operationId":"getActivitiesTop","responses":{"200":{"description":"OK - Everything worked as expected","schema":{"type":"array","items":{"$ref":"#/definitions/activitiesTopListObject"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"},"404":{"description":"Not found - The requested resource is not found"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"}},"parameters":[{"in":"header","name":"Authorization","description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","type":"string","required":true},{"in":"query","name":"where","description":"The CEQL search expression. ex: type='general' Valid values for type are \"general\", \"unique\", or \"average\"","type":"string","required":true},{"in":"query","name":"limit","description":"The number of resources to return in a given page","type":"string","required":false}],"tags":["activities"]}},"/bulk/download":{"post":{"summary":"Create a new bulk download job (asynchronous)","operationId":"createBulkDownload","responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/BulkQuery"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"parameters":[{"in":"header","name":"Authorization","description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","type":"string","required":true},{"schema":{"$ref":"#/definitions/bulkDownloadRequest"},"in":"body","name":"body","description":"The object body","required":true}],"tags":["bulk"]}},"/bulk/jobs":{"get":{"operationId":"getBulkJobs","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example to get all upload jobs the expression would be where=job_direction='UPLOAD'. The following fields are valid search fields 'object_name', 'job_status', 'job_direction', 'record_count'","in":"query","name":"where","required":false,"type":"string"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The fields to return on the response. Can be a single field or a comma-separated list of fields","in":"query","name":"fields","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/BulkJobList"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Fetch all the bulk jobs for an instance","tags":["bulk"]}},"/bulk/query":{"post":{"operationId":"createBulkQuery","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The Url to send the notification to when the Job is completed","in":"header","name":"Elements-Async-Callback-Url","required":false,"type":"string"},{"description":"The CEQL query. When this parameter is omitted, all objects of the given type are returned via the bulk job. Endpoint limiters may still apply.","in":"query","name":"q","required":false,"type":"string"},{"description":"The last time this query was run. This is optional. You can also have this parameter in the query and leave this blank - optional eg. '2014-10-06T13:22:17-08:00'","in":"query","name":"lastRunDate","required":false,"type":"string"},{"description":"The created/updated date of the object to filter on - optional eg. '2014-10-06T13:22:17-08:00'","in":"query","name":"from","required":false,"type":"string"},{"description":"The created/updated date of the object to filter on - optional eg. '2014-10-06T13:22:17-08:00'","in":"query","name":"to","required":false,"type":"string"},{"description":"Optional JSON MetaData that contains callback-payload and fileName, ex: {\"callback-payload\" : , \"fileName\" : \"{Date format}_Name of the file\"}. If the fileName is MyFile then pass metadata as {\"fileName\" : \"{yyyy-MM-dd HH:mm:ss}_MyFile\"}. The valid date formats are \"yyyy-MM-dd'T'HH:mm:ssXXX\", \"yyyy-MM-dd'T'HH:mm:ss'Z'\", \"yyyy-MM-dd'T'HH:mm:ss.SXXX\", \"yyyy-MM-dd'T'HH:mm:ss.SSSXXX\", \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\", \"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'\", \"yyyy-MM-dd HH:mm:ss\", \"yyyy.MM.dd G 'at' HH:mm:ss z\", \"h:mm a\", \"yyyyy.MMMMM.dd GGG hh:mm aaa\" and \"yyMMddHHmmssZ\". callback-payload - is passed back in bulk job notification ","in":"formData","name":"metaData","required":false,"type":"string"}],"consumes":["multipart/form-data"],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/BulkQuery"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create an asynchronous bulk query job.","tags":["bulk"]}},"/bulk/{id}/cancel":{"put":{"operationId":"replaceBulkCancel","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the bulk job to cancel.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/BulkStatus"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Cancel an asynchronous bulk query job.","tags":["bulk"]}},"/bulk/{id}/errors":{"get":{"operationId":"getBulkErrors","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the bulk job to retrieve its errors.","in":"path","name":"id","required":true,"type":"string"},{"description":"The page size for pagination, which defaults to 200 if not supplied","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The fields to return on the response. Can be a single field or a comma-separated list of fields","in":"query","name":"fields","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"type":"string"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve the errors of a bulk job.","tags":["bulk"]}},"/bulk/{id}/status":{"get":{"operationId":"getBulkStatus","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the bulk job to retrieve its status.","in":"path","name":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/BulkStatus"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve the status of a bulk job.","tags":["bulk"]}},"/bulk/{id}/{objectName}":{"get":{"operationId":"getBulkByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The ID of the bulk job","in":"path","name":"id","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"type":"file"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve the results of an asynchronous bulk query.","tags":["bulk"],"produces":["text/csv","application/json","application/jsonl"]}},"/objects":{"get":{"operationId":"getObjects","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"Elements Version to be used for getting metadata, possible options are Hydrogen, Helium. Default value is Hydrogen","in":"header","name":"Elements-Version","required":false,"type":"string","enum":["Hydrogen","Helium"]}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"type":"string"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Get a list of all the available objects.","tags":["objects"]}},"/objects/{objectName}/docs":{"get":{"operationId":"getObjectsObjectNameDocs","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"Include discovery metadata in definitions","in":"query","name":"discovery","required":false,"type":"boolean"},{"description":"Optionally resolve swagger references for an inline object definition","in":"query","name":"resolveReferences","required":false,"type":"boolean"},{"description":"Include only OpenAPI / Swagger properties in definitions","in":"query","name":"basic","required":false,"type":"boolean"},{"description":"The element swagger version to get the corresponding element swagger, Passing in \"-1\" gives latest element swagger","in":"query","name":"version","required":false,"default":"-1","type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/swaggerDocs"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Get swagger docs for an object.","tags":["objects"]}},"/objects/{objectName}/metadata":{"get":{"operationId":"getObjectsObjectNameMetadata","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"Elements Version to be used for getting metadata, possible options are Hydrogen, Helium. Default value is Hydrogen","in":"header","name":"Elements-Version","required":false,"type":"string","enum":["Hydrogen","Helium"]}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/objectsMetadata"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Get a list of all the field for an object.","tags":["objects"]}},"/ping":{"get":{"operationId":"getPing","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Pong"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Ping the Element to confirm that the Hub Element has a heartbeat. If the Element does not have a heartbeat, an error message will be returned.","tags":["ping"]}},"/users":{"post":{"summary":"Create a(n) users","operationId":"createUser","responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/users"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"},"404":{"description":"Not found - The requested resource is not found"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"}},"parameters":[{"in":"header","name":"Authorization","description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","type":"string","required":true},{"schema":{"$ref":"#/definitions/createUsers"},"in":"body","name":"users","description":"The users object, if the $distinct_id is existing user gets updated","required":true}],"tags":["users"]},"get":{"summary":"Search for users","operationId":"getUsers","responses":{"200":{"description":"OK - Everything worked as expected","schema":{"type":"array","items":{"$ref":"#/definitions/usersListObject"}}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"},"404":{"description":"Not found - The requested resource is not found"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"}},"parameters":[{"in":"header","name":"Authorization","description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","type":"string","required":true},{"in":"query","name":"where","description":"The CEQL search expression. ex: \"$city\" = 'Denver' or the expression itself as query = '(properties[\"$created\"] > \"2011-03-15T09:53:54\")'","type":"string","required":false},{"in":"query","name":"nextPage","description":"The next page cursor, taken from the response header: `elements-next-page-token`","type":"string","required":false}],"tags":["users"]}},"/users/{id}":{"patch":{"summary":"Update a(n) users","operationId":"updateUserById","responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/users"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"},"404":{"description":"Not found - The requested resource is not found"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"}},"parameters":[{"in":"header","name":"Authorization","description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","type":"string","required":true},{"in":"path","name":"id","description":"The users ID","type":"string","required":true},{"schema":{"$ref":"#/definitions/updateUsers"},"in":"body","name":"users","description":"The users object","required":true}],"tags":["users"]},"delete":{"summary":"Delete a(n) users","operationId":"deleteUserById","responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"},"404":{"description":"Not found - The requested resource is not found"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"}},"parameters":[{"in":"header","name":"Authorization","description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","type":"string","required":true},{"in":"path","name":"id","description":"The users ID","type":"string","required":true}],"tags":["users"]}},"/{objectName}":{"get":{"operationId":"getByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The CEQL search expression.","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 5000.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The fields to return on the response. Can be a single field or a comma-separated list of fields","in":"query","name":"fields","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/Object"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Search for {objectName}","tags":["objectName"]},"post":{"operationId":"createByObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The {objectName}","in":"body","name":"Body","required":true,"schema":{"$ref":"#/definitions/Object"}}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create an {objectName}","tags":["objectName"]}},"/{objectName}/{objectId}":{"delete":{"operationId":"deleteObjectNameByObjectId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The {objectName} ID","in":"path","name":"objectId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete an {objectName}","tags":["objectName"]},"get":{"operationId":"getObjectNameByObjectId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The {objectName} ID","in":"path","name":"objectId","required":true,"type":"string"}],"produces":["application/json","application/pdf"],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve an {objectName}","tags":["objectName"]},"patch":{"operationId":"updateObjectNameByObjectId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The {objectName} ID","in":"path","name":"objectId","required":true,"type":"string"},{"description":"The {objectName}","in":"body","name":"Body","required":true,"schema":{"$ref":"#/definitions/Object"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update an {objectName}","tags":["objectName"]},"put":{"operationId":"replaceObjectNameByObjectId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The {objectName} ID","in":"path","name":"objectId","required":true,"type":"string"},{"description":"The {objectName}","in":"body","name":"Body","required":true,"schema":{"$ref":"#/definitions/Object"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the 'Accept' header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update an {objectName}","tags":["objectName"]}},"/{objectName}/{objectId}/{childObjectName}":{"get":{"operationId":"getObjectNameByChildObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The {objectName} ID","in":"path","name":"objectId","required":true,"type":"string"},{"description":"The name of the childObjectName","in":"path","name":"childObjectName","required":true,"type":"string"},{"description":"The CEQL search expression.","in":"query","name":"where","required":false,"type":"string"},{"description":"The page size. Defaults to 200 if not provided. Maximum of 5000.","format":"int64","in":"query","name":"pageSize","required":false,"type":"integer"},{"description":"The next page cursor, taken from the response header: `elements-next-page-token`","in":"query","name":"nextPage","required":false,"type":"string"},{"description":"The fields to return on the response. Can be a single field or a comma-separated list of fields","in":"query","name":"fields","required":false,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"items":{"$ref":"#/definitions/Object"},"type":"array"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the "Accept" header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Search for {childObjectName}","tags":["objectName"]},"post":{"operationId":"createObjectNameByChildObjectName","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The {objectName} ID","in":"path","name":"objectId","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"childObjectName","required":true,"type":"string"},{"description":"The {childObjectName}","in":"body","name":"Body","required":true,"schema":{"$ref":"#/definitions/Object"}}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the "Accept" header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Create an {objectName}","tags":["objectName"]}},"/{objectName}/{objectId}/{childObjectName}/{childObjectId}":{"delete":{"operationId":"deleteObjectNameByChildObjectId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The name of the childObjectName","in":"path","name":"childObjectName","required":true,"type":"string"},{"description":"The {objectName} ID","in":"path","name":"objectId","required":true,"type":"string"},{"description":"The {childObjectName} ID","in":"path","name":"childObjectId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected"},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the "Accept" header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Delete an {childObjectName}","tags":["objectName"]},"get":{"operationId":"getObjectNameByChildObjectId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The name of the childObjectName","in":"path","name":"childObjectName","required":true,"type":"string"},{"description":"The {objectName} ID","in":"path","name":"objectId","required":true,"type":"string"},{"description":"The {childObjectName} ID","in":"path","name":"childObjectId","required":true,"type":"string"}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the "Accept" header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Retrieve an {childObjectName}","tags":["objectName"]},"patch":{"operationId":"updateObjectNameByChildObjectId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The name of the childObjectName","in":"path","name":"childObjectName","required":true,"type":"string"},{"description":"The {objectName} ID","in":"path","name":"objectId","required":true,"type":"string"},{"description":"The {childObjectName} ID","in":"path","name":"childObjectId","required":true,"type":"string"},{"description":"The {objectName}","in":"body","name":"Body","required":true,"schema":{"$ref":"#/definitions/Object"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the "Accept" header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update an {childObjectName}","tags":["objectName"]},"put":{"operationId":"replaceObjectNameByChildObjectId","parameters":[{"description":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","in":"header","name":"Authorization","required":true,"type":"string"},{"description":"The name of the object","in":"path","name":"objectName","required":true,"type":"string"},{"description":"The name of the childObjectName","in":"path","name":"childObjectName","required":true,"type":"string"},{"description":"The {objectName} ID","in":"path","name":"objectId","required":true,"type":"string"},{"description":"The {childObjectName} ID","in":"path","name":"childObjectId","required":true,"type":"string"},{"description":"The {objectName}","in":"body","name":"Body","required":true,"schema":{"$ref":"#/definitions/Object"}}],"responses":{"200":{"description":"OK - Everything worked as expected","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"Bad Request - Often due to a missing request parameter"},"401":{"description":"Unauthorized - An invalid element token, user secret and/or org secret provided"},"403":{"description":"Forbidden - Access to the resource by the provider is forbidden"},"404":{"description":"Not found - The requested resource is not found"},"405":{"description":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected"},"406":{"description":"Not acceptable - The response content type does not match the "Accept" header value"},"409":{"description":"Conflict - If a resource being created already exists"},"415":{"description":"Unsupported media type - The server cannot handle the requested Content-Type"},"500":{"description":"Server error - Something went wrong on the Cloud Elements server"},"502":{"description":"Provider server error - Something went wrong on the Provider or Endpoint's server"}},"summary":"Update an {childObjectName}","tags":["objectName"]}}},"schemes":["https"],"definitions":{"bulkDownloadRequest":{"properties":{"apiLimit":{"format":"int32","type":"integer","x-samplevalue":100},"continueFromJobId":{"format":"int32","type":"integer","x-samplevalue":1},"docsHubDetails":{"$ref":"#/definitions/bulkDownloadRequestDocsHubDetails"},"filterDateField":{"type":"string","x-samplevalue":"lastModifiedDate"},"filterNulls":{"type":"boolean","x-samplevalue":true},"format":{"enum":["application/json","txt/csv","application/jsonl"],"type":"string","x-samplevalue":"application/json"},"from":{"format":"date-time","type":"string","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","x-samplevalue":"2014-10-06T13:22:17-08:00"},"limit":{"format":"int32","type":"integer","x-samplevalue":107},"notificationUrl":{"type":"string","x-samplevalue":"https://myreceiver.com/whatever"},"objectName":{"type":"string","x-samplevalue":"accounts"},"pageSize":{"format":"int32","type":"integer","x-samplevalue":200},"query":{"$ref":"#/definitions/bulkDownloadRequestQuery"},"selectFields":{"type":"string","x-samplevalue":"a,b,c"},"to":{"format":"date-time","type":"string","x-mask":"yyyy-MM-dd'T'HH:mm:ssZ","x-samplevalue":"2014-10-10T13:22:17-08:00"},"where":{"type":"string","x-samplevalue":"name='Alex' and gender='male'"}},"required":["objectName","format"],"title":"bulkDownloadRequest","type":"object"},"swaggerschema":{"x-has-customfields":false,"type":"object","title":"schema","properties":{"$ref":{"x-samplevalue":"#/definitions/Contact-POST-Response","type":"string"}}},"swaggerdefinitions":{"x-has-customfields":false,"type":"object","title":"definitions","properties":{"definition-name":{"$ref":"#/definitions/swaggerdefinition-name"}}},"swagger415":{"x-has-customfields":false,"type":"object","title":"415","properties":{"description":{"x-samplevalue":"Unsupported media type - The server cannot handle the requested Content-Type","type":"string"}}},"BulkQuery":{"properties":{"id":{"type":"string"},"status":{"type":"string"},"instance_id":{"type":"number"}},"type":"object"},"swaggerdefinition-name":{"x-has-customfields":false,"type":"object","title":"definition-name","properties":{"properties":{"$ref":"#/definitions/swaggerproperties"}}},"swaggerparameters":{"x-has-customfields":false,"title":"parameters","properties":{"schema":{"$ref":"#/definitions/swaggerparametersschema"},"in":{"x-samplevalue":"header","type":"string"},"name":{"x-samplevalue":"Authorization","type":"string"},"description":{"x-samplevalue":"The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'","type":"string"},"type":{"x-samplevalue":"string","type":"string"},"required":{"x-samplevalue":true,"type":"boolean"}},"type":"object"},"swaggerparametersschema":{"x-has-customfields":false,"type":"object","title":"schema","properties":{"$ref":{"x-samplevalue":"#/definitions/Contact","type":"string"}}},"swaggerresponses":{"x-has-customfields":false,"type":"object","title":"responses","properties":{"200":{"$ref":"#/definitions/swagger200"},"400":{"$ref":"#/definitions/swagger400"},"401":{"$ref":"#/definitions/swagger401"},"403":{"$ref":"#/definitions/swagger403"},"404":{"$ref":"#/definitions/swagger404"},"405":{"$ref":"#/definitions/swagger405"},"406":{"$ref":"#/definitions/swagger406"},"409":{"$ref":"#/definitions/swagger409"},"415":{"$ref":"#/definitions/swagger415"},"500":{"$ref":"#/definitions/swagger500"},"502":{"$ref":"#/definitions/swagger502"}}},"swaggerproperties":{"x-has-customfields":false,"type":"object","title":"properties","properties":{"definition-property":{"$ref":"#/definitions/swaggerdefinition-property"}}},"usersListObject":{"properties":{"$distinct_id":{"type":"string"},"$properties":{"$ref":"#/definitions/$properties"}},"type":"object"},"swagger-contacts-path":{"x-has-customfields":false,"type":"object","title":"/contacts","properties":{"post":{"$ref":"#/definitions/swaggerpost"}}},"swagger200":{"x-has-customfields":false,"type":"object","title":"200","properties":{"schema":{"$ref":"#/definitions/swaggerschema"},"description":{"x-samplevalue":"OK - Everything worked as expected","type":"string"}}},"$properties":{"properties":{"$browser":{"type":"string"},"$browser_version":{"format":"int32","type":"integer"},"$campaigns":{"items":{"format":"int32","type":"integer"},"type":"array"},"$city":{"type":"string"},"$country_code":{"type":"string"},"$created":{"type":"string"},"$deliveries":{"items":{"format":"int64","type":"integer"},"type":"array"},"$email":{"type":"string"},"$initial_referrer":{"type":"string"},"$initial_referring_domain":{"type":"string"},"$last_login":{"type":"string"},"$last_seen":{"type":"string"},"$os":{"type":"string"},"$region":{"type":"string"},"$timezone":{"type":"string"},"Name":{"type":"string"},"credits":{"format":"int32","type":"integer"},"gender":{"type":"string"}},"type":"object"},"createActivity":{"properties":{"event":{"type":"string"},"properties":{"$ref":"#/definitions/properties"}},"required":["event","properties"],"type":"object"},"swagger400":{"x-has-customfields":false,"type":"object","title":"400","properties":{"description":{"x-samplevalue":"Bad Request - Often due to a missing request parameter","type":"string"}}},"swaggerinfo":{"x-has-customfields":false,"type":"object","title":"info","properties":{"contact":{"$ref":"#/definitions/swaggercontact"},"title":{"x-samplevalue":"hubspotcrm","type":"string"},"version":{"x-samplevalue":"api-v2","type":"string"}}},"swagger401":{"x-has-customfields":false,"type":"object","title":"401","properties":{"description":{"x-samplevalue":"Unauthorized - An invalid element token, user secret and/or org secret provided","type":"string"}}},"swagger500":{"x-has-customfields":false,"type":"object","title":"500","properties":{"description":{"x-samplevalue":"Server error - Something went wrong on the Cloud Elements server","type":"string"}}},"swaggerpaths":{"x-has-customfields":false,"type":"object","title":"paths","properties":{"/contacts":{"$ref":"#/definitions/swagger-contacts-path"}}},"swagger403":{"x-has-customfields":false,"type":"object","title":"403","properties":{"description":{"x-samplevalue":"Forbidden - Access to the resource by the provider is forbidden","type":"string"}}},"swagger502":{"x-has-customfields":false,"type":"object","title":"502","properties":{"description":{"x-samplevalue":"Provider server error - Something went wrong on the Provider or Endpoint's server","type":"string"}}},"BulkStatus":{"description":"Status of the bulk upload.","type":"object","properties":{"batchId":{"description":"Contact/Leads loaded","type":"number"},"message":{"type":"string"},"numOfLeadsProcessed":{"description":"Contact/Leads loaded","type":"number"},"numOfRowsFailed":{"description":"Failed count","type":"number"},"numOfRowsWithWarning":{"description":"Contact/Leads that had warnings","type":"number"},"status":{"description":"Status of the bulk job","type":"string"}}},"swagger404":{"x-has-customfields":false,"type":"object","title":"404","properties":{"description":{"x-samplevalue":"Not found - The requested resource is not found","type":"string"}}},"activitiesTopListObject":{"properties":{"amount":{"format":"int32","type":"integer"},"event":{"type":"string"},"percent_change":{"format":"double","type":"number"}},"type":"object"},"swagger405":{"x-has-customfields":false,"type":"object","title":"405","properties":{"description":{"x-samplevalue":"Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected","type":"string"}}},"BulkJobList":{"title":"BulkJobList","properties":{"record_count":{"x-samplevalue":41,"format":"int32","type":"integer"},"job_query":{"x-samplevalue":"SELECT attributes.organizationid, attributes.systemuserid, organizationid FROM users WHERE organizationid = '3b80f68d-b945-4208-9442-f55bd0e1c5b2'","type":"string"},"job_reset_attempt":{"x-samplevalue":0,"format":"int32","type":"integer"},"completion_time":{"x-samplevalue":1542829827804,"format":"int64","type":"integer"},"status":{"x-samplevalue":"COMPLETED","type":"string"},"notification_url":{"type":"string"},"job_direction":{"x-samplevalue":"DOWNLOAD","type":"string"},"error_count":{"x-samplevalue":0,"format":"int32","type":"integer"},"job_state":{"type":"string"},"createdDate":{"x-samplevalue":1542829826619,"format":"int64","type":"integer"},"id":{"x-samplevalue":1722,"format":"int32","type":"integer"},"instanceId":{"x-samplevalue":123453,"format":"int32","type":"integer"},"object_name":{"x-samplevalue":"systemuser","type":"string"},"fileFormat":{"x-samplevalue":"csv","type":"string"}},"type":"object"},"objectsMetadataFields":{"properties":{"mask":{"type":"string"},"type":{"type":"string"},"vendorDisplayName":{"type":"string"},"vendorPath":{"type":"string"},"vendorReadOnly":{"type":"boolean"},"vendorRequired":{"type":"boolean"}},"type":"object"},"createUsers":{"properties":{"$distinct_id":{"type":"string"},"$ip":{"type":"string"},"$set":{"$ref":"#/definitions/$set"}},"required":["$distinct_id","$set"],"x-primary-key":["$distinct_id"],"type":"object"},"$set":{"properties":{"Address":{"type":"string"}},"type":"object"},"bulkDownloadRequestDocsHubDetails":{"properties":{"instanceId":{"type":"string","x-samplevalue":"1234"},"path":{"type":"string","x-samplevalue":"/myfolder/in/googledrive/myfilename.extention"}},"title":"docsHubDetails","type":"object"},"swaggerDocs":{"x-has-customfields":false,"title":"swaggerDocs","properties":{"basePath":{"x-samplevalue":"/elements/api-v2/hubs/crm","type":"string"},"paths":{"$ref":"#/definitions/swaggerpaths"},"host":{"x-samplevalue":"localhost:5050","type":"string"},"schemes":{"x-samplevalue":["http"],"type":"array","items":{"type":"string"}},"definitions":{"$ref":"#/definitions/swaggerdefinitions"},"swagger":{"x-samplevalue":"2.0","type":"string"},"info":{"$ref":"#/definitions/swaggerinfo"},"tags":{"type":"array","items":{"$ref":"#/definitions/swaggertags"}}},"type":"object"},"users":{"properties":{"success":{"type":"boolean"}},"type":"object"},"swaggercontact":{"x-has-customfields":false,"type":"object","title":"contact","properties":{"email":{"x-samplevalue":"support@cloud-elements.com","type":"string"}}},"bulkDownloadRequestQuery":{"properties":{"anyKey":{"type":"string","x-samplevalue":"anyValue"}},"title":"query","type":"object"},"activities":{"properties":{"success":{"type":"boolean"}},"type":"object"},"swaggerpost":{"x-has-customfields":false,"type":"object","title":"post","properties":{"summary":{"x-samplevalue":"Create a new contact in the CRM service. Contact creation will flow through Cloud Elements to your CRM service. With the exception of the 'id' field, the required fields indicated in the 'Contact' model are those required to create a new contact.","type":"string"},"operationId":{"x-samplevalue":"createContact","type":"string"},"responses":{"$ref":"#/definitions/swaggerresponses"},"parameters":{"type":"array","items":{"$ref":"#/definitions/swaggerparameters"}},"tags":{"x-samplevalue":["contacts"],"type":"array","items":{"type":"string"}}}},"swagger406":{"x-has-customfields":false,"type":"object","title":"406","properties":{"description":{"x-samplevalue":"Not acceptable - The response content type does not match the 'Accept' header value","type":"string"}}},"swaggerdefinition-property":{"x-has-customfields":false,"type":"object","title":"#/definitions/definition-property","properties":{"type":{"x-samplevalue":"string","type":"string"}}},"Object":{"description":"Fields for the object. There will be fields associated with an Object, which are not all described here.","properties":{"objectField":{"type":"string"}},"type":"object"},"updateUsers":{"properties":{"$ip":{"type":"string"},"$set":{"$ref":"#/definitions/$set"}},"required":["$set"],"x-primary-key":["$distinct_id"],"type":"object"},"swagger409":{"x-has-customfields":false,"type":"object","title":"409","properties":{"description":{"x-samplevalue":"Conflict - If a resource being created already exists","type":"string"}}},"objectsMetadata":{"properties":{"fields":{"items":{"$ref":"#/definitions/objectsMetadataFields"},"type":"array"}},"type":"object"},"swaggertags":{"x-has-customfields":false,"title":"tags","properties":{"name":{"x-samplevalue":"contacts","type":"string"}},"type":"object"},"properties":{"properties":{"Referred By":{"type":"string"},"distinct_id":{"type":"string"}},"type":"object"},"Pong":{"properties":{"dateTime":{"format":"date-time","type":"string"},"endpoint":{"type":"string"},"valid":{"type":"boolean"}},"type":"object"}},"swagger":"2.0","info":{"x-element-name":"Mixpanel","x-element-hub":"general","x-element-key":"mixpanel","contact":{"email":"support@cloud-elements.com"},"title":"mixpanel","x-element-id":52738,"version":"api-v2"},"tags":[{"name":"activities"},{"name":"ping"},{"name":"objects"},{"name":"objectName"},{"name":"bulk"},{"name":"users"}]}