Skip to content
Docs

Outbound API: Lists and Charts

Reference for the Putler Outbound API list and chart endpoints for sales, products and customers.

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

Sales List

Get the list of sales for current month.

GET https://api.putler.com/outbound/dashboard/lists/sales

Returns:

FieldDescription
headerHeader labels for sales list
dataList of sales
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

Get the list of products for current month.

GET https://api.putler.com/outbound/dashboard/lists/products

Returns:

FieldDescription
headerHeader labels for products list
dataList of products
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

Get the list of customers for current month.

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

Returns:

FieldDescription
headerHeader labels for customers list
dataList of customers
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

Get the sales chart for current month.

GET https://api.putler.com/outbound/dashboard/charts/sales

Returns:

FieldDescription
xaxisDates of current month
dataSeries value for sales chart
labelsLabels for sales chart
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

Get the products chart for current month.

GET https://api.putler.com/outbound/dashboard/charts/products

Returns:

FieldDescription
xaxisDates of current month
dataSeries value for products chart
labelsLabels for products chart
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

Get the customers chart for current month.

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

Returns:

FieldDescription
xaxisDates of current month
dataSeries value for customers chart
labelsLabels for customers chart
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"
  ]
}