MENU navbar-image

Introduction

This documentation aims to provide all the information you need to work with our API.

Base URL

https://reviewsatellite.local.com

Authenticating requests

This API is authenticated by sending an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Authentication Endpoints

Login endpoint

User Login

Example request:
curl --request POST \
    "https://reviewsatellite.local.com/api/v1/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"rowe.dalton@example.net\",
    \"password\": \"possimus\"
}"

const url = new URL(
    "https://reviewsatellite.local.com/api/v1/login"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "rowe.dalton@example.net",
    "password": "possimus"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://reviewsatellite.local.com/api/v1/login',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'email' => 'rowe.dalton@example.net',
            'password' => 'possimus',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://reviewsatellite.local.com/api/v1/login'
payload = {
    "email": "rowe.dalton@example.net",
    "password": "possimus"
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request      

POST api/v1/login

Body Parameters

email  string  

Must be a valid email address.

password  string  

Forgot Password

Example request:
curl --request POST \
    "https://reviewsatellite.local.com/api/v1/forgot-password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"irma39@example.org\"
}"

const url = new URL(
    "https://reviewsatellite.local.com/api/v1/forgot-password"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "irma39@example.org"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://reviewsatellite.local.com/api/v1/forgot-password',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'email' => 'irma39@example.org',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://reviewsatellite.local.com/api/v1/forgot-password'
payload = {
    "email": "irma39@example.org"
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request      

POST api/v1/forgot-password

Body Parameters

email  string  

Must be a valid email address.

Register a User

Example request:
curl --request POST \
    "https://reviewsatellite.local.com/api/v1/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_name\": \"bdvcvelaicckhfgnlrxjphouzldgwqgzlwmotmjlkrvaagyjidjifxkeydjufpjnntcrvvyznfazjklibnyj\",
    \"first_name\": \"fjedqcilseeqooywesoxdrqwsloownzutfibeomywnqyvnqqemzmtkbqqqbeokcquganwgwwurmyoznk\",
    \"last_name\": \"lykimeovnvlkzvxxjxcypevdalcwwenilnhrwqrnftjxmjgvoqgscbqegpnzzjnwsdjbelmepldsdvwb\",
    \"email\": \"korey.kertzmann@example.com\",
    \"password\": \"xgigo\"
}"

const url = new URL(
    "https://reviewsatellite.local.com/api/v1/register"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "company_name": "bdvcvelaicckhfgnlrxjphouzldgwqgzlwmotmjlkrvaagyjidjifxkeydjufpjnntcrvvyznfazjklibnyj",
    "first_name": "fjedqcilseeqooywesoxdrqwsloownzutfibeomywnqyvnqqemzmtkbqqqbeokcquganwgwwurmyoznk",
    "last_name": "lykimeovnvlkzvxxjxcypevdalcwwenilnhrwqrnftjxmjgvoqgscbqegpnzzjnwsdjbelmepldsdvwb",
    "email": "korey.kertzmann@example.com",
    "password": "xgigo"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://reviewsatellite.local.com/api/v1/register',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'company_name' => 'bdvcvelaicckhfgnlrxjphouzldgwqgzlwmotmjlkrvaagyjidjifxkeydjufpjnntcrvvyznfazjklibnyj',
            'first_name' => 'fjedqcilseeqooywesoxdrqwsloownzutfibeomywnqyvnqqemzmtkbqqqbeokcquganwgwwurmyoznk',
            'last_name' => 'lykimeovnvlkzvxxjxcypevdalcwwenilnhrwqrnftjxmjgvoqgscbqegpnzzjnwsdjbelmepldsdvwb',
            'email' => 'korey.kertzmann@example.com',
            'password' => 'xgigo',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://reviewsatellite.local.com/api/v1/register'
payload = {
    "company_name": "bdvcvelaicckhfgnlrxjphouzldgwqgzlwmotmjlkrvaagyjidjifxkeydjufpjnntcrvvyznfazjklibnyj",
    "first_name": "fjedqcilseeqooywesoxdrqwsloownzutfibeomywnqyvnqqemzmtkbqqqbeokcquganwgwwurmyoznk",
    "last_name": "lykimeovnvlkzvxxjxcypevdalcwwenilnhrwqrnftjxmjgvoqgscbqegpnzzjnwsdjbelmepldsdvwb",
    "email": "korey.kertzmann@example.com",
    "password": "xgigo"
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Request      

POST api/v1/register

Body Parameters

company_name  string  

validation.max.

first_name  string  

validation.max.

last_name  string  

validation.max.

email  string  

Must be a valid email address.

password  string  

validation.min.

Generate OAuth Url

Example request:
curl --request GET \
    --get "https://reviewsatellite.local.com/api/oauth/generate-url" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://reviewsatellite.local.com/api/oauth/generate-url"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://reviewsatellite.local.com/api/oauth/generate-url',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://reviewsatellite.local.com/api/oauth/generate-url'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 57
access-control-allow-origin: *
 

{
    "error": "request is invalid #473298"
}

Request      

GET api/oauth/generate-url

Approve OAuth Request

Example request:
curl --request POST \
    "https://reviewsatellite.local.com/api/oauth/approval" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://reviewsatellite.local.com/api/oauth/approval"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://reviewsatellite.local.com/api/oauth/approval',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://reviewsatellite.local.com/api/oauth/approval'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request      

POST api/oauth/approval

Exchange Code for Access Token

Example request:
curl --request GET \
    --get "https://reviewsatellite.local.com/api/v1/oauth/code-exchange/illo" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://reviewsatellite.local.com/api/v1/oauth/code-exchange/illo"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://reviewsatellite.local.com/api/v1/oauth/code-exchange/illo',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://reviewsatellite.local.com/api/v1/oauth/code-exchange/illo'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (400):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 56
access-control-allow-origin: *
 

{
    "error": "Trying to get property 'response' of non-object"
}

Request      

GET api/v1/oauth/code-exchange/{code}

URL Parameters

code  string  

Endpoints

List Reviews

requires authentication

This endpoint will return the list of reviews by how the user mapped it on the backend

Example request:
curl --request GET \
    --get "https://reviewsatellite.local.com/api/v1/reviews/mapped/explicabo?websiteUuid=beatae&sourceUuid=velit&reviewUuid=eius&includeSummary=&includeMappings=1&includeOriginalResponse=1&startDate=2022-06-01&endDate=2022-06-30&offset=15&limit=2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://reviewsatellite.local.com/api/v1/reviews/mapped/explicabo"
);

const params = {
    "websiteUuid": "beatae",
    "sourceUuid": "velit",
    "reviewUuid": "eius",
    "includeSummary": "0",
    "includeMappings": "1",
    "includeOriginalResponse": "1",
    "startDate": "2022-06-01",
    "endDate": "2022-06-30",
    "offset": "15",
    "limit": "2",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://reviewsatellite.local.com/api/v1/reviews/mapped/explicabo',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'websiteUuid'=> 'beatae',
            'sourceUuid'=> 'velit',
            'reviewUuid'=> 'eius',
            'includeSummary'=> '0',
            'includeMappings'=> '1',
            'includeOriginalResponse'=> '1',
            'startDate'=> '2022-06-01',
            'endDate'=> '2022-06-30',
            'offset'=> '15',
            'limit'=> '2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://reviewsatellite.local.com/api/v1/reviews/mapped/explicabo'
params = {
  'websiteUuid': 'beatae',
  'sourceUuid': 'velit',
  'reviewUuid': 'eius',
  'includeSummary': '0',
  'includeMappings': '1',
  'includeOriginalResponse': '1',
  'startDate': '2022-06-01',
  'endDate': '2022-06-30',
  'offset': '15',
  'limit': '2',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (400):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": "Unauthenticated."
}

Request      

GET api/v1/reviews/mapped/{companyUuid}

URL Parameters

companyUuid  string  

The UUID of the company

Query Parameters

websiteUuid  string optional  

Filter by website by providing the UUID of the website

sourceUuid  string optional  

Filter by source by providing the UUID of the source

reviewUuid  string optional  

Filter by review by providing the UUID of the review

includeSummary  boolean optional  

Option to include additional summary data Default: false

includeMappings  boolean optional  

Option to include additional summary data Default: true

includeOriginalResponse  boolean optional  

Option to include additional summary data Default: false

startDate  string optional  

date Filter by start date (Format: YYYY-MM-DD)

endDate  string optional  

date Filter by end date (Format: YYYY-MM-DD)

offset  integer optional  

Specify from which row we want the data to retrieve. (default 0)

limit  integer optional  

Specify the number of records to return. (default 100)

List Websites

requires authentication

This endpoint will return a list of websites under the account.

Example request:
curl --request GET \
    --get "https://reviewsatellite.local.com/api/v1/websites" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://reviewsatellite.local.com/api/v1/websites"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://reviewsatellite.local.com/api/v1/websites',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://reviewsatellite.local.com/api/v1/websites'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (400):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": "Unauthenticated."
}

Request      

GET api/v1/websites

Query Parameters

websiteUuid  string optional  

An optional parameter to filter by website. Provide UUID of the website to filter.

List Sources

requires authentication

This endpoint will return a list of sources under the account

Example request:
curl --request GET \
    --get "https://reviewsatellite.local.com/api/v1/sources" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://reviewsatellite.local.com/api/v1/sources"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://reviewsatellite.local.com/api/v1/sources',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://reviewsatellite.local.com/api/v1/sources'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (400):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": "Unauthenticated."
}

Request      

GET api/v1/sources

URL Parameters

websiteUuid  string optional  

optional The UUID of the website

List System Reviews

requires authentication

This endpoint will return a list of reviews under the account.

Example request:
curl --request GET \
    --get "https://reviewsatellite.local.com/api/v1/reviews?rating=5&dateBefore=2023-06-01&dateAfter=2023-01-01&year=2023&limit=100&page=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://reviewsatellite.local.com/api/v1/reviews"
);

const params = {
    "rating": "5",
    "dateBefore": "2023-06-01",
    "dateAfter": "2023-01-01",
    "year": "2023",
    "limit": "100",
    "page": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://reviewsatellite.local.com/api/v1/reviews',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'rating'=> '5',
            'dateBefore'=> '2023-06-01',
            'dateAfter'=> '2023-01-01',
            'year'=> '2023',
            'limit'=> '100',
            'page'=> '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://reviewsatellite.local.com/api/v1/reviews'
params = {
  'rating': '5',
  'dateBefore': '2023-06-01',
  'dateAfter': '2023-01-01',
  'year': '2023',
  'limit': '100',
  'page': '1',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (400):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": "Unauthenticated."
}

Request      

GET api/v1/reviews

Query Parameters

sourceUuid  string optional  

An optional parameter to filter reviews by source. Provide UUID of the source to filter.

rating  integer optional  

An optional parameter to filter reviews by rating. Value can be 1 to 5.

dateBefore  string optional  

date An optional parameter to filter reviews by rating.

dateAfter  string optional  

date An optional parameter to filter reviews by rating.

year  integer optional  

An optional parameter to filter reviews by year it was posted.

limit  integer optional  

The number of records to show (Default: 100).

page  integer optional  

The page number of records to show (Default: 1).

Get Review

requires authentication

This endpoint will return the information of a review

Example request:
curl --request GET \
    --get "https://reviewsatellite.local.com/api/v1/reviews/20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://reviewsatellite.local.com/api/v1/reviews/20"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://reviewsatellite.local.com/api/v1/reviews/20',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://reviewsatellite.local.com/api/v1/reviews/20'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (400):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": "Unauthenticated."
}

Request      

GET api/v1/reviews/{id}

URL Parameters

id  integer  

The id of the review to view

Get Unread Reviews by a User

requires authentication

This endpoint will return the unread reviews by the user

Example request:
curl --request GET \
    --get "https://reviewsatellite.local.com/api/v1/reviews/unread/user" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://reviewsatellite.local.com/api/v1/reviews/unread/user"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://reviewsatellite.local.com/api/v1/reviews/unread/user',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://reviewsatellite.local.com/api/v1/reviews/unread/user'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (400):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": "Unauthenticated."
}

Request      

GET api/v1/reviews/unread/user

Mark Unread Reviews as Read

requires authentication

This endpoint will mark an unread review as read

Example request:
curl --request POST \
    "https://reviewsatellite.local.com/api/v1/reviews/read/user/11" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://reviewsatellite.local.com/api/v1/reviews/read/user/11"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://reviewsatellite.local.com/api/v1/reviews/read/user/11',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://reviewsatellite.local.com/api/v1/reviews/read/user/11'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers)
response.json()

Request      

POST api/v1/reviews/read/user/{reviewId}

URL Parameters

reviewId  integer optional  

The id of the review to be marked as read. (You can leave as blank to mark all unread reviews as read)

Get Current User Details

requires authentication

This endpoint will return the details of the current active user.

Example request:
curl --request GET \
    --get "https://reviewsatellite.local.com/api/v1/user" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://reviewsatellite.local.com/api/v1/user"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://reviewsatellite.local.com/api/v1/user',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://reviewsatellite.local.com/api/v1/user'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (400):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": "Unauthenticated."
}

Request      

GET api/v1/user

Get Rating Overview

requires authentication

This endpoint will return the count and the rating data of the reviews on the account.

Example request:
curl --request GET \
    --get "https://reviewsatellite.local.com/api/v1/rating-overview" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://reviewsatellite.local.com/api/v1/rating-overview"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://reviewsatellite.local.com/api/v1/rating-overview',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://reviewsatellite.local.com/api/v1/rating-overview'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (400):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": "Unauthenticated."
}

Request      

GET api/v1/rating-overview

Get Company Details

requires authentication

This endpoint will return the details of the company.

Example request:
curl --request GET \
    --get "https://reviewsatellite.local.com/api/v1/company" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://reviewsatellite.local.com/api/v1/company"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://reviewsatellite.local.com/api/v1/company',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://reviewsatellite.local.com/api/v1/company'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (400):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": "Unauthenticated."
}

Request      

GET api/v1/company

List Platform

This endpoint will return a list of platforms available on the account.

Example request:
curl --request GET \
    --get "https://reviewsatellite.local.com/api/v1/platforms" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://reviewsatellite.local.com/api/v1/platforms"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://reviewsatellite.local.com/api/v1/platforms',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json

url = 'https://reviewsatellite.local.com/api/v1/platforms'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (400):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": "Unauthenticated."
}

Request      

GET api/v1/platforms