Customer.guru offers a simple HTTP API.

Versions


If you need any other API functionality, please let us know at hello@customer.guru and we do our best to implement it within a few days.

API tokens

You can manage your api_token and api_secret in API keys.

Any troubles integrating with the API?

Get in touch with us know at hello@customer.guru and we'll respond promptly.

Sending or scheduling a survey

Request:
POST https://customer.guru/api/v2/survey

{
  "api_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "api_secret": "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy",
  "test": true,
  "scheduled_for": "now",
  "customers": [
    {
      "email": "juraj@customer.guru",
      "language": "de",
      "properties": {
        "order_count": "1",
        "zip": "12345",
        "product category": "hoodies"
      }
    },
    {
      "email": "niceapi@customer.guru",
      "properties": {
        "order_count": "2",
        "zip": "23123",
        "product category": "t-shirts"
      }
    }
  ]
}

JSON Response:
{
  "status":"OK",
  "successfully_sent":0,
  "failed_to_send":1,
  "test":true
}

Please remove the test field if you want to actually send out email surveys.

All main object attributes (except test) are required.

scheduled_for
Accepted values:
  • now
  • timestamp in the future formatted in iso8601, e.g. 2016-09-10T18:28:44Z


each customer needs to contain
  • email
  • language (optional) defines the customer survey language that has a precedence over the main language setting
  • properties (optional) is an arbitrary JSON with additional customer information that can be later used for segmenting your data. We suggest sending as much relevant information as possible, including order count, total order value, formatted shipping address, etc.

Retrieving customers

This feature is available at selected plans only. Please check the feature matrix to see if it is available for your account.
Request:
GET https://customer.guru/export/customers?api_secret=yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy&api_token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx



CSV Response:
id,email,created_at,unsubscribed_at,property_1,property_2
4766,juraj@customer.guru,2016-10-10 23:08:13 UTC,,property 1 value,property 2 value

Retrieving ratings

This feature is available at selected plans only. Please check the feature matrix to see if it is available for your account.
Request:
GET https://customer.guru/export/ratings?api_secret=yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy&api_token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

CSV Response:
id,email,updated_at,score,message,ip_address,city,state,country,email_sent_at,email_opened_at,email_clicked_at
45,juraj@customer.guru,2016-10-10 23:09:19 UTC,10,"Big help for my business!",8.8.8.8,"San Francisco",California,United States,2016-10-10 23:09:12 UTC,2016-10-10 23:09:12 UTC,2016-10-10 23:09:14 UTC