Retrieve summary

Get a summary of all ratings.

GET /1.0/ratings_summary.json

Query parameters

They should be passed as query parameters to the URL. (ex.: ?id=1&code=abc)

id int (required)

The unique webshop ID.

code string (required)

Your personal API code.

public_code string (required)

* Use instead of code in case you want to fetch data with JavaScript

Example response

{
    "status": "success",
    "message": "Rating summary successfully retrieved!",
    "data": {
        "amount": 26,
        "rating_average": 4.194546, // Ratings scale 1-5
        "ratings_average": {
            "shippingtime": 4.851756,
            "customerservice": 4.658711,
            "pricequality": 3.678985,
            "aftersale": 4.087224
        }
    }
}

Response statuses

status	message	Explanation
success	Ratings summary successfully retrieved!
error	Not all obligated variables are set.	One or more of the required variables (id, code) has/have not been set.
error	Incorrect authentication credentials.	The combination id and code is invalid.
error	Unexpected error while processing. Please contact Trustprofile.	An unexpected error has occurred. This will probably only be solvable by the Trustprofile team.

Example code

<?php

$id = 1;
$code = '123456789abc123456789';

$curl = curl_init(
    sprintf(
        'https://dashboard.trustprofile.com/api/1.0/ratings_summary.json?id=%s&code=%s',
        $id,
        $code,
    ),
);

curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => true,
]);

$response = curl_exec($curl);

if ($response !== false) {
    $data = json_decode($response, true);

    /*
    $data will look similar to the format below:

    $data = [
        "status" => "success",
        "message" => "Ratings summary successfully retrieved!",
        "data" => See example
    ];
    */
} else {
    // An error occurred
}