Get health score API
GET /v2/accounts/{account_id}/healthscore
Description:
This API request returns the Health Scores of an account over a period of time (up to a year).
API Limit:
600 requests per minute. Client receives 429 once over the limit.
Method Details:
Http method: GET
Response format: Json
Headers:
useriq-api-key: Your valid API key generated from the site settings page
Content-Type: application/json
Parameters:
Path Parameter:
-
{account_id}: required, the account ID for the account you want the health score.
Query Parameters:
-
detailed: optional, true or false, the default is false. When supplied in query string ?detailed=true, the response contains more details for the calculated health scores.
Response:
Status code 200:
The body contains the result, which is a list of health health scores for the requested account_id, ordered by effective_at asc .
Other Status code:
400: Bad request
401: unauthorized.
429: Too many requests.
Example GET Request:
1. Example Request:
https://api.useriq.com/v2/accounts/1234/healthscore
Example Response
{
"success": true,
"result": [
{
"site_id": 1234567,
"account_id": "1234",
"effective_at": "2020-07-01 12:00:00.0",
"updated_at": "2020-10-07 12:01:43.0",
"health_score": 75,
},
{
"site_id": 1234567,
"account_id": "1234",
"effective_at": "2020-07-02 12:00:00.0",
"updated_at": "2020-10-07 12:02:50.0",
"health_score": 65,
}
...
]
}
2. Example Request with optional query param details=true:
https://api.useriq.com/v2/accounts/1234/healthscore?detailed=true
Example Response:
{
"success": true,
"result": [
{
"site_id": 1234567,
"account_id": "1234",
"effective_at": "2020-07-01 12:00:00.0",
"updated_at": "2020-10-07 12:01:43.0",
"health_score": 75,
"sentiment_nps": 40,
"sentiment_rating": 60,
"sentiment_feedback": 70,
"adoption_active_last": 80,
"adoption_active_days": 70,
"adoption_active_users": 30,
"open_tickets": 0,
"renewal": 100
},
{
"site_id": 1234567,
"account_id": "1234",
"effective_at": "2020-07-02 12:00:00.0",
"updated_at": "2020-10-07 12:02:50.0",
"health_score": 65,
"sentiment_nps": 40,
"sentiment_rating": 66,
"sentiment_feedback": 60,
"adoption_active_last": 40,
"adoption_active_days": 60,
"adoption_active_users": 30,
"open_tickets": 0,
"renewal": 100
}
...
]
}
Comments
0 comments
Please sign in to leave a comment.