Get update status

Base URL

GET https://reviewindexapi.datashake.com/update/status

Request parameters

request_id

string Request identifier.

Code example

curlpythonrubyjavascriptphp

curl 'https://reviewindexapi.datashake.com/update/status?request_id=1647250482213790589-618338ab-a66e-41&api_key=12345'

import requests

url = "https://reviewindexapi.datashake.com/update/status"
params = {
    "api_key": "12345",
    "request_id": "1647250482213790589-618338ab-a66e-41"
}
response = requests.get(
    url=url,
    params=params
}

coming soon

coming soon

coming soon

Response

API Response example

{
    "request_id": "1647250482213790589-618338ab-a66e-41",
    "created_at": "2022-03-14T09:34:49",
    "completeness_rate": 0.88,
    "success_rate": 0.97,
    "status": "PENDING",
    "size": 150
}

A completeness rate is a ratio between update-pending profiles and updated profiles. As an example, if there are 1000 review profiles in total (which is indicated by size), and by the time you hit the endpoint we managed to update 645 profiles, the completeness rate is 0.645 (64.5%)

The success rate is a ratio between successfully updated and unsuccessfully updated review profiles.

The status indicates the general state of the task. It can have the following values: STARTED, PENDING, FAILED, RETRY, or COMPLETE