Dashboard

Get chart data

get

Fetches chart data for visualization.

Authorizations

Token

AuthorizationstringRequired

Query parameters

start_datestring · date-timeRequired

Start date for the data range.

end_datestring · date-timeRequired

End date for the data range.

channelintegerRequired

ID of the channel the customer belongs to

Example: 5

payment_option_slugstringOptional

Filter by payment option slug.

Example: credit_card

Responses

200

Successfully retrieved chart data.

application/json

countintegerOptional

Count of orders.

timestringOptional

Time representation for the chart. Hour of the day.

get

/api/v1/dashboard/chart/

HTTPcURLJavaScriptPython

GET /api/v1/dashboard/chart/?start_date=2026-03-06T20%3A00%3A53.989Z&end_date=2026-03-06T20%3A00%3A53.989Z&channel=5 HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

Successfully retrieved chart data.

[
  {
    "count": 1,
    "time": "text"
  }
]

Get top cities

get

Retrieves a list of cities with the highest order volumes.

Authorizations

Token

AuthorizationstringRequired

Query parameters

start_datestring · date-timeRequired

Start date for the data range.

end_datestring · date-timeRequired

End date for the data range.

channelintegerRequired

ID of the channel the customer belongs to

Example: 5

payment_option_slugstringOptional

Filter by payment option slug.

Example: credit_card

Responses

200

Successfully retrieved top cities.

application/json

namestringOptional

City name.

item_countintegerOptional

Number of items sold in the city.

city_countintegerOptional

Number of orders in the city.

pricenumber · floatOptional

Total sales amount for the city.

get

/api/v1/dashboard/top_cities/

HTTPcURLJavaScriptPython

GET /api/v1/dashboard/top_cities/?start_date=2026-03-06T20%3A00%3A53.989Z&end_date=2026-03-06T20%3A00%3A53.989Z&channel=5 HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

Successfully retrieved top cities.

[
  {
    "name": "text",
    "item_count": 1,
    "city_count": 1,
    "price": 1
  }
]

Get top categories

get

Retrieves a list of top-selling categories.

Authorizations

Token

AuthorizationstringRequired

Query parameters

start_datestring · date-timeRequired

Start date for the data range.

end_datestring · date-timeRequired

End date for the data range.

channelintegerRequired

ID of the channel the customer belongs to

Example: 5

payment_option_slugstringOptional

Filter by payment option slug.

Example: credit_card

Responses

200

Successfully retrieved top categories.

application/json

pkintegerOptional

ProductCategory ID.

namestringOptional

Category name.

item_countintegerOptional

Total number of sales for the category.

pricenumber · floatOptional

Total sales amount for the category.

get

/api/v1/dashboard/top_categories/

HTTPcURLJavaScriptPython

GET /api/v1/dashboard/top_categories/?start_date=2026-03-06T20%3A00%3A53.989Z&end_date=2026-03-06T20%3A00%3A53.989Z&channel=5 HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

Successfully retrieved top categories.

[
  {
    "pk": 1,
    "name": "text",
    "item_count": 1,
    "price": 1
  }
]

Get product details

get

Retrieves total product count and stock for the given channel.

Authorizations

Token

AuthorizationstringRequired

Query parameters

channelintegerRequired

ID of the channel the customer belongs to

Example: 5

payment_option_slugstringOptional

Filter by payment option slug.

Example: credit_card

Responses

200

Successfully retrieved product details.

application/json

total_product_countintegerOptionalExample: 123

total_product_stocksintegerOptionalExample: 123

get

/api/v1/dashboard/

HTTPcURLJavaScriptPython

GET /api/v1/dashboard/?channel=5 HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

Successfully retrieved product details.

{
  "total_product_count": 123,
  "total_product_stocks": 123
}

Get products sales data.

get

Fetches a list of products sale data for a given period.

Authorizations

Token

AuthorizationstringRequired

Query parameters

start_datestring · date-timeRequired

Start date for the data range.

end_datestring · date-timeRequired

End date for the data range.

channelintegerRequired

ID of the channel the customer belongs to

Example: 5

payment_option_slugstringOptional

Filter by payment option slug.

Example: credit_card

Responses

200

Successfully retrieved products sale data.

application/json

soldintegerOptional

Total number of products sold.

totalnumber · floatOptional

Total sales amount.

stockintegerOptional

Total stock.

base_codestringOptional

Product base code.

skustringOptional

Product SKU.

namestringOptional

Product name.

channelstringOptional

Channel name.

get

/api/v1/dashboard/orders_by_product/

HTTPcURLJavaScriptPython

GET /api/v1/dashboard/orders_by_product/?start_date=2026-03-06T20%3A00%3A53.989Z&end_date=2026-03-06T20%3A00%3A53.989Z&channel=5 HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

Successfully retrieved products sale data.

[
  {
    "sold": 1,
    "total": 1,
    "stock": 1,
    "base_code": "text",
    "sku": "text",
    "name": "text",
    "channel": "text"
  }
]

Get top products

get

Fetches a list of top products based on sales or quantity.

Authorizations

Token

AuthorizationstringRequired

Query parameters

start_datestring · date-timeRequired

Start date for the data range.

end_datestring · date-timeRequired

End date for the data range.

channelintegerRequired

ID of the channel the customer belongs to

Example: 5

payment_option_slugstringOptional

Filter by payment option slug.

Example: credit_card

Responses

200

Successfully retrieved top products.

application/json

orderitem__productintegerOptional

Product ID.

product_countintegerOptional

Total quantity sold.

pricenumber · floatOptional

Total sales amount.

namestringOptional

Product name.

get

/api/v1/dashboard/top_products/

HTTPcURLJavaScriptPython

GET /api/v1/dashboard/top_products/?start_date=2026-03-06T20%3A00%3A53.989Z&end_date=2026-03-06T20%3A00%3A53.989Z&channel=5 HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

Successfully retrieved top products.

[
  {
    "orderitem__product": 1,
    "product_count": 1,
    "price": 1,
    "name": "text"
  }
]

Get overall data

get

Fetches overall dashboard data such as turnover, sales, and refunds.

Authorizations

Token

AuthorizationstringRequired

Query parameters

start_datestring · date-timeRequired

Start date for the data range.

end_datestring · date-timeRequired

End date for the data range.

channelintegerRequired

ID of the channel the customer belongs to

Example: 5

payment_option_slugstringOptional

Filter by payment option slug.

Example: credit_card

Responses

200

Successfully retrieved overall data.

application/json

turnovernumber · floatOptionalExample: 123.45

total_order_quantityintegerOptionalExample: 123

total_orderitem_quantityintegerOptionalExample: 123

average_sale_pricenumber · floatOptionalExample: 123.45

average_basket_pricenumber · floatOptionalExample: 123.45

total_shipping_amountnumber · floatOptionalExample: 123.45

total_discountnumber · floatOptionalExample: 123.45

updated_atstring · date-timeOptionalExample: 2021-01-01T00:00:00Z

total_sale_amountnumber · floatOptionalExample: 123.45

total_refund_amountnumber · floatOptionalExample: 123.45

total_cancel_amountnumber · floatOptionalExample: 123.45

total_cancel_quantityintegerOptionalExample: 123

total_refund_quantityintegerOptionalExample: 123

currency_typestring · enumOptionalPossible values:

get

/api/v1/dashboard/overall_data/

HTTPcURLJavaScriptPython

GET /api/v1/dashboard/overall_data/?start_date=2026-03-06T20%3A00%3A53.989Z&end_date=2026-03-06T20%3A00%3A53.989Z&channel=5 HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

Successfully retrieved overall data.

{
  "turnover": 123.45,
  "total_order_quantity": 123,
  "total_orderitem_quantity": 123,
  "average_sale_price": 123.45,
  "average_basket_price": 123.45,
  "total_shipping_amount": 123.45,
  "total_discount": 123.45,
  "updated_at": "2021-01-01T00:00:00Z",
  "total_sale_amount": 123.45,
  "total_refund_amount": 123.45,
  "total_cancel_amount": 123.45,
  "total_cancel_quantity": 123,
  "total_refund_quantity": 123,
  "currency_type": "TL"
}