{"_id":"57453f7d6aa4860e00c2e18a","user":"57061c3e21cfed0e00e8c640","parentDoc":null,"__v":5,"githubsync":"","project":"5706099c21cfed0e00e8c60b","category":{"_id":"57441052583f470e000a7947","__v":0,"project":"5706099c21cfed0e00e8c60b","version":"5706099c21cfed0e00e8c60e","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-05-24T08:26:58.716Z","from_sync":false,"order":9999,"slug":"experience-mining-api","title":"Experience Mining API"},"editedParams":true,"editedParams2":true,"version":{"_id":"5706099c21cfed0e00e8c60e","hasDoc":true,"project":"5706099c21cfed0e00e8c60b","__v":6,"hasReference":true,"createdAt":"2016-04-07T07:17:48.808Z","releaseDate":"2016-04-07T07:17:48.808Z","categories":["5706099c21cfed0e00e8c60f","573548f4afab4417007239cf","57354970fc5f1e0e001a463c","573549791f16241700c89fc9","57441052583f470e000a7947","57a068f90c933e0e00249bae"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.17","version":"1.0.17"},"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-25T06:00:29.535Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"name":"","code":"{\n\t\"ruleCode\": String\n}","language":"json","status":"2XX"},{"status":"4XX","name":"","code":"{\n  \"error\": String,\n  \"errorCode\": String\n}","language":"json"}]},"settings":"576a36aadd4f320e0060b806","examples":{"codes":[{"name":"request - body","language":"json","code":"{\n  \"expCode\": \"ZIPCD\",\n  \"minsup\": 0.001,\n  \"minconf\": 0.8,\n  \"from\": \"20151201\",\n  \"to\": \"20160201\",\n  \"ruleMining\": [\n    {\n      \"type\": \"UniqueSequentialVisitRuleMining\",\n      \"minLength\": 2,\n      \"maxLength\": 10\n    }\n  ]\n}"},{"name":"response - success","language":"json","code":"{\n  \"ruleCode\": \"146e5491-6c05-4fe3-b569-609ca0f4b737\"\n}"},{"name":"response - error","language":"json","code":"{\n  \"error\": \"Failed to parse Json for [RuleMining]\",\n  \"errorCode\": \"4001\"\n}"}]},"auth":"required","params":[{"_id":"5774b438e719e01900625a20","ref":"","in":"body","required":true,"desc":"expCode to use for the mining. The value should be one of the expCodes provided when logs were added.","default":"","type":"string","name":"expCode"},{"_id":"5774b438e719e01900625a1f","ref":"","in":"body","required":true,"desc":"Minimum support value to use for the mining. For more information, check \"Experience Mining\" section.","default":"","type":"double","name":"minsup"},{"_id":"5774b438e719e01900625a1e","ref":"","in":"body","required":true,"desc":"Minimum confidence value to use for the mining.","default":"","type":"double","name":"minconf"},{"_id":"5774b438e719e01900625a1d","ref":"","in":"body","required":false,"desc":"The start time of the time period to perform the mining.","default":"","type":"timestamp","name":"from"},{"_id":"57a077471435850e00dfbc23","ref":"","in":"header","required":false,"desc":"An API key.","default":"","type":"string","name":"x-api-key"},{"_id":"57a083b00c933e0e00249bd2","ref":"","in":"body","required":false,"desc":"The end time of the time period for the mining.","default":"","type":"timestamp","name":"to"},{"_id":"57a083b00c933e0e00249bd1","ref":"","in":"body","required":true,"desc":"An array of rule mining criteria to use for the mining.","default":"","type":"array_object","name":"ruleMining"},{"_id":"57a083c519a5850e0096aa1c","ref":"","in":"body","required":false,"desc":"URL to receive the result once mining is finished.","default":"","type":"string","name":"callbackUrl"}],"url":"/mining"},"isReference":false,"order":1,"body":"","excerpt":"It triggers the mining process","slug":"mine-rules","type":"endpoint","title":"/mining"}

post/mining

It triggers the mining process

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

expCode:
required
string
expCode to use for the mining. The value should be one of the expCodes provided when logs were added.
minsup:
required
double
Minimum support value to use for the mining. For more information, check "Experience Mining" section.
minconf:
required
double
Minimum confidence value to use for the mining.
from:
timestamp
The start time of the time period to perform the mining.
to:
timestamp
The end time of the time period for the mining.
ruleMining:
required
array of objects
An array of rule mining criteria to use for the mining.
callbackUrl:
string
URL to receive the result once mining is finished.

Headers

x-api-key:
string
An API key.

Examples


Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}