ValueTracking

A ValueTracking object is created as a result of user activity. The endpoints in this section enables you to interact with the value tracking data collected by the app. Through the API you can create as well as retrieve value tracking data.
For more information please refer to Getting Started With Value Tracking

Endpoints

Here is the list of endpoints for ValueTracking.

  
    
          POST $BASE_URL/v1/value_tracking/{bucketId}
          GET $BASE_URL/v1/value_tracking/{bucketId}

1. Create an entry

Creates a ValueTracking entry for further reporting. You can use Konso App to evaluate the data.The following endpoint is utilized:

  
    POST $BASE_URL/v1/value_tracking/{bucketId}
The owner object

(Optional) end user details.

Attributes

The attributes refers to elements that makes up the request object:

avatar optional
string
End-user's avatar. Data anonymization rules applied by default
userName optional
string
End-user's name. Data anonymization rules applied by default

The request object

The request object contains an instance of an object that is to be sent to create a new ValueTracking entry. The object is transferred in the request's body.

Attributes
eventId required
number
Numeric event identification to attach to the entry. You can manage mapping via Konso App.
timeStamp required
number
Time at which the event was created. It's measured in seconds in the Unix epoch format.
owner optional
object
End-user details, according to your GDPR policy.
browser optional
string
End user's agent details.
ip optional
string
End user's IP address.
correlationId optional
string
Unique identity for binding events, metrics and logs together.
custom optional
string
Custom field.
appName optional
string
Application name useful for stream segmentation.
country optional
string
End user's country.
value optional
number
Business value of the action.
tags optional
strings array
Adding a tag(s) for the entry.
Sample Request Example
  
    POST $BASE_URL/v1/value_tracking/{bucketId}
  

  
    
          {
            "eventId":1,
            "timeStamp":"1619636875",
            "owner":null,
            "browser":null,
            "ip":null,
            "correlationId":null,
            "referenceId":null,
            "appName":"testApp",
            "country":"DE",
            "value": 49.00,
            "tags": ["test", "mvp"]
          }

2. Get entries

Returns value tracking entries matching the query filters.

Filter parameters

Lists and filters value tracking entries. Entries are kept in our storage according to retention days setting.

Attributes

The attributes refers to elements that makes up the filter parameters:

eventId optional
number
Only return entries for the eventId specified.
fromDate optional
number
A greater than or equals filter on the list timeStamp field, the value is in Unix epoch format.
toDate optional
number
A less than or equals filter on the list timeStamp field, the value is in Unix epoch format.
name optional
string
Lookup by name of event defined in Konso App Value Tacking > Mappings section.
correlationId optional
string
Only return entries for the correlationId specified.
appName optional
string
Only return entries for the appName specified.
from optional
number
A cursor user in pagination. The Default value is 0
to optional
number
A cursor user in pagination. The Default value is 10
tags optional
string
Filter results by tag. Multiple values are supported.
sort optional
number
1 - timestamp asc, 2 - timestamp desc (default), 3 - eventId asc, 4 - eventId desc .
Sample Request Example
  
    
          GET $BASE_URL/v1/value_tracking/{bucketId}
          ?eventId=1
          &fromDate=1619636000
          &toDate=1619637000
          &name=login
          &correlationId=
          &appName=testApp
          &tags=tag1
          &tags=tag2
          &sort=2
          &from=0
          &to=100