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

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 }}