SatisMeter provides REST API to retrieve the following response statistics in JSON format

  • Number of Displays, Responses
  • Number of Promoters, Passives and Detractors
  • NPS over the time period
  • Frequency of ratings

To retrieve the data you need to do following:

  • Open API keys in SatisMeter (Settings / Integrations / API keys) and note Project ID and Read Key
  • Run the following command, replace XXXXX  for Project ID and YYYYY  for Read Key
curl "https://app.satismeter.com/api/v2/response-statistics?startDate=2015-01-01T00:00:00.000Z&project=XXXXX" -H AuthKey:YYYYY

The output looks like this:

{
  "data": [{
    "id": "0001",
    "type": "response-statistics",
    "attributes": {
      "responses": 29,
      "displays": 35,
      "dismissed": 6,
      "promoters": 17,
      "passives": 8,
      "detractors": 4,
      "nps": 44.8,
      "frequency": [1, 0, 0, 0, 0, 2, 1, 4, 4, 6, 11]
    },
    "relationships": {
      "project": {
        "data": {
          "id": "ABCD",
          "type": "project"
        }
      }
    }
  }]
}

Optional parameters

Filter

You can filter response statistics by user traits. The format is following:

filters[user.traits.string.<trait name>][operator]=eq
Supported operators:

  • eq  - is equal
  • ne  - is not equal
  • contains  - contains value
  • ncontains  - not contains value

filters[user.traits.string.<trait name>][value]=<value> 

For example: 

curl "https://app.satismeter.com/api/v2/response-statistics?startDate=2015-01-01T00:00:00.000Z&project=XXXXX&filters[user.traits.string.email][operator]=contains&filters[user.traits.string.email][value]=john" -H AuthKey:YYYYY
Did this answer your question?