Reference
Last updated
Was this helpful?
Last updated
Was this helpful?
Dashboard registration endpoints let you manage dashboards and where they are displayed. Those endpoint usually take or return objects.
GET
https://api.mediarithmics.com/v1/dashboards?organisation_id=:organisation_id
Returns a of objects.
POST
https://api.mediarithmics.com/v1/dashboards
Receives a object as body.
PUT
https://api.mediarithmics.com/v1/dashboards/:id?organisation_id=:organisation_id
Receives a object as body.
GET
https://api.mediarithmics.com/v1/dashboards/:id?organisation_id=:organisation_id
DELETE
https://api.mediarithmics.com/v1/dashboards/:id?organisation_id=:organisation_id
Dashboard content endpoints let you manage the sections, cards and charts in a specific dashboard.
GET
https://api.mediarithmics.com/v1/dashboards/:id/content?organisation_id=:organisation_id
PUT
https://api.mediarithmics.com/v1/dashboards/:id/content?organisation_id=:organisation_id
This object represents a dashboard and where it should be displayed.
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.
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
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.
This object represents the sections, cards and charts displayed in a dashboard.
The list of filters activated for the dashboard.
The list of sections inside a dashboard.
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
A query fragment tells the dashboard how to adapt each query to the value(s) selected by the user.
A section gives you a title and a new grid to display cards.
title
string
The title of the section, displayed in the UI.
The list of cards to display in the section.
A white zone in the section, that displays and organizes charts.
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.
A chart displayed in a card.
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 .