ForSURE.statisticspage.chart_management.chart_endpoints

baseURL = '/stats/charts'

Base URL for all requests

POST {baseURL}/chart
async def get_chart_data()

Get every data point that contributed to the chart defined. This will return all products that were applicable and will contain all relevant columns.

Parameters
  • chart: JSON containing the chart description and filters.

        {
            "chart_type": "Bar Chart",
            "title": "Product Net Weight (g) per Week",
            "x_columns": [
                "Week"
            ],
            "y_columns": [
                "Product Net Weight (g)",
                "Paper/Carton"
            ],
            "category": "Custom",
            "filters": {
                "country": [
                    "DE"
                ],
                "start_time": "2024-04-01",
                "end_time": "2024-04-28",
                "profile": [
                    "1"
                ],
                "report_name": [],
                "categories": []
            }
        }
    
Returns

Successful response

    [
    {
        "name": "Fitness Tracker Watch",
        "country": "DE",
        "profile": "1. Shopify",
        "Week": "01-04-24",
        "Product Net Weight (g)": 1000,
        "Paper/Carton": 600
    },
    {
        "name": "Solar Panel Charger",
        "country": "DE",
        "profile": "1. Shopify",
        "Week": "01-04-24",
        "Product Net Weight (g)": 1000,
        "Paper/Carton": 400
    },