List top customers - Streamlined

GET

/

reports

/

top_customers

List top customers

curl --request GET \
  --url https://api.staging.streamlinedpayments.com/api/v1/reports/top_customers \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>'

const options = {method: 'GET', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.staging.streamlinedpayments.com/api/v1/reports/top_customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/reports/top_customers"

headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/reports/top_customers")

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

request = Net::HTTP::Get.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'

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

{
  "currency": "USD",
  "basis": "sales",
  "customer_count": 86,
  "total": 511000000,
  "data": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Harbor Foods",
      "amount": 107000000,
      "share": 0.21
    }
  ],
  "meta": {
    "current_page": 123,
    "per_page": 123,
    "total_pages": 123,
    "total_count": 123
  }
}

Authorizations

X-App-Id

string

header

required

App ID for authentication

X-Api-Key

string

header

required

API Key for authentication

Query Parameters

basis

enum<string>

default:sales

sales ranks by invoices issued in the range. cash ranks by payments received in it.

Available options:

sales,

cash

start_date

string<date>

First day of the range, as YYYY-MM-DD. The range can be at most 24 months.

end_date

string<date>

Last day of the range, as YYYY-MM-DD.

page

integer

default:1

Page number, from 1 to 10000.

Required range: 1 <= x <= 10000

per_page

integer

default:20

Number of rows per page, from 1. Values above 100 are treated as 100.

Required range: x >= 1

Response

Successful operation

currency

enum<string>

ISO currency code. Most resources support these. Products are limited to USD, CAD, EUR, GBP, AUD.

Available options:

USD,

CAD,

GBP,

EUR,

AUD,

JPY,

INR

basis

enum<string>

What the list ranks by, as sent.

Available options:

sales,

cash

customer_count

integer

Number of customers with an amount in the range, across every page.

Example:

86

total

integer

Every customer's amount in the range, in cents. Matches Get monthly sales and payments for the same months.

Example:

511000000

data

object[]

Show child attributes

meta

object

Show child attributes

List top customers

curl --request GET \
  --url https://api.staging.streamlinedpayments.com/api/v1/reports/top_customers \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>'

const options = {method: 'GET', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.staging.streamlinedpayments.com/api/v1/reports/top_customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/reports/top_customers"

headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/reports/top_customers")

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

request = Net::HTTP::Get.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'

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

{
  "currency": "USD",
  "basis": "sales",
  "customer_count": 86,
  "total": 511000000,
  "data": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Harbor Foods",
      "amount": 107000000,
      "share": 0.21
    }
  ],
  "meta": {
    "current_page": 123,
    "per_page": 123,
    "total_pages": 123,
    "total_count": 123
  }
}