How to test any dashboard with api

[ZerotoZer]

Hello! I was trying to automate this process using api(using api/v1/chart/{pk}/data) by sending request without filters and with filters. For now i am using api to get all charts of dashboard and their data but struggling with filters. I am getting data from charts with filters applied and not applied. While i can get filter values from dashboard metadata, i can't get them if they are charts with type filter_box.
How to automate it in better way?
How to get filter values from filter box chart?

[dosubot[bot]]

Hello @ZerotoZer! I'm here to help you with your dashboard automation questions. Let's work together to find a solution.

To automate the process of testing a dashboard using the API and retrieve filter values from a filter_box chart, you can use the Cypress utility functions provided in the utils.ts file. These functions allow you to intercept API calls related to dashboard filtering and verify the retrieval of filter values.

Here's a basic example of how you might set up a Cypress test to retrieve filter values:

// Import necessary functions
import { interceptFiltering, setFilter } from 'cypress/e2e/dashboard/utils';

// Function to test retrieving filter values
function testRetrieveFilterValues() {
  // Intercept the filtering API call
  interceptFiltering();

  // Set a filter value (e.g., for a filter named 'Country')
  setFilter('Country', 'United States');

  // Wait for the filtering API call to complete
  cy.wait('@filtering').then((interception) => {
    // Access the response to verify filter values
    const filterValues = interception.response.body.result;
    // Perform assertions or further processing with filterValues
    expect(filterValues).to.include('United States');
  });
}

// Call the function in your test suite
describe('Dashboard Filter Test', () => {
  it('should retrieve filter values from filter_box chart', () => {
    testRetrieveFilterValues();
  });
});

This code sets up an intercept for the filtering API call, applies a filter, and waits for the API response to verify the filter values. Adjust the filter name and expected values as needed for your specific dashboard setup ^[1].

To continue talking to Dosu, mention @dosu.

---

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

[ZerotoZer]

Currently just using api seems enough.

[ZerotoZer]

@dosu how can i test any newly created dashboard?

[dosubot[bot]]

To test a newly created dashboard using the API, you can follow these steps:

1. Create the Dashboard: Use the POST /api/v1/dashboard/ endpoint to create a new dashboard. This will return the ID of the newly created dashboard.

2. Retrieve Dashboard Metadata: Use the GET /api/v1/dashboard/<id_or_slug> endpoint to fetch the dashboard's metadata. This will help you verify that the dashboard has been created correctly and contains the expected configuration.

3. Verify Charts and Datasets: Use the GET /api/v1/dashboard/<id_or_slug>/charts and GET /api/v1/dashboard/<id_or_slug>/datasets endpoints to ensure that the charts and datasets associated with the dashboard are correctly set up.

4. Test Dashboard Functionality: You can simulate user interactions by applying filters or other actions using the API and verify the responses. This can be done by sending requests to the relevant endpoints and checking the returned data.

By following these steps, you can programmatically test a newly created dashboard to ensure it meets your requirements ^[1][2].

To continue talking to Dosu, mention @dosu.

---

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