This API provides Evolv customers the ability to integrate with the Evolv Platform in to way most optimal for their specific usecase.
\nBenefits
\nThis endpoint will provide data about all experiments a user is currently participating in.
\n","auth":{"type":"bearer","bearer":{"token":"The unique identifier of the Participant to allocate into current experiments. This value is always required.
\n","type":"text/plain"},"key":"uid","value":"96109008_1657045713019"},{"description":{"content":"The unique identifier of the Participant's current session. This value is optional.
\n","type":"text/plain"},"key":"sid","value":"21646621_1658149742929"}],"variable":[]}},"response":[{"id":"298678f3-67b5-40d5-92e7-3d0f580644a9","name":"Get Participants Allocations","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{root_domain}}/{{participant_api_version}}/{{environment_id}}/allocations?uid=96109008_1657045713019&sid=21646621_1658149742929","host":["{{root_domain}}"],"path":["{{participant_api_version}}","{{environment_id}}","allocations"],"query":[{"key":"uid","value":"96109008_1657045713019","description":"The unique identifier of the Participant to allocate into current experiments."},{"key":"sid","value":"21646621_1658149742929","description":"The unique identifier of the Participant's current session."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"excluded\": false,\n \"uid\": \"test_user\",\n \"sid\": \"test_session\",\n \"eid\": \"experiment_id\",\n \"cid\": \"candidate_id\",\n \"genome\": {\n\t\t\t\"search\": {\n\t\t\t\t\"weighting\": {\n\t\t\t\t\t\"distance\": 2.5,\n\t\t\t\t\t\"dealer_score\": 2.5\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"pages\": {\n\t\t\t\t\"all_pages\": {\n\t\t\t\t\t\"header_footer\": [\n\t\t\t\t\t\t\"blue\",\n\t\t\t\t\t\t\"white\"\n\t\t\t\t\t]\n\t\t\t\t},\n\t\t\t\t\"testing_page\": {\n\t\t\t\t\t\"megatron\": \"none\",\n\t\t\t\t\t\"header\": \"white\"\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"algorithms\": {\n\t\t\t\t\"feature_importance\": false\n\t\t\t}\n\t\t}\n }\n]"}],"_postman_id":"310469ab-9c71-4536-ac95-c829491a3c16"},{"name":"Allocate Participant Into Experiments","id":"44a6c53b-ed8a-4be4-be67-030da920ead4","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"uid","value":"96109008_1657045713019","type":"text","description":"The unique identifier of the Participant to allocate into current experiments. This value is always required.
\n"},{"key":"sid","value":"21646621_1658149742929","type":"text","description":"The unique identifier of the Participant's current session. This value is optional.
\n"}]},"url":"{{root_domain}}/{{participant_api_version}}/{{environment_id}}/allocations","description":"This request will attempt to update a participant's allocations based on the values in the request body.
\n","auth":{"type":"bearer","bearer":{"token":"Update the allocations of a specific user. For all experiments a participant is eligible for, this endpoint will return the candidate allocation they would receive. Note that they are not yet considered a part of the experiment.
\nThis endpoint respects experiment throttling and audience filters.
\n","event":[{"listen":"prerequest","script":{"id":"96b9fe6c-fd69-471f-ac50-95bbc54a3433","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eb7a67fb-8e87-4c7f-9fbc-3c67f3ee9176","type":"text/javascript","exec":[""]}}],"_postman_id":"f9e12d0f-cf26-477f-9f03-ae8e24852374","auth":{"type":"bearer","bearer":{"token":"The event type to record. This can be any value. \"confirmation\" and \"contamination\" have a special meaning in the system, where \"confirmation\" registers a user as active on a give experiment / candidate, and \"contamination\" will exclude the specified user from being counted in an experiment / candidate.
\n","type":"text/plain"},"key":"type","value":"confirmation"},{"description":{"content":"The identifier of the experiment for which the event occured. This should only be passed for \"confirmation\" and \"contamination\" events.
\n","type":"text/plain"},"key":"eid","value":"7e25506c1b"},{"description":{"content":"The identifier of the candidate for which the event occured. This should only be passed for \"confirmation\" and \"contamination\" events.
\n","type":"text/plain"},"key":"cid","value":"2c3aefac54a4:7e25506c1b"},{"description":{"content":"The unique identifier associated with the current Participant. This value is always required.
\n","type":"text/plain"},"key":"uid","value":"96109008_1657045713019"},{"description":{"content":"The unique identifier associated with the current Participant. This value is optional.
\n","type":"text/plain"},"key":"sid","value":"21646621_1658149742929"},{"description":{"content":"The numeric score associated with the event.
\n","type":"text/plain"},"key":"score","value":"1.0"}],"variable":[]}},"response":[{"id":"05bb8832-8c2d-43d8-b48a-45d56b6d5bb9","name":"Confirm A Candidate","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{root_domain}}/{{participant_api_version}}/{{environment_id}}/events?type=confirmation&eid=7e25506c1b&cid=2c3aefac54a4:7e25506c1b&uid=96109008_1657045713019&sid=21646621_1658149742929","host":["{{root_domain}}"],"path":["{{participant_api_version}}","{{environment_id}}","events"],"query":[{"key":"type","value":"confirmation","description":"The event type to record. This can be any value. \"confirmation\" and \"contamination\" have a special meaning in the system, where \"confirmation\" registers a user as active on a give experiment / candidate, and \"contamination\" will exclude the specified user from being counted in an experiment / candidate."},{"key":"eid","value":"7e25506c1b","description":"The identifier of the experiment for which the event occured. This should only be passed for \"confirmation\" and \"contamination\" events."},{"key":"cid","value":"2c3aefac54a4:7e25506c1b","description":"The identifier of the candidate for which the event occured. This should only be passed for \"confirmation\" and \"contamination\" events."},{"key":"uid","value":"96109008_1657045713019","description":"The unique identifier associated with the current Participant. This value is always required."},{"key":"sid","value":"21646621_1658149742929","description":"The unique identifier associated with the current Participant. This value is optional."},{"key":"score","value":"1.0","description":"The numeric score associated with the event.","disabled":true}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"plain","header":[{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"CloudFront"},{"key":"Date","value":"Mon, 01 Apr 2019 13:52:01 GMT"},{"key":"Set-Cookie","value":"_ascend_session_sandbox=test_session; Max-Age=1800"},{"key":"Set-Cookie","value":"_ascend_uid=test_user; Max-Age=31557600"},{"key":"Set-Cookie","value":"_ascend_candidate_sandbox=eyJlaWQiOiJleHBlcmltZW50XzEiLCJjaWQiOiJjYW5kaWRhdGVfMSJ9; Max-Age=2592000"},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"LambdaGeneratedResponse from cloudfront"},{"key":"Via","value":"1.1 a1aa00de8387e7235a256b2a5b73ede8.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"8zNHB0fF6QPwetf-0dFTgFp18dg8IbDZ6OImxNoL1V7jC5XJyqJ3kg=="}],"cookie":[],"responseTime":null,"body":null},{"id":"c4e91b7f-b6d3-457e-b3bf-5377a38b0475","name":"Record An Event","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{root_domain}}/{{participant_api_version}}/{{environment_id}}/events?type=conversion&uid=96109008_1657045713019&sid=21646621_1658149742929&score=1.0","host":["{{root_domain}}"],"path":["{{participant_api_version}}","{{environment_id}}","events"],"query":[{"key":"type","value":"conversion","description":"The event type to record."},{"key":"uid","value":"96109008_1657045713019","description":"The unique identifier associated with the current Participant."},{"key":"sid","value":"21646621_1658149742929","description":"The unique identifier associated with the current Participant."},{"key":"score","value":"1.0","description":"The numeric score associated with the event."}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"bb06aff4-bf69-4397-954e-1e618035d8dd"},{"name":"Record An Event And Redirect","id":"8839166e-dce3-49c8-9151-f06a687cff21","request":{"method":"GET","header":[],"url":"{{root_domain}}/{{participant_api_version}}/{{environment_id}}/events?type=conversion&uid=96109008_1657045713019&sid=21646621_1658149742929&score=0.0&target=http%3A%2F%2Fwww.google.com","auth":{"type":"bearer","bearer":{"token":"The event type to record. This can be any value. \"confirmation\" and \"contamination\" have a special meaning in the system, where \"confirmation\" registers a user as active on a give experiment / candidate, and \"contamination\" will exclude the specified user from being counted in an experiment / candidate.
\n","type":"text/plain"},"key":"type","value":"conversion"},{"description":{"content":"The unique identifier associated with the current Participant. This value is always required.
\n","type":"text/plain"},"key":"uid","value":"96109008_1657045713019"},{"description":{"content":"The unique identifier associated with the current Participant. This value is optional.
\n","type":"text/plain"},"key":"sid","value":"21646621_1658149742929"},{"description":{"content":"The numeric score associated with the event.
\n","type":"text/plain"},"key":"score","value":"0.0"},{"description":{"content":"The location you would like the participant redirected to once the message has been recorded.
\n","type":"text/plain"},"key":"target","value":"http%3A%2F%2Fwww.google.com"}],"variable":[]}},"response":[{"id":"3fb6c303-2267-4940-b3d1-b9e4227e651e","name":"Record An Event And Redirect","originalRequest":{"method":"GET","header":[{"key":"Location","value":"some_target","description":"The location the user will be redirected to after the event is recorded."}],"url":{"raw":"{{root_domain}}/{{participant_api_version}}/{{environment_id}}/events?type=conversion&uid=96109008_1657045713019&sid=21646621_1658149742929&score=1.0&target=http%3A%2F%2Fwww.google.com","host":["{{root_domain}}"],"path":["{{participant_api_version}}","{{environment_id}}","events"],"query":[{"key":"type","value":"conversion","description":"The event type to record. (confirmed, impression, goal_achieved)"},{"key":"uid","value":"96109008_1657045713019","description":"The unique identifier associated with the current Participant."},{"key":"sid","value":"21646621_1658149742929","description":"The unique identifier of the Participant's current session."},{"key":"score","value":"1.0","description":"The numeric score associated with the event."},{"key":"target","value":"http%3A%2F%2Fwww.google.com","description":"The location you would like the participant redirected to once the message has been recorded."}]}},"status":"Found","code":302,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8839166e-dce3-49c8-9151-f06a687cff21"},{"name":"Record An Event","id":"36e38dd9-bf20-4cc8-b2d1-4f3c6a74e967","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"type","value":"conversion","type":"text","description":"The event type to record. This can be any value. \"confirmation\" and \"contamination\" have a special meaning in the system, where \"confirmation\" registers a user as active on a give experiment / candidate, and \"contamination\" will exclude the specified user from being counted in an experiment / candidate.
\n"},{"key":"uid","value":"96109008_1657045713019","type":"text","description":"The unique identifier associated with the current Participant. This value is always required.
\n"},{"key":"sid","value":"21646621_1658149742929","description":"The unique identifier associated with the current Participant. This value is optional.
\n","type":"text"},{"key":"score","value":"1.0","type":"text","description":"The numeric score associated with the event
\n"}]},"url":"{{root_domain}}/{{participant_api_version}}/{{environment_id}}/events","auth":{"type":"bearer","bearer":{"token":"Inform Ascend of the experiment details. Primarily confirming a user into an experiment, recording conversion and sending general event information.
\nThese events can be configured with targets to redirect to. This is useful in cases where the customer wants to record a conversion through the user clicking a link. The link can be configured to be a call to Ascend saying the goal has been achieved, then redirect on to the desired location.
\n","event":[{"listen":"prerequest","script":{"id":"93c42b9c-15bb-4b6f-94ec-7faa45e4f7ab","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b9c4f42d-93fb-4600-873d-aa8e789af955","type":"text/javascript","exec":[""]}}],"_postman_id":"56ceede3-6706-4b63-8aee-b755b05e8fa1","auth":{"type":"bearer","bearer":{"token":"If eid is provided, this request will return count preallocations for the specified experiment identifier.
If eid is not provided, this request will return an array of count preallocations for each experiment in the specified environment identifier.
The identifier of the experiment to generate preallocations for. This value is required.
\n","type":"text/plain"},"key":"eid","value":"7e25506c1b"},{"description":{"content":"The number of preallocations to create. (Default: 1)
\n","type":"text/plain"},"key":"count","value":"10"}],"variable":[]}},"response":[{"id":"a97643f5-cb05-4939-9cfc-7f08afa42301","name":"Basic Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{root_domain}}/{{participant_api_version}}/{{environment_id}}/preallocations?eid=7e25506c1b&count=10","host":["{{root_domain}}"],"path":["{{participant_api_version}}","{{environment_id}}","preallocations"],"query":[{"key":"eid","value":"7e25506c1b","description":"The identifier of the experiment to generate preallocations for."},{"key":"count","value":"10","description":"The number of preallocations to create."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true","name":"Access-Control-Allow-Credentials","description":"Indicates whether or not the response to the request can be exposed when the credentials flag is true. When used as part of a response to a preflight request, this indicates whether or not the actual request can be made using credentials."},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Cache-Control","value":"no-cache, no-store, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"401","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 21 Sep 2018 17:46:18 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Expires","value":"0","name":"Expires","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","name":"Pragma","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"Server","value":"CloudFront","name":"Server","description":"A name for the server"},{"key":"Via","value":"1.1 dd8f9d87a6d86878defca85ee01d6d4e.cloudfront.net (CloudFront)","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Amz-Cf-Id","value":"U2kps2i4b_7hN4NWg2UnE62FfyWy_DTIsNFDVLjaary-hQP_uixCRA==","name":"X-Amz-Cf-Id","description":"Custom header"},{"key":"X-Cache","value":"Miss from cloudfront","name":"X-Cache","description":"Custom header"}],"cookie":[{"expires":"Fri Sep 21 2018 18:14:21 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"b847fd1.participant.ascend.ai","path":"/v1/0-0","secure":false,"value":"test_sid","key":"_ascend_session_0-0"}],"responseTime":null,"body":"[\n{\n \"eid\": \"d8980de2ed\",\n \"cid\": \"d980e25485b719812720691415245159:d8980de2ed\",\n \"genome\":\n {\n \"search\":\n {\n \"weighting\":\n {\n \"distance\": 2.5,\n \"dealer_score\": 2.5\n }\n },\n \"pages\":\n {\n \"all_pages\":\n {\n \"header_footer\": [\"blue\", \"white\"]\n },\n \"testing_page\":\n {\n \"megatron\": \"none\",\n \"header\": \"white\"\n }\n },\n \"algorithms\":\n {\n \"feature_importance\": false\n }\n }\n},\n{\n \"eid\": \"d8980de2ed\",\n \"cid\": \"d980e25485b719812720691415245159:d8980de2ed\",\n \"genome\":\n {\n \"search\":\n {\n \"weighting\":\n {\n \"distance\": 2.5,\n \"dealer_score\": 2.5\n }\n },\n \"pages\":\n {\n \"all_pages\":\n {\n \"header_footer\": [\"blue\", \"white\"]\n },\n \"testing_page\":\n {\n \"megatron\": \"none\",\n \"header\": \"white\"\n }\n },\n \"algorithms\":\n {\n \"feature_importance\": false\n }\n }\n},\n{\n \"eid\": \"d8980de2ed\",\n \"cid\": \"d980e25485b719812720691415245159:d8980de2ed\",\n \"genome\":\n {\n \"search\":\n {\n \"weighting\":\n {\n \"distance\": 2.5,\n \"dealer_score\": 2.5\n }\n },\n \"pages\":\n {\n \"all_pages\":\n {\n \"header_footer\": [\"blue\", \"white\"]\n },\n \"testing_page\":\n {\n \"megatron\": \"none\",\n \"header\": \"white\"\n }\n },\n \"algorithms\":\n {\n \"feature_importance\": false\n }\n }\n},\n{\n \"eid\": \"d8980de2ed\",\n \"cid\": \"d980e25485b719812720691415245159:d8980de2ed\",\n \"genome\":\n {\n \"search\":\n {\n \"weighting\":\n {\n \"distance\": 2.5,\n \"dealer_score\": 2.5\n }\n },\n \"pages\":\n {\n \"all_pages\":\n {\n \"header_footer\": [\"blue\", \"white\"]\n },\n \"testing_page\":\n {\n \"megatron\": \"none\",\n \"header\": \"white\"\n }\n },\n \"algorithms\":\n {\n \"feature_importance\": false\n }\n }\n},\n{\n \"eid\": \"d8980de2ed\",\n \"cid\": \"d980e25485b719812720691415245159:d8980de2ed\",\n \"genome\":\n {\n \"search\":\n {\n \"weighting\":\n {\n \"distance\": 2.5,\n \"dealer_score\": 2.5\n }\n },\n \"pages\":\n {\n \"all_pages\":\n {\n \"header_footer\": [\"blue\", \"white\"]\n },\n \"testing_page\":\n {\n \"megatron\": \"none\",\n \"header\": \"white\"\n }\n },\n \"algorithms\":\n {\n \"feature_importance\": false\n }\n }\n},\n{\n \"eid\": \"d8980de2ed\",\n \"cid\": \"d980e25485b719812720691415245159:d8980de2ed\",\n \"genome\":\n {\n \"search\":\n {\n \"weighting\":\n {\n \"distance\": 2.5,\n \"dealer_score\": 2.5\n }\n },\n \"pages\":\n {\n \"all_pages\":\n {\n \"header_footer\": [\"blue\", \"white\"]\n },\n \"testing_page\":\n {\n \"megatron\": \"none\",\n \"header\": \"white\"\n }\n },\n \"algorithms\":\n {\n \"feature_importance\": false\n }\n }\n},\n{\n \"eid\": \"d8980de2ed\",\n \"cid\": \"d980e25485b719812720691415245159:d8980de2ed\",\n \"genome\":\n {\n \"search\":\n {\n \"weighting\":\n {\n \"distance\": 2.5,\n \"dealer_score\": 2.5\n }\n },\n \"pages\":\n {\n \"all_pages\":\n {\n \"header_footer\": [\"blue\", \"white\"]\n },\n \"testing_page\":\n {\n \"megatron\": \"none\",\n \"header\": \"white\"\n }\n },\n \"algorithms\":\n {\n \"feature_importance\": false\n }\n }\n},\n{\n \"eid\": \"d8980de2ed\",\n \"cid\": \"d980e25485b719812720691415245159:d8980de2ed\",\n \"genome\":\n {\n \"search\":\n {\n \"weighting\":\n {\n \"distance\": 2.5,\n \"dealer_score\": 2.5\n }\n },\n \"pages\":\n {\n \"all_pages\":\n {\n \"header_footer\": [\"blue\", \"white\"]\n },\n \"testing_page\":\n {\n \"megatron\": \"none\",\n \"header\": \"white\"\n }\n },\n \"algorithms\":\n {\n \"feature_importance\": false\n }\n }\n},\n{\n \"eid\": \"d8980de2ed\",\n \"cid\": \"d980e25485b719812720691415245159:d8980de2ed\",\n \"genome\":\n {\n \"search\":\n {\n \"weighting\":\n {\n \"distance\": 2.5,\n \"dealer_score\": 2.5\n }\n },\n \"pages\":\n {\n \"all_pages\":\n {\n \"header_footer\": [\"blue\", \"white\"]\n },\n \"testing_page\":\n {\n \"megatron\": \"none\",\n \"header\": \"white\"\n }\n },\n \"algorithms\":\n {\n \"feature_importance\": false\n }\n }\n},\n{\n \"eid\": \"d8980de2ed\",\n \"cid\": \"d980e25485b719812720691415245159:d8980de2ed\",\n \"genome\":\n {\n \"search\":\n {\n \"weighting\":\n {\n \"distance\": 2.5,\n \"dealer_score\": 2.5\n }\n },\n \"pages\":\n {\n \"all_pages\":\n {\n \"header_footer\": [\"blue\", \"white\"]\n },\n \"testing_page\":\n {\n \"megatron\": \"none\",\n \"header\": \"white\"\n }\n },\n \"algorithms\":\n {\n \"feature_importance\": false\n }\n }\n}]"}],"_postman_id":"10343aac-81ea-4ef3-bd29-e406d86581fa"}],"id":"4a1227bb-d8cb-4a28-ac42-fd9da976e2cf","description":"Intended for offline use. Bulk request n preallocations for the customer to associate with users at their discretion.
\n","event":[{"listen":"prerequest","script":{"id":"3e67e3c1-2f88-4d18-9b5f-2cd5425c2a3f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c5d45d28-3f08-4276-94e4-8cf0221e92c2","type":"text/javascript","exec":[""]}}],"_postman_id":"4a1227bb-d8cb-4a28-ac42-fd9da976e2cf","auth":{"type":"bearer","bearer":{"token":"