WebApriori WebAPI

Endpoint

Url

Parameters (Header section)

content-type

cache-control

Accept-Encoding

Connection

Parameters (Body section)

WebAPI key

Dataset Type

File


curl -X POST \
##0## \
-H 'cache-control: no-cache' \
-H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
-F email=##1## \
-F apiKey=##2## \
-F fileToUpload=@/TheAbsoluteFilePath.csv \
-F datasetType=##3##

Endpoint

Url

Parameters (Header section)

content-type

cache-control

Accept-Encoding

Connection

Parameters (Body section)

WebAPI key


POST ##0## HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache
Accept: */*
Accept-Encoding: gzip, deflate
Connection: keep-alive

email=##1##&apiKey=##2##

Endpoint

Url

Parameters (Header section)

content-type

cache-control

Accept-Encoding

Connection

Parameters (Body section)

WebAPI key

Dataset Id


POST ##0## HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Cache-Control: no-cache
Accept-Encoding: gzip, deflate
Connection: keep-alive

email=##1##&apiKey=##2##&datasetId=##3##

Endpoint

Url

Parameters (Header section)

content-type

cache-control

Accept-Encoding

Connection

Parameters (Body section)

WebAPI key

Dataset Id

sep

Min supp

Min conf

Min lift

Max Items

Parameters

Redundant rules elimination type


POST ##0## HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache
Accept: */*
Accept-Encoding: gzip, deflate
Connection: keep-alive

email=##1##&apiKey=##2##&datasetId=##3##&separator=##4##&min_support=##5##&min_confidence=##6##&min_lift=##7##&max_length=##8##&redundantType=##9####10##

Endpoint

Url

Parameters (Header section)

content-type

cache-control

Accept-Encoding

Connection

Parameters (Body section)

WebAPI key

Dataset Id


POST ##0## HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Cache-Control: no-cache
Accept-Encoding: gzip, deflate
Connection: keep-alive

email=##1##&apiKey=##2##&datasetId=##3##

Supported dataset types

1) Market Basket list. No header is expected, The number of columns is undefined (Default). If header row exists then in 1st parameter of the extra parameters field the string representing the absent item must be declared. If absent item is nothing or not exists then assign "" or "nan". The participant columns must be declared in extra parameters field starting from the 2nd parameter.
Examples

2) Order/Invoice detail. Header line is mandatory in that type. Number of columns is fixed in the dataset. In extra parameters field, 1st parameter represents the primary key column while 2nd parameter represents the items column and are both mandatory.
Example

3) sparse item Dataset. Header line is mandatory in that type of dataset and the number of columns/items is fixed. Item columns are mandatory to be declared from the 2nd parameter and above in extra parameters field. In 1st parameter, the string of absent item must be declared!!! If absent item is nothing then assign '' or 'nan'.
Examples

4) Columns with multiple categorized values. Header line is optional. Number of columns is fixed, optionally, items columns are expected in extra parameters field in case that header line exists.
Example

Note: In extra parameters, the items must be enclosed in double quotes and be seperated with space (e.g. "InvoiceID" "ProductID")

The supported types for excluding redundant rules from the association rule set are listed below.

Interchange LHS and RHS case: The comparable rules are the ones that have reversed their LHS and RHS (e.g. A->B & B->A). The rule with the smaller confidence value is removed.

Redundant Rules with Fixed RHS Removes redundant rules that have multiple items in LHS but have the same RHS itemset. If n number of (n-1) LHS-itemset with the same RHS rules are found in the retrieved rule set, the rule is removed otherwise remains. Example: If XY->Z, X->Z, Y->Z exist in the rule set then XY->Z is removed

Redundant Rules with Fixed LHS Removes redundant rules that have multiple items in RHS but have the same LHS itemset. If n number of (n-1) RHS-itemset with the same LHS rules are found in the retrieved rule set, the rule is removed otherwise remains. Example: If X->YZ, X->Y, X->Z exist in the rule set then X->YZ is removed

The types are selected using the bitwise AND (&) operator. For example, if it is desirable to select the first case then select the value 1 (001); If it is desirable the third one then select 4 (100); If it is desirable the second and third type then select 6 (110). With 0 (000) it does not remove the redundant rules.

WebAPI settings

WebAPI calls

Endpoint

Parameters (Header section)

Parameters (Body section)

Endpoint

Parameters (Header section)

Parameters (Body section)

Endpoint

Parameters (Header section)

Parameters (Body section)

Endpoint

Parameters (Header section)

Parameters (Body section)

Endpoint

Parameters (Header section)

Parameters (Body section)

Supported dataset types