Analytics
Get sales data with filtering
Get sales data with revenue breakdown, filtered by month/week. This is a public API that requires a fermion API key.
Authentication with the “FERMION-API-KEY” header is required to use this endpoint.
Rate limit: Maximum 30 requests in a window of 1m.
POST
/
public
/
get-sales-data
Get sales data with filtering
curl --request POST \
--url https://backend.codedamn.com/api/public/get-sales-data \
--header 'Content-Type: application/json' \
--header 'FERMION-API-KEY: <api-key>' \
--data '
{
"data": [
{
"data": {
"from": "<string>",
"to": "<string>",
"timezone": "<string>",
"shouldIncludeBreakdown": true,
"productTypeFilter": [],
"paymentStatusFilter": []
}
}
]
}
'import requests
url = "https://backend.codedamn.com/api/public/get-sales-data"
payload = { "data": [{ "data": {
"from": "<string>",
"to": "<string>",
"timezone": "<string>",
"shouldIncludeBreakdown": True,
"productTypeFilter": [],
"paymentStatusFilter": []
} }] }
headers = {
"FERMION-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'FERMION-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: [
{
data: {
from: '<string>',
to: '<string>',
timezone: '<string>',
shouldIncludeBreakdown: true,
productTypeFilter: [],
paymentStatusFilter: []
}
}
]
})
};
fetch('https://backend.codedamn.com/api/public/get-sales-data', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://backend.codedamn.com/api/public/get-sales-data",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
[
'data' => [
'from' => '<string>',
'to' => '<string>',
'timezone' => '<string>',
'shouldIncludeBreakdown' => true,
'productTypeFilter' => [
],
'paymentStatusFilter' => [
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"FERMION-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://backend.codedamn.com/api/public/get-sales-data"
payload := strings.NewReader("{\n \"data\": [\n {\n \"data\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"timezone\": \"<string>\",\n \"shouldIncludeBreakdown\": true,\n \"productTypeFilter\": [],\n \"paymentStatusFilter\": []\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("FERMION-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://backend.codedamn.com/api/public/get-sales-data")
.header("FERMION-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": [\n {\n \"data\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"timezone\": \"<string>\",\n \"shouldIncludeBreakdown\": true,\n \"productTypeFilter\": [],\n \"paymentStatusFilter\": []\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://backend.codedamn.com/api/public/get-sales-data")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["FERMION-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": [\n {\n \"data\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"timezone\": \"<string>\",\n \"shouldIncludeBreakdown\": true,\n \"productTypeFilter\": [],\n \"paymentStatusFilter\": []\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"output": {
"status": "ok",
"data": {
"summary": {
"totalRevenueInrPaise": 123,
"totalSalesCount": 123,
"averageSaleValueInrPaise": 123,
"periodStart": "2023-11-07T05:31:56Z",
"periodEnd": "2023-11-07T05:31:56Z"
},
"revenueByPeriod": [
{
"period": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"totalRevenuePaise": 123,
"salesCount": 123,
"breakdown": [
{
"revenuePaise": 123,
"salesCount": 123
}
]
}
],
"topProducts": [
{
"productId": "<string>",
"productName": "<string>",
"totalRevenuePaise": 123,
"salesCount": 123
}
]
}
}
}
]⌘I
Get sales data with filtering
curl --request POST \
--url https://backend.codedamn.com/api/public/get-sales-data \
--header 'Content-Type: application/json' \
--header 'FERMION-API-KEY: <api-key>' \
--data '
{
"data": [
{
"data": {
"from": "<string>",
"to": "<string>",
"timezone": "<string>",
"shouldIncludeBreakdown": true,
"productTypeFilter": [],
"paymentStatusFilter": []
}
}
]
}
'import requests
url = "https://backend.codedamn.com/api/public/get-sales-data"
payload = { "data": [{ "data": {
"from": "<string>",
"to": "<string>",
"timezone": "<string>",
"shouldIncludeBreakdown": True,
"productTypeFilter": [],
"paymentStatusFilter": []
} }] }
headers = {
"FERMION-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'FERMION-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: [
{
data: {
from: '<string>',
to: '<string>',
timezone: '<string>',
shouldIncludeBreakdown: true,
productTypeFilter: [],
paymentStatusFilter: []
}
}
]
})
};
fetch('https://backend.codedamn.com/api/public/get-sales-data', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://backend.codedamn.com/api/public/get-sales-data",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
[
'data' => [
'from' => '<string>',
'to' => '<string>',
'timezone' => '<string>',
'shouldIncludeBreakdown' => true,
'productTypeFilter' => [
],
'paymentStatusFilter' => [
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"FERMION-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://backend.codedamn.com/api/public/get-sales-data"
payload := strings.NewReader("{\n \"data\": [\n {\n \"data\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"timezone\": \"<string>\",\n \"shouldIncludeBreakdown\": true,\n \"productTypeFilter\": [],\n \"paymentStatusFilter\": []\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("FERMION-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://backend.codedamn.com/api/public/get-sales-data")
.header("FERMION-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": [\n {\n \"data\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"timezone\": \"<string>\",\n \"shouldIncludeBreakdown\": true,\n \"productTypeFilter\": [],\n \"paymentStatusFilter\": []\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://backend.codedamn.com/api/public/get-sales-data")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["FERMION-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": [\n {\n \"data\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"timezone\": \"<string>\",\n \"shouldIncludeBreakdown\": true,\n \"productTypeFilter\": [],\n \"paymentStatusFilter\": []\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"output": {
"status": "ok",
"data": {
"summary": {
"totalRevenueInrPaise": 123,
"totalSalesCount": 123,
"averageSaleValueInrPaise": 123,
"periodStart": "2023-11-07T05:31:56Z",
"periodEnd": "2023-11-07T05:31:56Z"
},
"revenueByPeriod": [
{
"period": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"totalRevenuePaise": 123,
"salesCount": 123,
"breakdown": [
{
"revenuePaise": 123,
"salesCount": 123
}
]
}
],
"topProducts": [
{
"productId": "<string>",
"productName": "<string>",
"totalRevenuePaise": 123,
"salesCount": 123
}
]
}
}
}
]