Access Putler’s Analytics Stats in your own apps

Use Putler’s Outbound API to access Putler’s KPIs, lists and charts in your own apps.

  • Use Collection endpoints to pull all stats in a single call. Use Individual endpoint to pull only those stats that you need.
  • All calls will return data for current month, for account selected under Sharing tab, in currency selected under Sharing tab!
  • All API calls require your Putler email address and Sharing Token. You will receive an “Authentication failed” error if they are not passed / are invalid.
  • You can get your sharing token by checking “Enable Sharing” under Settings -> Sharing tab.

API Endpoints for Collections

Get all stats or only KPIs as you need. In one single call!

KPIs /kpi

Get KPIs

URL
https://api.putler.com/outbound/dashboard/kpi
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
kpi All the KPIs
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi?email=your-email&token=your-token
Example Response
{"forecasted-sales": {"value": "$1,662.68","label": "Forecasted Sales"}, "month-to-date-sales": {"value": "$934.70","change": "-9316.52","label": "Month to Date Sales"}, "subscriptions-active": {"value": 2,"label": "Active Subscriptions"}, "subscriptions-new": {"value": 0,"label": "New Subscriptions"}, "fastest-moving-product": {"value": "Wrist Watch","label": "Fastest Moving Product"}, "returning-customers": {"value": "8 • 57.14%","label": "Returning Customers"}, "sales-frequency": {"value": "1d 2h","label": "Frequency: one sale every"}, "todays-sales": {"value": "$0.00","change": "0.00","label": "Today's Sales"}, "avg-revenue-per-sale": {"value": "$62.31","label": "Average Revenue / Sale"}, "avg-qty-sold-per-day": {"value": "1.17","label": "Average Qty Sold / Day"}, "qty-sold": {"value": 21,"label": "Qty Sold"}, "avg-revenue-per-day": {"value": "$53.63","label": "Average Revenue / Day"}, "monthly-target": {"value": "133.53%","target": "$700.0","label": "Target"}, "customers-acquired-per-day": {"value": "0.78","label": "Customers Acquired / Day"}, "avg-value-per-customer": {"value": "$66.76","label": "Average Value / Customer"}, "avg-orders-per-customer": {"value": "5.50","label": "Average Orders / Customer"}, "account-balance": {"value": "$40,237.41","change": "0.00","label": "Account Balance"}, "customers": {"value": 14,"label": "Customers"}, "refunded-customers": {"value": "5 • 35.71%","label": "Refunded Customers"}, "sales-before-refunds-count": {"label": "Sales Before Refunds Count","value": "16"}, "refunds-count": {"label": "Refunds Count","value": "34"}, "avg-sales-per-day": {"value": "$53.63","change": "-515.88","label": "Average Sales/Day"}, "sales-from-top-products": {"value": "$635.00 • 76.35%","label": "Sales From Top 20% Products"}, "refunds-amount": {"label": "Refunds Amount","value": "$62.30"}, "slowest-moving-product": {"value": "Flex Tutorials","label": "Slowest Moving Product"}, "sales-before-refunds-amount": {"label": "Sales Before Refunds Amount","value": "$997.00"}, "subscriptions-suspended": {"value": 0,"label": "Suspended Subscriptions"}, "subscriptions-failed": {"value": 0,"label": "Failed Subscriptions"}, "subscriptions-canceled": {"value": 0,"label": "Canceled Subscriptions"}}

Lists /lists

Get lists

URL
https://api.putler.com/outbound/dashboard/lists
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
lists Sales, products and customers lists
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/lists?email=your-email&token=your-token
Example Response
{"products": { "headers": ["Item","Sales","Refunds","Total","Currency"], "data": [ ["Web Entrepreneurs' Club - Annual",2,0,298,"USD"], ["Web Entrepreneurs' Club Premium - Annual",1,0,199,"USD"], ["Putler's Guide to Sales Analysis - eBook",2,0,138,"USD"], ["Web Millionaire - Audio Book",2,0,98,"USD"] ] }, "customers": { "headers": ["Customer","Last On","Transactions","Total","Currency"], "data": [ ["Onyebuchi Onochie","2013-10-01 05:59:37",1,274,"USD"], ["Anton Millar","2013-10-03 22:23:06",3,199,"USD"], ["Meaza Dahlak","2013-10-04 13:00:06",1,149,"USD"], ["Tena Antolović","2013-10-03 16:57:15",1,90,"USD"] ] }, "sales": { "headers": ["Date","Customer","Status","Amount","Currency"], "data": [ ["2013-10-04 13:00:06","Meaza Dahlak","Completed",149,"USD"], ["2013-10-04 05:56:12","Din Pajović","Completed",29,"EUR"], ["2013-10-03 22:23:06","Anton Millar","Refunded",0,"AUD"], ["2013-10-03 16:57:15","Tena Antolović","Completed",90,"GBP"] ] }}

Charts /charts

Get charts

URL
https://api.putler.com/outbound/dashboard/charts
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
charts Sales, products and customers charts
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/charts?email=your-email&token=your-token
Example Response
{"products": { "xaxis": [1,2,3,4,5,6,7,8,9,10], "data": [[0,0,199,0,0,0,0,0,0,0],[138,0,0,0,0,0,0,0,0,0],[98,0,0,0,0,0,0,0,0,0],[7,0,120.2,29,0,0,0,0,8.19,67.19]], "labels": ["Web Entrepreneurs' Club Premium - Annual","Putler's Guide to Sales Analysis - eBook","Web Millionaire - Audio Book","Others"] }, "customers": { "xaxis": 1,2,3,4,5,6,7,8,9,10], "data": [[2,0,3,2,0,0,0,0,1,0],[1,0,1,0,0,0,0,0,2,2]], "labels": ["New","Returning"] }, "sales": { "xaxis": [1,2,3,4,5,6,7,8,9,10], "data": [[392,0,319.2,178,0,0,0,0,38.19,5.81]], "labels": ["Sales"] }}

All Stats that Putler offers /

Get all stats – KPIs, charts, lists, highlights, meta

URL
https://api.putler.com/outbound/dashboard
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
data kpi, lists, charts, meta, highlights
Example API call using cURL
curl https://api.putler.com/outbound/dashboard?email=your-email&token=your-token
Example Response
{"kpi": {{"forecasted-sales": {"value": "$1,662.68","label": "Forecasted Sales"}, "month-to-date-sales": {"value": "$934.70","change": "-9316.52","label": "Month to Date Sales"}, "subscriptions-active": {"value": 2,"label": "Active Subscriptions"}, "subscriptions-new": {"value": 0,"label": "New Subscriptions"}, "fastest-moving-product": {"value": "Wrist Watch","label": "Fastest Moving Product"}, "returning-customers": {"value": "8 • 57.14%","label": "Returning Customers"}, "sales-frequency": {"value": "1d 2h","label": "Frequency: one sale every"}, "todays-sales": {"value": "$0.00","change": "0.00","label": "Today's Sales"}, "avg-revenue-per-sale": {"value": "$62.31","label": "Average Revenue / Sale"}, "avg-qty-sold-per-day": {"value": "1.17","label": "Average Qty Sold / Day"}, "qty-sold": {"value": 21,"label": "Qty Sold"}, "avg-revenue-per-day": {"value": "$53.63","label": "Average Revenue / Day"}, "monthly-target": {"value": "133.53%","target": "$700.0","label": "Target"}, "customers-acquired-per-day": {"value": "0.78","label": "Customers Acquired / Day"}, "avg-value-per-customer": {"value": "$66.76","label": "Average Value / Customer"}, "avg-orders-per-customer": {"value": "5.50","label": "Average Orders / Customer"}, "account-balance": {"value": "$40,237.41","change": "0.00","label": "Account Balance"}, "customers": {"value": 14,"label": "Customers"}, "refunded-customers": {"value": "5 • 35.71%","label": "Refunded Customers"}, "sales-before-refunds-count": {"label": "Sales Before Refunds Count","value": "16"}, "refunds-count": {"label": "Refunds Count","value": "34"}, "avg-sales-per-day": {"value": "$53.63","change": "-515.88","label": "Average Sales/Day"}, "sales-from-top-products": {"value": "$635.00 • 76.35%","label": "Sales From Top 20% Products"}, "refunds-amount": {"label": "Refunds Amount","value": "$62.30"}, "slowest-moving-product": {"value": "Flex Tutorials","label": "Slowest Moving Product"}, "sales-before-refunds-amount": {"label": "Sales Before Refunds Amount","value": "$997.00"}, "subscriptions-suspended": {"value": 0,"label": "Suspended Subscriptions"}, "subscriptions-failed": {"value": 0,"label": "Failed Subscriptions"}, "subscriptions-canceled": {"value": 0,"label": "Canceled Subscriptions"} }},"meta": { "primary-currency": "USD", "to-date": "2013-10-18 10:15:40", "currency": "USD", "from-date": "2013-10-01 00:00:00" },"charts": {"products": { "xaxis": [1,2,3,4,5,6,7,8,9,10], "data": [[0,0,199,0,0,0,0,0,0,0],[138,0,0,0,0,0,0,0,0,0],[98,0,0,0,0,0,0,0,0,0],[7,0,120.2,29,0,0,0,0,8.19,67.19]], "labels": ["Web Entrepreneurs' Club Premium - Annual","Putler's Guide to Sales Analysis - eBook","Web Millionaire - Audio Book","Others"] },"customers": { "xaxis": 1,2,3,4,5,6,7,8,9,10], "data": [[2,0,3,2,0,0,0,0,1,0],[1,0,1,0,0,0,0,0,2,2]], "labels": ["New","Returning"] },"sales": { "xaxis": [1,2,3,4,5,6,7,8,9,10], "data": [[392,0,319.2,178,0,0,0,0,38.19,5.81]], "labels": ["Sales"] } },"highlights": [ "Balance: $36,838.29, Sample Data", "Balance: $9,989.17, Paypal", "Balance: $30,248.24, 2Checkout", "Today: 0 customers, 0 items sold, 0 transactions ", "Last Transaction: PayPal, Other, $0.02", "Yesterday: Sales $0.00" ],"lists": {"products": { "headers": ["Item","Sales","Refunds","Total","Currency"], "data": [ ["Web Entrepreneurs' Club - Annual",2,0,298,"USD"], ["Web Entrepreneurs' Club Premium - Annual",1,0,199,"USD"], ["Putler's Guide to Sales Analysis - eBook",2,0,138,"USD"], ["Web Millionaire - Audio Book",2,0,98,"USD"] ] }, "customers": { "headers": ["Customer","Last On","Transactions","Total","Currency"], "data": [ ["Onyebuchi Onochie","2013-10-01 05:59:37",1,274,"USD"], ["Anton Millar","2013-10-03 22:23:06",3,199,"USD"], ["Meaza Dahlak","2013-10-04 13:00:06",1,149,"USD"], ["Tena Antolović","2013-10-03 16:57:15",1,90,"USD"] ] }, "sales": { "headers": ["Date","Customer","Status","Amount","Currency"], "data": [ ["2013-10-04 13:00:06","Meaza Dahlak","Completed",149,"USD"], ["2013-10-04 05:56:12","Din Pajović","Completed",29,"EUR"], ["2013-10-03 22:23:06","Anton Millar","Refunded",0,"AUD"], ["2013-10-03 16:57:15","Tena Antolović","Completed",90,"GBP"] ] }}}
[dt_gap height=”60″]

API Endpoints for Individual Stats

Want to access a particular KPI? Use individual endpoints!

[dt_gap height=”60″]

Account Balance /kpi/account-balance

Get the account balance

URL
https://api.putler.com/outbound/dashboard/kpi/account-balance
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value The total balance for selected accounts
change Difference between current and the previous balance
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/account-balance?email=your-email&token=your-token
Example Response
{"value": "$40,203.00","change": "9951.69","label": "Account Balance"}

Today’s Sales /kpi/todays-sales

Get today’s sales amount

URL
https://api.putler.com/outbound/dashboard/kpi/todays-sales
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Today’s sales for selected accounts
change Difference between today’s sales and yesterday’s sales
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/todays-sales?email=your-email&token=your-token
Example Response
{"value": "$392.00","change": "392.00","label": "Today's Sales"}

Month To Date Sales /kpi/month-to-date-sales

Get current month’s sales amount

URL
https://api.putler.com/outbound/dashboard/kpi/month-to-date-sales
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Current month’s sales for selected accounts
change Difference between current month’s sales and last month’s sales
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/month-to-date-sales?email=your-email&token=your-token
Example Response
{"value": "$392.00","change": "-38.87","label": "Month to Date Sales"}

Forecasted Sales /kpi/forecasted-sales

Get forecasted sales for current month

URL
https://api.putler.com/outbound/dashboard/kpi/forecasted-sales
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Current month’s forecasted sales for selected accounts
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/forecasted-sales?email=your-email&token=your-token
Example Response
{"value": "$22,011.17","label": "Forecasted Sales"}

Average Sales / Day /kpi/avg-sales-per-day

Get average sale per day

URL
https://api.putler.com/outbound/dashboard/kpi/avg-sales-per-day
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Average Sales per day
change Difference between today’s and yesterday’s average sales/day
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/avg-sales-per-day?email=your-email&token=your-token
Example Response
{"value": "$392.00","change": "-38.87","label": "Average Sales/Day"}

Monthly Target /kpi/monthly-target

Get progress of monthly target set for current month

URL
https://api.putler.com/outbound/dashboard/kpi/monthly-target
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Percentage of monthly target achieved
target Monthly target set
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/monthly-target?email=your-email&token=your-token
Example Response
{"value": "196.00%","change": "of $200.00","label": "Target"}

Sales Before Refunds Amount /kpi/sales-before-refunds-amount

Get sales before refunds amount for current month

URL
https://api.putler.com/outbound/dashboard/kpi/sales-before-refunds-amount
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Sales amount
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/sales-before-refunds-amount?email=your-email&token=your-token
Example Response
{"value": "$323.00","label": "Sales Before Refunds Amount"}

Sales Before Refunds Count /kpi/sales-before-refunds-count

Get count of sales for current month

URL
https://api.putler.com/outbound/dashboard/kpi/sales-before-refunds-count
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Number of Sales
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/sales-before-refunds-count?email=your-email&token=your-token
Example Response
{"value": "32","label": "Sales Before Refunds Count"}

Refunds Amount /kpi/refunds-amount

Get refunded amount for current month

URL
https://api.putler.com/outbound/dashboard/kpi/refunds-amount
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Refunds amount
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/refunds-amount?email=your-email&token=your-token
Example Response
{"value": "$29.00","label": "Refunds Amount"}

Refunds Count /kpi/refunds-count

Get count of refunds for current month

URL
https://api.putler.com/outbound/dashboard/kpi/refunds-count
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Refunds count
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/refunds-count?email=your-email&token=your-token
Example Response
{"value": "14","label": "Refunds Count"}

Average Revenue / Sale /kpi/avg-revenue-per-sale

Get the average revenue earned per sale for current month

URL
https://api.putler.com/outbound/dashboard/kpi/avg-revenue-per-sale
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Average revenue earned per sale
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/avg-revenue-per-sale?email=your-email&token=your-token
Example Response
{"value": "$91.82","label": "Average Revenue / Sale"}

Average Revenue / Day /kpi/avg-revenue-per-day

Get the average revenue earned per day for current month

URL
https://api.putler.com/outbound/dashboard/kpi/avg-revenue-per-day
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Average revenue earned per day
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/avg-revenue-per-day?email=your-email&token=your-token
Example Response
{"value": "$133.74","label": "Average Revenue / Day"}

Active Subscriptions /kpi/subscriptions-active

Get the number of active subscriptions in current month

URL
https://api.putler.com/outbound/dashboard/kpi/subscriptions-active
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Number of active subscriptions
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/subscriptions-active?email=your-email&token=your-token
Example Response
curl /kpi/subscriptions-active -d 'email=your-email' -d 'token=your-token'

New Subscriptions /kpi/subscriptions-new

Get the number of new subscriptions in current month

URL
https://api.putler.com/outbound/dashboard/kpi/subscriptions-new
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Number of new subscriptions
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/subscriptions-new?email=your-email&token=your-token
Example Response
{"value": 1,"label": "New Subscriptions"}

Canceled Subscriptions /kpi/subscriptions-canceled

Get the number of subscriptions canceled in current month

URL
https://api.putler.com/outbound/dashboard/kpi/subscriptions-canceled
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Number of subscriptions canceled
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/subscriptions-canceled?email=your-email&token=your-token
Example Response
{"value": 2,"label": "Canceled Subscriptions"}

Failed Subscriptions /kpi/subscriptions-failed

Get the number of subscriptions failed in current month

URL
https://api.putler.com/outbound/dashboard/kpi/subscriptions-failed
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Number of subscriptions failed
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/subscriptions-failed?email=your-email&token=your-token
Example Response
{"value": 0,"label": "Failed Subscriptions"}

Suspended Subscriptions /kpi/subscriptions-suspended

Get the number of subscriptions suspended in current month

URL
https://api.putler.com/outbound/dashboard/kpi/subscriptions-suspended
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Number of subscriptions suspended
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/subscriptions-suspended?email=your-email&token=your-token
Example Response
{"value": 1,"label": "Suspended Subscriptions"}

Sales Frequency /kpi/sales-frequency

Get average interval between two sales for current month

URL
https://api.putler.com/outbound/dashboard/kpi/sales-frequency
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Frequency of sale
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/sales-frequency?email=your-email&token=your-token
Example Response
{"value": "15h 57min","label": "Frequency: one sale every"}

Sales From Top 20% Products /kpi/sales-from-top-products

Get sales from the top 20% products for current month

URL
https://api.putler.com/outbound/dashboard/kpi/sales-from-top-products
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Sales from top 20% products
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/sales-from-top-products?email=your-email&token=your-token
Example Response
{"value": "$497.00 • 55.89%","label": "Sales From Top 20% Products"}

Quantity Sold /kpi/qty-sold

Get quantity of products sold for current month

URL
https://api.putler.com/outbound/dashboard/kpi/qty-sold
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Quantity of products sold
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/qty-sold?email=your-email&token=your-token
Example Response
{"value": 13,"label": "Qty Sold"}

Average Quantity Sold / Day /kpi/avg-qty-sold-per-day

Get the average quantity sold per day for current month

URL
https://api.putler.com/outbound/dashboard/kpi/avg-qty-sold-per-day
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Average quantity sold per day
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/avg-qty-sold-per-day?email=your-email&token=your-token
Example Response
{"value": "1.86","label": "Average Qty Sold / Day"}

Fastest Moving Product /kpi/fastest-moving-product

Get the fastest moving product for current month

URL
https://api.putler.com/outbound/dashboard/kpi/fastest-moving-product
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Fastest Moving Product
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/fastest-moving-product?email=your-email&token=your-token
Example Response
{"value": "Web Millionaire - eBook","label": "Fastest Moving Product"}

Slowest Moving Product /kpi/slowest-moving-product

Get the fastest moving product for current month

URL
https://api.putler.com/outbound/dashboard/kpi/slowest-moving-product
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Slowest Moving Product
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/slowest-moving-product?email=your-email&token=your-token
Example Response
{"value": "Photography Tutorials","label": "Slowest Moving Product"}

Customers /kpi/customers

Get the number of customers for current month

URL
https://api.putler.com/outbound/dashboard/kpi/customers
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Number of Customers
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/customers?email=your-email&token=your-token
Example Response
{"value": 9,"label": "Customers"}

Customers Acquired / Day /kpi/customers-acquired-per-day

Get the number of customers acquired per day for current month

URL
https://api.putler.com/outbound/dashboard://api.putler.com/outbound/kpi/customers-acquired-per-day
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Number of customers acquired per day
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard://api.putler.com/outbound/kpi/customers-acquired-per-day?email=your-email&token=your-token
Example Response
{"value": "1.29","label": "Customers Acquired / Day"}

Returning Customers /kpi/returning-customers

Get the number and percentage of returning customers for current month

URL
https://api.putler.com/outbound/dashboard/kpi/returning-customers
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Number and percentage of returning customers
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/returning-customers?email=your-email&token=your-token
Example Response
{"value": "3 • 33.33%","label": "Returning Customers"}

Refunded Customers /kpi/refunded-customers

Get the number and percentage of customers refunded for current month

URL
https://api.putler.com/outbound/dashboard/kpi/refunded-customers
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Number and percentage of customers refunded
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/refunded-customers?email=your-email&token=your-token
Example Response
{"value": "1 • 11.11%","label": "Refunded Customers"}

Average Value Per Customer /kpi/avg-value-per-customer

Get the number and percentage of customers refunded for current month

URL
https://api.putler.com/outbound/dashboard/kpi/avg-value-per-customer
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Average value per customer
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/avg-value-per-customer?email=your-email&token=your-token
Example Response
{"value": "$73.87","label": "Average Value / Customer"}

Average Orders Per Customer /kpi/avg-orders-per-customer

Get the number and percentage of customers refunded for current month

URL
https://api.putler.com/outbound/dashboard/kpi/avg-orders-per-customer
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
value Average orders per customer
label KPI Label
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/kpi/avg-orders-per-customer?email=your-email&token=your-token
Example Response
{"value": "5.50","label": "Average Orders / Customer"}

Sales List /lists/sales

Get the list of sales for current month

URL
https://api.putler.com/outbound/dashboard/lists/sales
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
header Header labels for sales list
data List of sales
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/lists/sales?email=your-email&token=your-token
Example Response
{"headers": ["Date","Customer","Status","Amount","Currency"],"data": [["2013-10-04 13:00:06","Meaza Dahlak","Completed",149,"USD"],["2013-10-04 05:56:12","Din Pajović","Completed",29,"EUR"],["2013-10-03 22:23:06","Anton Millar","Refunded",0,"AUD"],["2013-10-03 16:57:15","Tena Antolović","Completed",90,"GBP"],["2013-10-03 04:46:12","Cary Fagan","Completed",29,"USD"],["2013-10-01 15:30:22","Margrét Skúladóttir","Completed",69,"EUR"]]}

Products List /lists/products

Get the list of products for current month

URL
https://api.putler.com/outbound/dashboard/lists/products
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
header Header labels for products list
data List of products
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/lists/products?email=your-email&token=your-token
Example Response
{"headers": ["Item","Sales","Refunds","Total","Currency"],"data": [["Web Entrepreneurs' Club - Annual",2,0,298,"USD"],["Web Entrepreneurs' Club Premium - Annual",1,0,199,"USD"],["Putler's Guide to Sales Analysis - eBook",2,0,138,"USD"],["Web Millionaire - Audio Book",2,0,98,"USD"],["Wordpress Theme Pack for Web Businesses",1,0,90,"USD"],["Putler's Guide to Sales Analysis - Audio Book",1,0,29,"USD"]]}

Customers List /lists/customers

Get the list of customers for current month

URL
https://api.putler.com/outbound/dashboard/lists/customers
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
header Header labels for customers list
data List of customers
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/lists/customers?email=your-email&token=your-token
Example Response
{"headers": ["Customer","Last On","Transactions","Total","Currency"],"data": [["Onyebuchi Onochie","2013-10-01 05:59:37",1,274,"USD"],["Anton Millar","2013-10-03 22:23:06",3,199,"USD"],["Meaza Dahlak","2013-10-04 13:00:06",1,149,"USD"],["Tena Antolović","2013-10-03 16:57:15",1,90,"USD"],["Margrét Skúladóttir","2013-10-01 15:30:22",1,69,"USD"]]}

Sales Chart /charts/sales

Get the sales chart for current month

URL
https://api.putler.com/outbound/dashboard/charts/sales
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
xaxis Dates of current month
data Series value for sales chart
labels Labels for sales chart
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/charts/sales?email=your-email&token=your-token
Example Response
{"xaxis": [1,2,3,4,5,6,7,8,9,10],"data": [[392,0,319.2,178,0,0,0,0,38.19,5.81]],"labels": ["Sales"]}

Products Chart /charts/products

Get the products chart for current month

URL
https://api.putler.com/outbound/dashboard/charts/products
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
xaxis Dates of current month
data Series value for products chart
labels Labels for products chart
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/charts/products?email=your-email&token=your-token
Example Response
{"xaxis": [1,2,3,4,5,6,7,8,9,10],"data": [[149,0,0,149,0,0,0,0,0,0],[0,0,199,0,0,0,0,0,0,0],[138,0,0,0,0,0,0,0,0,0],[98,0,0,0,0,0,0,0,0,0]],"labels": ["Web Entrepreneurs' Club - Annual","Putler's Guide to Sales Analysis - eBook","Web Millionaire - Audio Book","Others"]}

Customers Chart /charts/customers

Get the customers chart for current month

URL
https://api.putler.com/outbound/dashboard/charts/customers
HTTP Method
GET
Input Parameters
Parameter Description
email The email you use to login to Putler.
token Token generated from Putler for sharing data.
Data Returned
Parameter Description
xaxis Dates of current month
data Series value for customers chart
labels Labels for customers chart
Example API call using cURL
curl https://api.putler.com/outbound/dashboard/charts/customers?email=your-email&token=your-token
Example Response
{"xaxis": [1,2,3,4,5,6,7,8,9,10],"data": [[2,0,3,2,0,0,0,0,1,0],[1,0,1,0,0,0,0,0,2,2]],"labels": ["New","Returning"]}

Common Error Messages

It is possible that while using the API, you may come across some errors. Refer the table below to better understand the error messages.

Error Message Description
Authentication required Email or token not sent
Authentication failed Email or token is invalid or incorrect
Requested data not found or is invalid URL is invalid or misspelt