Tracking
Operations for tracking
Required Roles: ApiPublicQueries
The channel
If the product was added to search result by a campaign, this field should contain the campaign ID.
The number of items.
The ID of the product.
Contains the master ID, if the article is a variant and 'ID' refers to the variant.
The single-item price of the product.
The ID for Customer-Specific Info.
The session ID.
The title of the product.
The ID of the user who issued the request.
OK
Bad Request
Unauthorized
Forbidden
Server Error
POST /fact-finder//rest/v5/track/{channel}/cart HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 136
[
{
"campaign": "text",
"count": 1,
"id": "text",
"masterId": "text",
"price": 1,
"purchaserId": "text",
"sid": "text",
"title": "text",
"userId": "text"
}
]No content
Required Roles: ApiPublicQueries
The channel
If the product was added to search result by a campaign, this field should contain the campaign ID.
The number of items.
The ID of the product.
Contains the master ID, if the article is a variant and 'ID' refers to the variant.
The single-item price of the product.
The ID for Customer-Specific Info.
The session ID.
The title of the product.
The ID of the user who issued the request.
OK
Bad Request
Unauthorized
Forbidden
Server Error
POST /fact-finder//rest/v5/track/{channel}/checkout HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 136
[
{
"campaign": "text",
"count": 1,
"id": "text",
"masterId": "text",
"price": 1,
"purchaserId": "text",
"sid": "text",
"title": "text",
"userId": "text"
}
]No content
Required Roles: ApiPublicQueries
The channel
If the product was added to search results by a campaign, this field should contain the campaign ID.
The ID of the product.
Contains the master ID, if the article is a variant and 'ID' refers to the variant.
The page number of the search result that contains the product.
The current page size (possibly adjusted by the user) when the product was clicked.
The overall position of the product inside the search result.
The ID for Customer-Specific Info.
The search term that the user searched for.
The score of the product.
The session ID.
The title of the product.
The ID of the user who issued the request.
OK
Bad Request
Unauthorized
Forbidden
Server Error
POST /fact-finder//rest/v5/track/{channel}/click HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 171
[
{
"campaign": "text",
"id": "text",
"masterId": "text",
"page": 1,
"pageSize": 1,
"pos": 1,
"purchaserId": "text",
"query": "text",
"score": 1,
"sid": "text",
"title": "text",
"userId": "text"
}
]No content
Required Roles: ApiPublicQueries
The channel
Additional information provided by the user.
Set to true when the user gives a positive assessment of the result, otherwise false.
The search term that produced the corresponding search result.
The session ID.
OK
Bad Request
Unauthorized
Forbidden
Server Error
POST /fact-finder//rest/v5/track/{channel}/feedback HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 64
[
{
"message": "text",
"positive": true,
"query": "text",
"sid": "text"
}
]No content
Required Roles: ApiPublicQueries
The channel
The ID of the campaign, which added the product to the landing page.
The ID of the product.
Contains the master ID, if the article is a variant and 'ID' refers to the variant.
The ID of the landing page.
The ID for Customer-Specific Info.
The session ID.
The title of the product.
The ID of the user who issued the request.
OK
Bad Request
Unauthorized
Forbidden
Server Error
POST /fact-finder//rest/v5/track/{channel}/landingPageClick HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 132
[
{
"campaign": "text",
"id": "text",
"masterId": "text",
"pageId": "text",
"purchaserId": "text",
"sid": "text",
"title": "text",
"userId": "text"
}
]No content
Required Roles: ApiPublicQueries
The channel
Additional information that should be logged.
Set to true, if the search result was sorted using a custom sorting order, otherwise false.
The total number of products in the search result.
The ID of the product.
Contains the master ID, if the article is a variant and 'ID' refers to the variant.
The score of the first product in the result.
The score of the last product in the result.
The page number delivered by the search result.
The maximum number of products on a page.
The ID for Customer-Specific Info.
The search term that produced the search result.
Contains the name of the search field, if the search was performed on a specific field.
The time required to produce the results (in ms).
The session ID.
The title of the product.
The ID of the user who issued the request.
OK
Bad Request
Unauthorized
Forbidden
Server Error
POST /fact-finder//rest/v5/track/{channel}/log HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 392
[
{
"additionalInfo": "text",
"customSorting": true,
"filters": [
{
"filterWarning": "NON_EXISTING_FIELD",
"name": "text",
"substring": true,
"values": [
{
"exclude": true,
"type": "or",
"value": "text"
}
]
}
],
"hitCount": 1,
"id": "text",
"masterId": "text",
"maxScore": 1,
"minScore": 1,
"page": 1,
"pageSize": 1,
"purchaserId": "text",
"query": "text",
"searchField": "text",
"searchTime": 1,
"sid": "text",
"title": "text",
"userId": "text"
}
]No content
Required Roles: ApiPublicQueries
The channel
The ID for Customer-Specific Info.
Session ID.
The ID of the user currently logged in.
OK
Bad Request
Unauthorized
Forbidden
Server Error
POST /fact-finder//rest/v5/track/{channel}/login HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 53
[
{
"purchaserId": "text",
"sid": "text",
"userId": "text"
}
]No content
Required Roles: ApiPublicQueries
The channel
The ID of the product.
Contains the master ID, if the article is a variant and 'ID' refers to the variant.
The ID for Customer-Specific Info.
The session ID.
The title of the product.
The user ID of the user clicking the suggested product.
OK
Bad Request
Unauthorized
Forbidden
Server Error
POST /fact-finder//rest/v5/track/{channel}/predbasketClick HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 98
[
{
"id": "text",
"masterId": "text",
"purchaserId": "text",
"sid": "text",
"title": "text",
"userId": "text"
}
]No content
Required Roles: ApiPublicQueries
The channel
The ID of the product.
The product ID for which the clicked product was recommended.
Contains the master ID, if the article is a variant and 'ID' refers to the variant.
The ID for Customer-Specific Info.
The session ID.
The title of the product.
The ID of the user who issued the request.
OK
Bad Request
Unauthorized
Forbidden
Server Error
POST /fact-finder//rest/v5/track/{channel}/recommendationClick HTTP/1.1
Host: ng-demo.fact-finder.de
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 114
[
{
"id": "text",
"mainId": "text",
"masterId": "text",
"purchaserId": "text",
"sid": "text",
"title": "text",
"userId": "text"
}
]No content
Was this helpful?