Developer
User guidesDeveloper websiteHelp centerLog in
  • Welcome!
  • Organisations structure
    • Datamart
    • Users and roles
  • User points
    • User identifiers
      • Networks IDs
        • Device-based Network IDs
          • Custom Device ID integration
          • ID5
          • First ID
        • User-based Network IDs
          • Custom User ID integration
          • UTIQ martechpass
      • Accounts
      • Emails
      • Device identifiers
    • User activities and events
    • Compartments
    • User profiles
    • User segments
    • Hyper point & Quarantine
  • Data model
    • Defining your schema
    • Computed fields
      • Concepts
      • Setup
      • Development
      • Examples
  • Data ingestion
    • Real time user tracking
      • Website tracking
      • Mobile apps tracking
      • Ads exposure tracking
      • AMP tracking
      • Conversions tracking
      • Email views and clicks
      • Tracking API
      • Event rules
      • Activity analyzers
    • Bulk processing
      • Imports
        • User activities import
        • User profiles import
        • User choices import
        • Segments import
      • Deletions
        • User identifiers deletion
        • Device points deletion
        • User points deletion
      • User identifiers association
      • Integration batch
    • Activities analytics
    • Data warehouse
      • Preliminary setup
        • BigQuery
      • Create data warehouse
  • Querying your data
    • OTQL queries
    • OTQL examples
    • GraphQL queries
    • UserPoint API
    • User activities
    • Activities analytics queries
      • API Quickstart
      • Dimensions and metrics
      • Use cases
    • Funnel API
  • Alerting
    • Alert configurations
  • Data visualisation
    • Quickstart
    • Dashboards
    • Sections and cards
    • Charts
    • Datasets and data sources
      • Using a data file data source
    • Transformations
    • Filters
    • Cookbook
    • Reference
  • Advanced usages
    • Audience segmentation
      • Audience features
      • Segment builders
      • Audience segment metrics
      • Audience segment feed
        • Building new feeds
        • Monitoring a feed
        • Curated Audiences (SDA)
      • Edge segments
      • Cohort-based Lookalike
    • Contextual targeting
      • Setup
      • Activation
        • Google Ad Manager
        • Xandr (through prebid.js)
      • API documentation
    • Exporting your data
      • Query Exports
      • Datamart replication
    • Data privacy compliance
      • User choices
      • Cleaning rules
      • Exercise of user rights
      • Cookies
    • Campaigns
    • Automations
      • Email routers
      • Email renderers
      • Opt-in provider
      • Custom action plugins
      • Usage limits for automations
    • Plugins
      • Concepts
      • Creation & Deployment
      • Coding your plugin
      • Manage existing plugins
      • Layouts
      • Presets
      • Monitoring
      • Throttling
      • Batching (for external feeds)
    • Platform monitoring
      • Resources usage
        • Dimensions and metrics
      • Collection volumes
        • Dimensions and metrics
      • Events ingestion monitoring
        • Dimensions and metrics
    • Data Clean Room
      • Bunker
      • Clean room
  • Resources
    • Tutorial: Data Ingestion
      • Your first events
        • Add the mediarithmics tag
          • Getting the tag
          • Adding the tag
        • Send events using the tag
          • Adding event properties
          • Finding the UserEvent type in your schema
          • Matching your schema
          • Standard events
      • Your first bulk imports
        • API basics
          • Authentication
          • Your first API call
        • Send documents using the API
          • Requirements
          • Sending documents
    • Using our API
      • Authentication
    • Tools & libraries
      • mics CLI
      • JS Tag
      • Plugin SDK
    • Data cubes
      • Creating a report
      • Reference
Powered by GitBook
On this page
  • Advanced mode
  • Full dashboard edition
  • Chart edition
  • By API
  • Step 1: Configure authentication
  • Step 2 : Prepare the OTQL queries you will use on your dashboard
  • Creating a query
  • Step 3 : Create a dashboard registration
  • Create a dashboard registration
  • Step 4 : Put content in your dashboard
  • Edit the content of a dashboard

Was this helpful?

Export as PDF
  1. Data visualisation

Quickstart

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

PreviousData visualisationNextDashboards

Last updated 1 year ago

Was this helpful?

You can manage charts using and . 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 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 object for a quick reference.

Chart edition

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

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

  3. Edit the JSON and preview your changes.

By API

Step 1: Configure authentication

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

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 user points 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

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

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 !

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

See the object for a quick reference.

This quickstart guide uses the authentication method. Choose and configure your own authentication method. For more information, see .

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

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

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

in the query tool
the query tool
edit dashboards in the UI
in the query tool
Authentication
OTQL queries
activities analytics queries
Chart
DashboardRegistration
DashboardContent
DashboardContent
Dashboard advanced mode
Chart advanced mode
Creating a query
Long term access tokens