Menu

Dashboards

2 endpoints in the Mattering Analytics API.

GET dashboards User APIService tier

Dashboards in the caller's org. Query: ``q`` (name contains), ``limit``, ``offset``.

URL

  • User APIhttps://analytics.mattering.io/api/user/v1/dashboards
  • Service tierhttps://analytics.mattering.io/api/internal/v1/dashboards

Query parameters

NameDefault
qnone
searchnone

Pagination

Accepts limit and offset. The response meta carries total, limit and offset.

Responses

200 data and meta envelope

{
  "data": [
    "..."
  ],
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0,
    "returned": 0,
    "has_more": true
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Example

curl -X GET "https://analytics.mattering.io/api/user/v1/dashboards?q=...&search=..." \
  -H "Authorization: Bearer $MATTERING_API_KEY"

Source: AnalyticsCore/api.py (api.list_dashboards)

GET dashboards/{public_id} User APIService tier

One dashboard with its tiles.

Default tile rows are compact (id, title, viz_type, dataset); full=1 adds spec / options / layout. include=data evaluates every tile in this call and adds result per tile (or error for a tile that cannot be evaluated), so a reader needs one request instead of 1 + N.

URL

  • User APIhttps://analytics.mattering.io/api/user/v1/dashboards/{public_id}
  • Service tierhttps://analytics.mattering.io/api/internal/v1/dashboards/{public_id}

Path parameters

NameType
public_idstr

Query parameters

NameDefault
fullnone
includenone

Responses

200 data and meta envelope

{
  "data": "...",
  "meta": {
    "view": "full"
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Example

curl -X GET "https://analytics.mattering.io/api/user/v1/dashboards/PUBLIC_ID?full=...&include=..." \
  -H "Authorization: Bearer $MATTERING_API_KEY"

Source: AnalyticsCore/api.py (api.get_dashboard)

All Analytics resources
Start Free Explore our Products