Change Log

Get Sent Statistics

Get statistics of your sent surveys

API Endpoint

Make a GET request to https://DEMO.asknice.ly/api/v1/sentstats/days/field (optional)/value (optional)
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.

Arguments

Argument Example Required Description
days 30 Optional Number of days since today for emails sent, default is 30
field rating Optional The name of a custom property field you want to filter on.
value 10 Optional The value of your custom property you want to filter on.

Example GET requests

Example to get your statistics of your sent surveys in the last 30 days 
curl --header "X-apikey: " \
https://DEMO.asknice.ly/api/v1/sentstats/30
Example filtered by one property 
curl --header "X-apikey: " \
https://DEMO.asknice.ly/api/v1/sentstats/30/custom_field_c/Custom%20Value
Example filtered by multiple properties 
curl --header "X-apikey: " \
"https://DEMO.asknice.ly/api/v1/sentstats/30?filters[]=custom_field_c&filters[]=another_custom_field_c&values[]=Custom%20Value&values[]=Another%20Custom%20Value"
Example filtered by question type. Possible values: NPS, CSAT, FIVESTAR 
curl --header "X-apikey: " \
"https://DEMO.asknice.ly/api/v1/sentstats/30/question_type/csat"

Response

The response is always in JSON format 
{
  "sent": 6,
  "delivered": 6,
  "opened": 3,
  "responded": 2,
  "promoters": 0,
  "passives": 0,
  "detractors": 2,
  "responserate": "33.3%"
}