- Quick Start
- Send Survey
- Get Contact
- Remove Contact
- Delete Contact (GDPR)
- Get Unsubscribed
- Get Responses
- Get NPS
- Sent Statistics
- Historical Stats
- Deactivate All
- Bulk Add with CSV
- Inapp Surveys
- Bulk Add/Send
Change Log
Get FIVE STAR Results
Get your current FIVE STAR score
Need more detailed feeds? See "Dashboard Data" in Settings.
API Endpoint
Make a GET request to
days
Add filters[]=custom_field_c
and values[]=Custom%20Value
to your request parameter to filter on multiple fields.
See the example how to filter by multiple properties below. The number of filters and values must be the same, and they need to match in order and make sure the first filter matches the first value, and so on. Incorrect matches will result in no data being returned.
Arguments
Argument | Example | Required | Description |
---|---|---|---|
days |
30 |
Optional | Number of days since today to calculate FIVE STAR score on, default is 30 |
Example GET request
Your FIVESTAR for the last 30 days in JSON formatcurl --header "X-apikey: " \ https://DEMO.asknice.ly/api/v1/getfivestar/30
Response
{"FIVESTAR":"4.40"}
Example GET request with Filters
Your FIVESTAR for the last 30 days with Country and City filters in JSON formatcurl --header "X-apikey: " \ "https://DEMO.asknice.ly/api/v1/getfivestar/30?filters[]=country_c&filters[]=city_c&values[]=Canada&values[]=Abbotsford"
Response
{"FIVESTAR":"4.20"}