Placement Report API
Important: Only call parameters that you need. Personalization Cloud operates off a set of APIs that support many applications and clients concurrently. Personalization Cloud may update and enhance these APIs at any time.
https://gateway.richrelevance.com/mvt-api/placements/v1'/
Note:
1) The URL requires the environment (gateway, staging-gateway or qa-gateway), version and parameter(s) to function properly. See below for more information on example URL requests.
2) This API only provides the last 7 days of data and is meant for retrieving the data on a regular basis.
OAuth Signature
POST {baseUrl}/oauth2/token
Request an authorization bearer token by authenticating using your client credentials. The /oauth2/token endpoint must be called first to get a token that will give access to the other endpoints. Use the client id and secret sent to you by Algonomy. The response from this API will contain your token, which will be valid until it is manually revoked. The response will be provided as JSON.
On all requests to the product and catalog APIs, pass an "Authorization: bearer MY_TOKEN" header. When the token expires you will need to get a new one using your client id and secret again.
| Name | Required or Optional | Description |
|---|---|---|
| grant_type | Required (string) | The access token type. This is always client_credentials |
| client_id | Required (string) | The client's ID |
| client_secret | Required (string) |
A unique key to authorize a client app on behalf of the partner. Example: clientSecret=wbhz6c41 |
Example
Good Response:
{
"token_type": "bearer",
"access_token": "AABBCCDD"
}
Error Response:
{
"error_description": "Invalid client authentication",
"error": "invalid_client"
}
or
{
"error_description": "Invalid grant_type",
"error": "unsupported_grant_type"
}
Placement Report
Example:
curl -H 'Authorization: bearer tokenGeneratedFromTheAboveStep'
"Accept: application/json" -H "Content-Type: application/json"
-X GET 'https://gateway.richrelevance.com/mvt-api/placementAnalytics/placements/v1/'
Example Response
{"date":"2018-09-23",
"siteId":XXXX,
"channelId":"all",
"currency":"EUR",
"region_id":"8851",
"pageTypeName":"wish_list_page",
"placementName":"recs_1",
"views":3
"clicks":0,
"items":0,
"orders":0
"clkTruRate":0.0,
"attrSales":0.0}
Response Parameters
| Name | Example | Description | |
|---|---|---|---|
date |
2018-09-23 |
The date.of the request |
|
siteID |
1234 |
The ID assigned to the site |
|
channelID |
all, mobile |
The id of the specified channel |
|
| currency | EUR | The currency format for the results | |
| regionID | 9999 | The ID for the specified region |
|
|
pageTypeName |
item-page |
The name for the type of page on which the placement resides |
|
| placementName | itemrecs_1 | The name of the placement for which the data is being requested | |
| views | # | Count of views | |
| clicks | # | Count of clicks | |
| items | # | Count of items in orders from recs | |
| orders | # | Count of orders from recs | |
| clkTruRate | # | Click Through Rate | |
| attrSales | # | Attributable sales (sum of sales from recs) |