Api call for adding charts to dashboard

[Chirag6525]

How can I include a chart in my dashboard using the restApi, as I have created a dataset using the api and also created chart with the dataset through api (visualization is not coming in the chart but it is being created), now I am trying to integrate the chart into a dashboard which I have made in the superset interface itself and it is showing on the frontend. I am unable to add the chart in the dashboard. It is giving me error as url not found!!!

@api_view(['POST'])
@csrf_exempt
@authentication_classes([SessionAuthentication, BasicAuthentication])
@permission_classes([AllowAny])
def add_chart(request):
    try:
        auth_header = request.headers.get('Authorization')
        
        if not auth_header:
            return JsonResponse({'error': 'Authorization header missing'}, status=status.HTTP_401_UNAUTHORIZED)

        login_token = auth_header.split(' ')[1] if ' ' in auth_header else None
        if not login_token:
            return JsonResponse({'error': 'Invalid Authorization header'}, status=status.HTTP_401_UNAUTHORIZED)

        try:
            data = json.loads(request.body)
        except json.JSONDecodeError:
            return JsonResponse({'error': 'Invalid JSON in request body'}, status=status.HTTP_400_BAD_REQUEST)

        chart_id = data.get('chart_id')
        dashboard_name = data.get('dashboard_name', 'Debrief')
        
        if not chart_id:
            return JsonResponse({'error': 'Chart ID is required'}, status=status.HTTP_400_BAD_REQUEST)

        session_response = requests.get(
            f"{settings.SUPERSET_URL}/api/v1/security/csrf_token/",
            headers={
                "Authorization": f"Bearer {login_token}"
            }
        )

        if session_response.status_code != 200:
            return JsonResponse({'error': 'Failed to get CSRF session'}, status=session_response.status_code)

        csrf_token = session_response.json().get('result')
        session_cookie = session_response.cookies.get('session')
        print("ok till here")
        # First, get the current dashboard layout
        dashboard_response = requests.get(
            f"{settings.SUPERSET_URL}/api/v1/dashboard/14",
            headers={
                "Authorization": f"Bearer {login_token}"
            }
        )
        print(dashboard_response)
        # if dashboard_response.status_code != 200:
        #     return JsonResponse({
        #         'error': 'Failed to get dashboard data',
        #         'details': dashboard_response.text
        #     }, status=dashboard_response.status_code)

        dashboard_data = dashboard_response.json()['result']
        position_json = json.loads(dashboard_data['position_json'])

        # Create new chart component
        new_chart_id = f"CHART-{chart_id}"
        new_chart = {
            "children": [],
            "id": new_chart_id,
            "meta": {
                "chartId": int(chart_id),
                "height": 50,
                "sliceName": "New Chart",
                "uuid": str(uuid.uuid4()),
                "width": 12
            },
            "type": "CHART"
        }

        # Add chart to grid
        grid_children = position_json["GRID_ID"]["children"]
        grid_children.append(new_chart_id)
        position_json["GRID_ID"]["children"] = grid_children
        position_json[new_chart_id] = new_chart

        # Update dashboard with new layout
        update_response = requests.put(
            f"{settings.SUPERSET_URL}/api/v1/dashboard/14",
            json={
                "json_metadata": dashboard_data['json_metadata'],
                "position_json": json.dumps(position_json),
                "dashboard_title": dashboard_data['dashboard_title'],
            },
            headers={
                "Content-Type": "application/json",
                "Authorization": f"Bearer {login_token}",
                "X-CSRFToken": csrf_token
            },
            cookies={
                'session': session_cookie
            }
        )

        print("Update response:", update_response.status_code)
        print("Update content:", update_response.text)

        if update_response.status_code == 200:
            return JsonResponse({
                'message': 'Chart added to dashboard successfully',
                'dashboard_id': 14,
                'chart_id': chart_id,
                'position': new_chart
            }, status=status.HTTP_200_OK)
        else:
            return JsonResponse({
                'error': 'Failed to update dashboard',
                'details': update_response.text,
                'status_code': update_response.status_code
            }, status=update_response.status_code)

    except Exception as e:
        return JsonResponse({
            'error': 'Internal server error',
            'details': str(e)
        }, status=status.HTTP_500_INTERNAL_SERVER_ERROR)

[dosubot[bot]]

Hey @Chirag6525, how's it going? I'm here to help you out with any bugs, questions, or contributions you have. Let's tackle this together!

The "URL not found" error you're encountering when trying to add a chart to a dashboard in Superset could be due to several reasons. Here are some steps to troubleshoot and resolve the issue:

1. Check Endpoint URL: Ensure that the endpoint URL is correct. The correct endpoint for updating a dashboard is /api/v1/dashboard/${id} where ${id} is the dashboard ID. Make sure the ID is correct and the URL is properly formatted ^[1].

2. Verify Permissions: Ensure that the user associated with the login_token has the necessary permissions to access and modify the dashboard. A lack of permissions can result in a 404 error ^[2].

3. CSRF Token and Session: Confirm that the CSRF token and session cookie are correctly retrieved and included in the request headers and cookies. The CSRF token should be in the X-CSRFToken header, and the session cookie should be included in the request ^[3].

4. Check Request Format: Ensure that the request body is correctly formatted as JSON and includes all necessary fields. The position_json should be a valid JSON string, and other fields like json_metadata and dashboard_title should be included as needed ^[4].

5. Debugging: Use print statements or logging to verify the values of variables like csrf_token, session_cookie, and position_json before making the PUT request. This can help identify any issues with the data being sent.

By following these steps, you should be able to identify and resolve the issue causing the "URL not found" error.

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Other}