Putler Outbound API
Read your Putler KPIs, lists and charts in your own apps with the Outbound API: authentication, collection endpoints and error messages.
Use Putler’s Outbound API to read your KPIs, lists and charts in your own apps, dashboards or spreadsheets. Pull everything in one call with the collection endpoints, or fetch only the stat you need with an individual endpoint.
All calls return data for the current month, for the account selected on the Sharing tab, in the currency selected on the Sharing tab.
The Outbound API is not self-serve. If you want to use it, contact our support team first so we can enable it for your account.
Authentication
Every call needs your Putler email address and your Sharing token. Without them, or with invalid ones, you get an Authentication failed error.
- Log in to your Putler account.
- Go to Settings > Sharing and check Enable Sharing.
- Copy the sharing token, and pass it with your login email on every call.
| Parameter | Description |
|---|---|
email | The email you use to log in to Putler |
token | The sharing token generated by Putler |
Collection endpoints
KPIs
Get KPIs.
GET https://api.putler.com/outbound/dashboard/kpi
Returns:
| Field | Description |
|---|---|
kpi | All the KPIs |
curl https://api.putler.com/outbound/dashboard/kpi?email=your-email&token=your-tokenExample 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
Get lists.
GET https://api.putler.com/outbound/dashboard/lists
Returns:
| Field | Description |
|---|---|
lists | Sales, products and customers lists |
curl https://api.putler.com/outbound/dashboard/lists?email=your-email&token=your-tokenExample 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
Get charts.
GET https://api.putler.com/outbound/dashboard/charts
Returns:
| Field | Description |
|---|---|
charts | Sales, products and customers charts |
curl https://api.putler.com/outbound/dashboard/charts?email=your-email&token=your-tokenExample 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.
GET https://api.putler.com/outbound/dashboard
Returns:
| Field | Description |
|---|---|
data | kpi, lists, charts, meta, highlights |
curl https://api.putler.com/outbound/dashboard?email=your-email&token=your-tokenExample 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"
]
]
}
}
}Individual stats
Each stat also has its own endpoint, so you pull only what you need:
- KPI endpoints: 29 single-value stats such as account balance, month-to-date sales and returning customers.
- List and chart endpoints: sales, products and customers as lists and as charts.
Common 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 |