Quickstart

This page shows you how to start with API-based and advanced mode dashboard creation in mediarithmics.

You can manage charts using the query tool and edit dashboards in the UI. Manipulating dashboards by API and in advanced mode can be useful in some advanced integrations, but will take longer.

Advanced mode

Full dashboard edition

1. Run your query in the query tool and save it as a technical query. Note the ID of the query.

2. In the computing console, go to dashboards and add/edit a dashboard

3. Choose a name and save your dashboard.

4. Switch to the Advanced tab.

5. Edit the JSON

See the DashboardContent object for a quick reference.

Dashboard advanced mode

Chart edition

1. Run your query in the query tool and save it as a technical query. Note the ID of the query.

2. In the computing console, go to dashboards and add/edit a dashboard

3. Add or edit a chart and go to the Advanced tab

4. Edit the JSON and preview your changes.

See the Chart object for a quick reference.

Chart advanced mode

By API

Step 1: Configure authentication

This quickstart guide uses the Long term access tokens authentication method. Choose and configure your own authentication method. For more information, see Authentication.

Step 2 : Prepare the OTQL queries you will use on your dashboard

Your dashboard could use OTQL queries or activities analytics queries to retrieve data. We will use both in this tutorial, and OTQL queries need to be registered using the Creating a query endpoint.

Creating a query

POST https://api.mediarithmics.com/v1/datamarts/:datamartId/queries

Register an OTQL query in the platform

We will create two OTQL queries for this tutorial. The first one counts the UserPoint in the datamart, the second one lists the devices they use.

For each query, note their ID.

You should adapt those queries to your data model if required.

BODY payload for query 1

{
    "datamart_id": {{datamartId}},
    "query_language": "OTQL",
    "query_text": "select @count{} FROM UserPoint"
}

BODY payload for query 2

{
    "datamart_id": {{datamartId}},
    "query_language": "OTQL",
    "query_text": "SELECT {agents {user_agent_info{form_factor @map}}} FROM UserPoint"
}

Step 3 : Create a dashboard registration

You first create a DashboardRegistration object to reference your dashboard and define where it is visible.

Create a dashboard registration

POST https://api.mediarithmics.com/v1/dashboards

Here is a sample body payload for a home dashboard with all the important properties

{
    "title": "My awesome dashboards",
    "scopes": [
        "home"
    ],
    "segment_ids": [],
    "builder_ids": [],
    "archived": false,
    "organisation_id": "{{orgId}}",
    "community_id": "{{communityId}}"
}

Step 4 : Put content in your dashboard

You can now upload content in your dashboard using the DashboardContent object.

Edit the content of a dashboard

PUT https://api.mediarithmics.com/v1/dashboards/:id/content?organisation_id=:organisation_id

Here is a sample body payload for a content using the queries we previously created.

{
    "sections": [
        {
            "title": "",
            "cards": [
                {
                    "x": 0,
                    "y": 0,
                    "h": 3,
                    "layout": "vertical",
                    "w": 8,
                    "charts": [
                        {
                            "title": "User points",
                            "type": "Metric",
                            "dataset": {
                                "type": "OTQL",
                                "query_id": "{{ID of query 1}}"
                            }
                        },
                        {
                            "title": "Device form factors",
                            "type": "Bars",
                            "dataset": {
                                "type": "OTQL",
                                "query_id": "{{ID of query 2}}"
                            },
                            "options": {}
                        }
                    ]
                }
            ]
        }
    ]
}

Go to your datamart's home page, and your dashboard is now displayed with the two charts we created !