GET account/get_health_score

Summary

This API request returns the Customer Health Score of an account along with the date it was last updated on.

Resource URL
https://api.useriq.com/api/1.0/account/get_health_score?account_id=abc123

Resource Information
Request Type: GET
Response Format: JSON

Headers

useriq-api-key (required): Your valid API key generated from the Site settings page

Parameters

account_id - The account ID for the account you want to get the health score of.

Example cURL Request:

HTTP

curl \
 -H "Content-type: application/json" \
 -H "useriq-api-key: 572d7372829a3211a73d9c2cb790ffe3" \
 https://api.useriq.com/api/1.0/account/get_health_score?account_id=abc123

Example Result

{
 "date_calculated":"2018-10-22",
 "health_score":82
}

Response Codes
200: OK. Request processed successfully
400: Bad Request. API request could not be understood by the server.
401: Unauthorized. Invalid API access token.

Articles in this section

Comments