Dashboard

Get chart data

get

Fetches chart data for visualization.

Authorizations

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

get

HTTPcURLJavaScriptPython

GET /api/v1/dashboard/chart/ HTTP/1.1
Host: sandbox.akinon.com
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

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

get

HTTPcURLJavaScriptPython

GET /api/v1/dashboard/top_cities/ HTTP/1.1
Host: sandbox.akinon.com
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

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

get

HTTPcURLJavaScriptPython

GET /api/v1/dashboard/top_categories/ HTTP/1.1
Host: sandbox.akinon.com
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

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

get

HTTPcURLJavaScriptPython

GET /api/v1/dashboard/ HTTP/1.1
Host: sandbox.akinon.com
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

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

get

HTTPcURLJavaScriptPython

GET /api/v1/dashboard/orders_by_product/ HTTP/1.1
Host: sandbox.akinon.com
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

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

get

HTTPcURLJavaScriptPython

GET /api/v1/dashboard/top_products/ HTTP/1.1
Host: sandbox.akinon.com
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

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

get

HTTPcURLJavaScriptPython

GET /api/v1/dashboard/overall_data/ HTTP/1.1
Host: sandbox.akinon.com
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"
}