You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: documentation/api.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Breinify's DigitalDNA API puts dynamic behavior-based, people-driven data right
8
8
9
9
### API Library Documentation
10
10
11
-
The library provides several attributes, methods, and objects to simplify the usage of the Breinify API. Besides methods to actually send or retrieve data, it also includes general information (e.g., about the version and used configuration), as well as utilities. Thus, the following documentation is organized in three sections: *General Information*, *API*, and *Utilities (UTL)*.
11
+
The library provides several attributes, methods, and objects to simplify the usage of the Breinify API. Besides methods to actually send or retrieve data, it also includes general information (e.g., about the version and used configuration), as well as utilities. Thus, the following documentation is organized in three sections: *General Attributes*, *API*, and *Utilities (UTL)*.
12
12
13
13
This documentation is organized as following:
14
14
@@ -95,7 +95,7 @@ This documentation is organized as following:
95
95
<br/>
96
96
97
97
***Breinify.setConfig(config)**:<br/>
98
-
Contains the current version of the usage library. If an error occurred while loading the library, the version is set to be *'FALLBACK'*.
98
+
Updates the current configuration of the library for the properties supplied.
99
99
100
100
**Parameters**:
101
101
@@ -112,7 +112,7 @@ This documentation is organized as following:
Sends an activity to the engine utilizing the API. The call is done asynchronously as POST request. It is important, that a valid API-key is configured prior to using this function.
115
+
Sends an activity to the engine utilizing the API. The call is done asynchronously as a POST request. It is important that a valid API-key is configured prior to using this function.
116
116
117
117
**Parameters**:
118
118
@@ -122,11 +122,11 @@ This documentation is organized as following:
122
122
123
123
{string|null} **category**: The category of the platform/service/products, i.e., one of *apparel*, *home*, *education*, *family*, *food*, *health*, *job*, *services*, or *other*. If not specified, the configured type (see *Breinify.config().category*) is used.
124
124
125
-
{string|null} **description**: A string with further information about hte activity performed. Depending on the type of the activity, these are typically: the used search query (type === 'search'), the name of the selected product (type === 'selectProduct'), the item added or removed from the cart (type === 'addToCart' || type === 'removeFromCart'), and the amount of items or the value of items with currency (type === 'checkout').
125
+
{string|null} **description**: A string with further information about the activity performed. Depending on the type of the activity, some typical descriptions are: the used search query (type === 'search'), the name of the selected product (type === 'selectProduct'), the item added or removed from the cart (type === 'addToCart' || type === 'removeFromCart'), and the amount or monetary value items (type === 'checkout').
126
126
127
-
{boolean|null} **sign**: A boolean value, specifying if the call should be sign, only available if the *secret* is configured. It is strongly advised, not to use a signed call when utilizing this library.
127
+
{boolean|null} **sign**: A boolean value specifying if the call should be signed, which is only available if the *secret* is configured. It is strongly advised not to use a signed call when utilizing this library.
128
128
129
-
{function|null} **onReady**: A function, which is triggered after the activity was sent to the user. The function has the information sent as first parameter.
129
+
{function|null} **onReady**: A function which is triggered after the activity was sent to the user. The function has the information sent as the first parameter.
130
130
131
131
**Example Usage**:
132
132
```javascript
@@ -145,13 +145,13 @@ This documentation is organized as following:
145
145
146
146
**Parameters**:
147
147
148
-
{object} **user**: A plain object specifying the user information the information should be retrieved for. More information about the structure can be found [here](TODO).
148
+
{object} **user**: A plain object specifying information about the user to retrieve data for. More about the user structure can be found [here](TODO).
149
149
150
150
{[string]} **dimensions**: An array containing the names of the dimensions to lookup.
151
151
152
-
{boolean|null} **sign**: A boolean value, specifying if the call should be sign, only available if the *secret* is configured. It is strongly advised, not to use a signed call when utilizing this library.
152
+
{boolean|null} **sign**: A boolean value specifying if the call should be signed, which is only available if the *secret* is configured. It is strongly advised not to use a signed call when utilizing this library.
153
153
154
-
{function|null} **onLookUp**: A function, which is triggered after the result of the lookup was retrieved. The function has the retrieved information as first parameter.
154
+
{function|null} **onLookUp**: A function which is triggered after the lookup result has been retrieved. The function has the retrieved information as the first parameter.
155
155
156
156
**Example Usage**:
157
157
```javascript
@@ -522,4 +522,4 @@ The cookie part of the utilities contains functions to validate, match, or retri
522
522
window.alert('Is the funny session over or did it never start?');
0 commit comments