Outbound API: KPI Endpoints

Reference for the Putler Outbound API individual KPI endpoints: account balance, sales, refunds, subscriptions, customers and products.

Each endpoint returns one KPI for the current month. See the Outbound API overview for authentication.

Account Balance

Get the account balance.

GET https://api.putler.com/outbound/dashboard/kpi/account-balance

Returns:

Field	Description
`value`	The total balance for selected accounts
`change`	Difference between current and the previous balance
`label`	KPI Label

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

Get today’s sales amount.

GET https://api.putler.com/outbound/dashboard/kpi/todays-sales

Returns:

Field	Description
`value`	Today’s sales for selected accounts
`change`	Difference between today’s sales and yesterday’s sales
`label`	KPI Label

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

Get current month’s sales amount.

GET https://api.putler.com/outbound/dashboard/kpi/month-to-date-sales

Returns:

Field	Description
`value`	Current month’s sales for selected accounts
`change`	Difference between current month’s sales and last month’s sales
`label`	KPI Label

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

Get forecasted sales for current month.

GET https://api.putler.com/outbound/dashboard/kpi/forecasted-sales

Returns:

Field	Description
`value`	Current month’s forecasted sales for selected accounts
`label`	KPI Label

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

Get average sale per day.

GET https://api.putler.com/outbound/dashboard/kpi/avg-sales-per-day

Returns:

Field	Description
`value`	Average Sales per day
`change`	Difference between today’s and yesterday’s average sales/day
`label`	KPI Label

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

Get progress of monthly target set for current month.

GET https://api.putler.com/outbound/dashboard/kpi/monthly-target

Returns:

Field	Description
`value`	Percentage of monthly target achieved
`target`	Monthly target set
`label`	KPI Label

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

Get sales before refunds amount for current month.

GET https://api.putler.com/outbound/dashboard/kpi/sales-before-refunds-amount

Returns:

Field	Description
`value`	Sales amount
`label`	KPI Label

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

Get count of sales for current month.

GET https://api.putler.com/outbound/dashboard/kpi/sales-before-refunds-count

Returns:

Field	Description
`value`	Number of Sales
`label`	KPI Label

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

Get refunded amount for current month.

GET https://api.putler.com/outbound/dashboard/kpi/refunds-amount

Returns:

Field	Description
`value`	Refunds amount
`label`	KPI Label

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

Get count of refunds for current month.

GET https://api.putler.com/outbound/dashboard/kpi/refunds-count

Returns:

Field	Description
`value`	Refunds count
`label`	KPI Label

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

Get the average revenue earned per sale for current month.

GET https://api.putler.com/outbound/dashboard/kpi/avg-revenue-per-sale

Returns:

Field	Description
`value`	Average revenue earned per sale
`label`	KPI Label

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

Get the average revenue earned per day for current month.

GET https://api.putler.com/outbound/dashboard/kpi/avg-revenue-per-day

Returns:

Field	Description
`value`	Average revenue earned per day
`label`	KPI Label

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

Get the number of active subscriptions in current month.

GET https://api.putler.com/outbound/dashboard/kpi/subscriptions-active

Returns:

Field	Description
`value`	Number of active subscriptions
`label`	KPI Label

curl https://api.putler.com/outbound/dashboard/kpi/subscriptions-active?email=your-email&token=your-token

Example response:

{
  "value": 2,
  "label": "Active Subscriptions"
}

New Subscriptions

Get the number of new subscriptions in current month.

GET https://api.putler.com/outbound/dashboard/kpi/subscriptions-new

Returns:

Field	Description
`value`	Number of new subscriptions
`label`	KPI Label

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

Get the number of subscriptions canceled in current month.

GET https://api.putler.com/outbound/dashboard/kpi/subscriptions-canceled

Returns:

Field	Description
`value`	Number of subscriptions canceled
`label`	KPI Label

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

Get the number of subscriptions failed in current month.

GET https://api.putler.com/outbound/dashboard/kpi/subscriptions-failed

Returns:

Field	Description
`value`	Number of subscriptions failed
`label`	KPI Label

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

Get the number of subscriptions suspended in current month.

GET https://api.putler.com/outbound/dashboard/kpi/subscriptions-suspended

Returns:

Field	Description
`value`	Number of subscriptions suspended
`label`	KPI Label

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

Get average interval between two sales for current month.

GET https://api.putler.com/outbound/dashboard/kpi/sales-frequency

Returns:

Field	Description
`value`	Frequency of sale
`label`	KPI Label

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

Get sales from the top 20% products for current month.

GET https://api.putler.com/outbound/dashboard/kpi/sales-from-top-products

Returns:

Field	Description
`value`	Sales from top 20% products
`label`	KPI Label

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

Get quantity of products sold for current month.

GET https://api.putler.com/outbound/dashboard/kpi/qty-sold

Returns:

Field	Description
`value`	Quantity of products sold
`label`	KPI Label

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

Get the average quantity sold per day for current month.

GET https://api.putler.com/outbound/dashboard/kpi/avg-qty-sold-per-day

Returns:

Field	Description
`value`	Average quantity sold per day
`label`	KPI Label

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

Get the fastest moving product for current month.

GET https://api.putler.com/outbound/dashboard/kpi/fastest-moving-product

Returns:

Field	Description
`value`	Fastest Moving Product
`label`	KPI Label

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

Get the fastest moving product for current month.

GET https://api.putler.com/outbound/dashboard/kpi/slowest-moving-product

Returns:

Field	Description
`value`	Slowest Moving Product
`label`	KPI Label

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

Get the number of customers for current month.

GET https://api.putler.com/outbound/dashboard/kpi/customers

Returns:

Field	Description
`value`	Number of Customers
`label`	KPI Label

curl https://api.putler.com/outbound/dashboard/kpi/customers?email=your-email&token=your-token

Example response:

{
  "value": 9,
  "label": "Customers"
}

Customers Acquired / Day

Get the number of customers acquired per day for current month.

GET https://api.putler.com/outbound/dashboard://api.putler.com/outbound/kpi/customers-acquired-per-day

Returns:

Field	Description
`value`	Number of customers acquired per day
`label`	KPI Label

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

Get the number and percentage of returning customers for current month.

GET https://api.putler.com/outbound/dashboard/kpi/returning-customers

Returns:

Field	Description
`value`	Number and percentage of returning customers
`label`	KPI Label

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

Get the number and percentage of customers refunded for current month.

GET https://api.putler.com/outbound/dashboard/kpi/refunded-customers

Returns:

Field	Description
`value`	Number and percentage of customers refunded
`label`	KPI Label

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

Get the number and percentage of customers refunded for current month.

GET https://api.putler.com/outbound/dashboard/kpi/avg-value-per-customer

Returns:

Field	Description
`value`	Average value per customer
`label`	KPI Label

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

Get the number and percentage of customers refunded for current month.

GET https://api.putler.com/outbound/dashboard/kpi/avg-orders-per-customer

Returns:

Field	Description
`value`	Average orders per customer
`label`	KPI Label

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"
}