List all customers

GET  https://:account.api-us1.com/api/3/ecomCustomers

• cURL

curl --request GET \
  --url https:///:account.api-us1.com/api/3/ecomCustomers

• Node

var request = require("request");

var options = { method: 'GET',
  url: 'https:///:account.api-us1.com/api/3/ecomCustomers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

• Ruby

require 'uri'
require 'net/http'

url = URI("https:///:account.api-us1.com/api/3/ecomCustomers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

• JavaScript

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https:///:account.api-us1.com/api/3/ecomCustomers");

xhr.send(data);

• Python

import requests

url = "https:///:account.api-us1.com/api/3/ecomCustomers"

response = requests.request("GET", url)

print(response.text)

 

200 OK

{
  "ecomCustomers": [
    {
      "connectionid": "1",
      "externalid": "56789",
      "email": "[e-mail]",
      "totalRevenue": "3280",
      "totalOrders": "2",
      "totalProducts": "2",
      "avgRevenuePerOrder": "2285",
      "avgProductCategory": "Electronics",
      "tstamp": "2017-02-06T14:05:31-06:00",
      "links": {
        "connection": "/api/3/ecomCustomers/1/connection",
        "orders": "/api/3/ecomCustomers/1/orders"
      },
      "id": "1",
      "connection": "1"
    },
    {
      "connectionid": "2",
      "externalid": "44322",
      "email": "[e-mail]",
      "totalRevenue": "7599",
      "totalOrders": "1",
      "totalProducts": "1",
      "avgRevenuePerOrder": "7599",
      "avgProductCategory": "Books",
      "tstamp": "2016-12-13T18:02:07-06:00",
      "links": {
        "connection": "/api/3/ecomCustomers/3/connection",
        "orders": "/api/3/ecomCustomers/3/orders"
      },
      "id": "3",
      "connection": "2"
    },
    {
      "connectionid": "0",
      "externalid": "0",
      "email": "[e-mail]",
      "totalRevenue": "10879",
      "totalOrders": "3",
      "totalProducts": "3",
      "avgRevenuePerOrder": "3626",
      "avgProductCategory": "Electronics",
      "tstamp": "2017-02-06T14:05:31-06:00",
      "links": {
        "connection": "/api/3/ecomCustomers/2/connection",
        "orders": "/api/3/ecomCustomers/2/orders"
      },
      "id": "2",
      "connection": null
    }
  ],
  "meta": {
    "total": "3"
  }
}

QUERY PARAMS

filters[email]

string                                  Filter by the email address of a customer.

 

filters[externalid]

string                                  Filter by the id of the customer in the external service.

 

filters[connectionid]

string                                  Filter by the id of the connection object for the service where the customer originates.