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
  • REST resources
  • Dashboard registration
  • List all dashboard registrations for a specific organisation
  • Create a dashboard registration.
  • Edit a dashboard registration
  • Get a specific dashboard registration
  • Delete a dashboard registration
  • Dashboard content
  • Get the content of a dashboard. Returns a DashboardContentWrapper.
  • Edit the content of a dashboard with the specified DashboardContent.
  • DashboardRegistration
  • DashboardContentWrapper
  • DashboardContent
  • Filter
  • Section
  • Card
  • Chart

Was this helpful?

Export as PDF
  1. Data visualisation

Reference

PreviousCookbookNextAudience segmentation

Last updated 1 year ago

Was this helpful?

REST resources

Dashboard registration

Dashboard registration endpoints let you manage dashboards and where they are displayed. Those endpoint usually take or return objects.

List all dashboard registrations for a specific organisation

GET https://api.mediarithmics.com/v1/dashboards?organisation_id=:organisation_id

Returns a of objects.

Create a dashboard registration.

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

Receives a object as body.

Edit a dashboard registration

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

Receives a object as body.

Get a specific dashboard registration

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

Delete a dashboard registration

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

Dashboard content

Dashboard content endpoints let you manage the sections, cards and charts in a specific dashboard.

Get the content of a dashboard. Returns a DashboardContentWrapper.

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

Edit the content of a dashboard with the specified DashboardContent.

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

DashboardRegistration

This object represents a dashboard and where it should be displayed.

JSON representation
{
    "title": String,
    "scopes": [Scope]
    "segment_ids": [String],
    "builder_ids": [String],
    "archived": Boolean,
    "dashboard_content_id": String,
    "organisation_id": String,
    "community_id": String,
    // Readonly fields
    "created_ts": Timestamp,
    "created_by": String,
    "last_modified_ts": Timestamp,
    "last_modified_by": String
}

Fields

title string

The title of the dashboard, as displayed in the UI

scopes[] enum(home,segments,builders)

The list of scopes where the dashboard is visible. Mandatory, but can be an empty array.

segment_ids[] string

When scopes property contains segments, you can specify a list of segment IDs to only display the dashboard on those specific segments. Mandatory, but can be an empty array.

builder_ids[] string

When scopes property contains builders, you can specify a list of standard segment builder IDs to only display the dashboard on those specific builders. Mandatory, but can be an empty array.

archived boolean

Set to true to hide a dashboard from the UI without deleting it.

dashboard_content_id string

community_id string

ID of the community on which the dashboard is visible.

organisation_id string

ID of the organisation on which the dashboard is visible. Must be on the community_id community.

created_ts timestamp

When the dashboard registration was created. ReadOnly.

created_by user ID

By who the dashboard registration was created. ReadOnly.

last_modified_ts timestamp

When the dashboard registration was last modified. Not updated when dashboard content is updated as DashboardContent object has its own created_ts field. ReadOnly.

last_modified_by user ID

By who the dashboard was last modified. Not updated when dashboard content is updated as DashboardContent object has its own created_by field. ReadOnly.

DashboardContentWrapper

This object is returned when doing a GET request to get the content of a dashboard. It returns useful metadata as well as dashboard's content

JSON representation
{
    "id": String,
    "content": DashboardContent
    "organisation_id": String,
    "created_ts": Timestamp,
    "created_by": String
}

Fields

id string

Dashboard's JSON representation.

organisation_id string

ID of the organisation on which the dashboard is visible.

created_ts timestamp

When the dashboard content was created. ReadOnly.

created_by user ID

By who the dashboard content was created. ReadOnly.

Each time you do a PUT request to update a dashboard's content, a new DashboardContentWrapper resource is created with a new ID, and the new resource is associated with the dashboard registration. That means the created_ts and created_by fields also represent the last_modified_ts and last_modified_by fields you are used to see.

DashboardContent

This object represents the sections, cards and charts displayed in a dashboard.

JSON representation
{
    "available_filters": [Filter]
    "sections": [Section]
}

The list of filters activated for the dashboard.

The list of sections inside a dashboard.

Filter

A filter is displayed at the top of a dashboard. The user can select a value and all the queries in the dashboard adapt to the selected value

JSON representation
{
    // Using technical names of compartments, segments or channels 
    // will result in IDs being automatically replaced by names in the UI
    "technical_name": String, 
    "title": String,
    "values_retrieve_method": 'Query', // Only available value at the moment
    // OTQL query to retrieve list of selectable values
    // Use a query string, not the ID of a query
    "values_query": String, 
    // How to adapt queries in the dashboard to the selected value(s)
    "query_fragments": [QueryFragment], 
    "multi_select": Boolean, // If the user can select multiple values
}

A query fragment tells the dashboard how to adapt each query to the value(s) selected by the user.

JSON representation
{
    // Any available data source such as 'activities_analytics' or 'OTQL'
    "type": String, 
    // Only for OTQL type, chooses which queries should be transformed
    // Select 'ActivityEvent' to transform queries FROM ActivityEvent
    "starting_object_type": String,
    // The query part to add 
    "fragment": String,
}

Section

A section gives you a title and a new grid to display cards.

JSON representation
{
    "title": String,
    "cards": [Card],
}

title string

The title of the section, displayed in the UI.

The list of cards to display in the section.

Card

A white zone in the section, that displays and organizes charts.

JSON representation
{
    "x": Int,
    "y": Int,
    "h": Int,
    "w": Int,
    "layout": "vertical" || "horizontal",
    "charts": [Chart],
}

x,y,h,w int

layout enum(vertical, horizontal)

Wether charts in the card will stack horizontally or vertically.

The list of charts to display in the card.

Chart

A chart displayed in a card.

JSON representation
 {
    "title": String,
    "type": "Pie" || "Bars" || "Radar" || "Metric" || "Area", 
    "dataset": Dataset,
    "options": PieOptions || BarsOptions || RadarOptions || MetricOptions || AreaOptions
}

title string

The chart's title, displayed in the UI.

type enum(Pie, Bars, Radar, Metric)

The type of chart to display

colors[] string

Optional. You can use this property to override default chart colors, which are defined by the theme of the site. Define as many color codes (in #FFFFFF format) as needed by the chart.

dataset object(Dataset)

How to get data for the chart

Optional. Options specific to the type of chart that has been selected.

Returns a object.

Identifier of the that's been associated with the dashboard registration.

Content's identifier, used in to associate a dashboard and its content.

content object()

available_filters[] object()

sections[] object()

cards[] object()

The position of the card in the section's grid. See for a guide on how to use it.

charts[] object()

options object(, , , , )

For more information on the different chart types and there options, see .

For more information on how datasets are built, see .

Sections, cards and charts
Charts
Datasets and data sources
DashboardRegistration
DashboardContentWrapper
DashboardRegistration
DashboardContent
Filter
Section
Card
Chart
DashboardRegistration
DashboardRegistration
DashboardRegistration
DashboardRegistration
paginated resource list wrapper
PieOptions
BarsOptions
RadarOptions
MetricOptions
AreaOptions