Panel API integration

The Panel API enables integration of panels into your applications, offering an interactive way to explore and analyze innovation trends.
This API provides HTML-based iframes, allowing for dynamic visualizations that fit into your digital environment.

To learn more about the available panels, check out this article. 

‍

Getting started 

Before integrating the Panel API, you must authenticate and generate a token. 

You can test this API using:

• API Demo page, where you can also download a JavaScript demo app to test it directly in your browser.
• Panel API page. It showcases Panel API's integration features, listing all available panels and their corresponding API endpoints. For implementation details, refer to the source code of this page.  

‍

Make requests

To interact with the API, you must send HTTP GET or POST requests to the API endpoint using the default content type. Every request needs a token. 

• API Endpoint: https://api.mapegy.com
• Content-Type: application/x-www-form-urlencoded
• Route: /scout-panel/{panel}/

‍

Required parameters: 

• ‍q. Defines the query structure for retrieving panels. Find an example below. Learn more about the q parameter here. Note that for the Innograph stats panels, a query is not needed since these panels are not query-based.

{
    "format_version": "1.6.0",
    "data": {
        "semantic": "",
        "topics": [
            [
                "artificial intelligence",
                "deep learning"
            ]
        ],
        "not_topics": [],
        "organizations": [],
        "not_organizations": []
    }
}

‍

• panel. Use this parameter to select which panels you want to retrieve. Separate them by commas. You can find the endpoint that you need to call in the Panel API page.
  

‍

Optional Parameters:

• h: Adjust main color hue by adding a number from 0-259. 
• s: Adjust main color saturation by adding a number from 0-100. 
• l: Adjust main color lightness by adding a number from 0-100
• bgColor: The background color (e.g., #F6F8F9) should be a light shade. It does not affect the content background, which remains white, but applies to the surrounding area. This color will be visible while the iframe is loading, as well as behind loading screens, timeout/error messages, and the menu of multi-tab panels.
• cssPath:The path to a CSS file with customized styles (e.g. https:// ... .css?v=1.0). Be careful when using this option. Selectors and panel structure may change.

‍

Example: Access the Panel API with a valid token:

• Route: /scout-panel/
• Method: GET or POST
• Content-Type: application/x-www-form-urlencoded
• Mandatory parameters: q (query), panel, token
• Example GET request: https://api.mapegy.com/scout-panel/companies?q=%7B%22format_version%22%3A%221.4.0%22%2C%22data%22%3A%7B%22topics%22%3A%5B%5B%22artificial%20intelligence%22%2C%22deep%20learning%22%5D%5D%2C%22not_topics%22%3A%5B%5D%2C%22organizations%22%3A%5B%5D%2C%22not_organizations%22%3A%5B%5D%2C%22experts%22%3A%5B%5D%2C%22not_experts%22%3A%5B%5D%7D%7D&bgColor=%23F6F8F9&token=a_1aSfmdzkvU67TvVxkcdkDEPi3H4Sl3t-iuOmAITNK9ICLsaXmOaxoa7GfT5UPX
• Example response: