Feefo Product Ratings
- 16 Aug 2024
- 2 Minutes to read
- Print
- DarkLight
- PDF
Feefo Product Ratings
- Updated on 16 Aug 2024
- 2 Minutes to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Feefo Product Ratings API
Configuration Parameters
Any instance where an entry in the below configuration has a leading $ represents a parameter that needs to be replaced with a static value.
Parameters in this document:
- $client_id and $client_secret - The Client ID and Client Secret will be used to authenticate calls to the Feefo Reviews API. For a full walkthrough on the creation of an App Key, which will utlimately result in a Client ID and Client Secret, please follow the process outlined by Feefo here.
- $merchant_identifier - The Merchant Identifier is the unique identifier for your Feefo merchant account, and can be found in the Feefo Hub.
- $version - The Version represents the current release version of the Feefo API, and can be found here as the numeric value associated with the most recent Release Date.
Outlined below are two different configurations of the same Feefo Product Ratings API that result in slightly different result sets that can be utilized depending on the use case that you have. If you are envisioning a use case that doesn't align with what is outlined below, please feel free to reach out to our Support Team and we would be happy to assist in an alternate configuration that meets your needs.
Connector configuration
Configuration 1
The below configuration results in the all-time product ratings average for each SKU, along with the number of reviews. The Primary Key is defined such that a new record will be created for a given SKU only when a new rating is submitted.
- Base url: https://api.feefo.com/api/$version/products/ratings
- Method: GET
- URL Parameters: merchant_identifier=$merchant_identifier&page_size=100&review_count=true&since_period=all
Destination Table naming convention is ultimately up to you as the data owner. One common structure used for this API is feefo_product_ratings_all_time.
Variables
- Secured Variables:
| Variable name | Variable value |
|---|---|
| client_id | $client_id |
| client_secret | $client_secret |
Pagination
- Enable:
- Get next page value: Static (integer to be incremented)
- Start page: 1
- Page step: 1
- Use next page value: As a URL parameter value
- URL/body key: page
- Stop iterating when: Empty response
Refresh access token
- Enable:
- URL: https://api.feefo.com/api/oauth/v2/token
- Method: POST
- POST data: {"client_id":"{client_id}","client_secret":"{client_secret}","grant_type":"client_credentials"}
- Headers: {"Content-Type":"application/x-www-form-urlencoded"}
- Access token response key: access_token
- Use Bearer authentication:
- Error status codes: 401; 403
Advanced Settings
- Data key: products
- Errors waiting time: 429=60
- Primary Key: {sku}-{review_count}
Connector configuration
Configuration 2
The below configuration results in the product ratings average for each SKU and each available since_period value, along with the number of reviews. With no Primary Key defined and using the Append Load Strategy, each run will simply append the result set to the existing table.
- Base url: https://api.feefo.com/api/$version/products/ratings
- Method: GET
- URL Parameters: merchant_identifier=$merchant_identifier&page_size=100&review_count=true&since_period={identifier}
Destination Table naming convention is ultimately up to you as the data owner. One common structure used for this API is feefo_product_ratings_all_periods.
Variables
- Secured Variables:
| Variable name | Variable value |
|---|---|
| client_id | $client_id |
| client_secret | $client_secret |
Pagination
- Enable:
- Get next page value: Static (integer to be incremented)
- Start page: 1
- Page step: 1
- Use next page value: As a URL parameter value
- URL/body key: page
- Stop iterating when: Empty response
Refresh access token
- Enable:
- URL: https://api.feefo.com/api/oauth/v2/token
- Method: POST
- POST data: {"client_id":"{client_id}","client_secret":"{client_secret}","grant_type":"client_credentials"}
- Headers: {"Content-Type":"application/x-www-form-urlencoded"}
- Access token response key: access_token
- Use Bearer authentication:
- Error status codes: 401; 403
Fetch list
- Enable:
- Fetch List From: Static List
- List of identifiers: 24_hours, week, month, year, or all
- Use identifiers: As single value
Advanced Settings
- Data key: products
- Errors waiting time: 429=60
- Load Strategy: Append
Was this article helpful?
.png)