Skip to main content

Dashboards - Test Widgets

Endpoint​

/o/dashboards/test

Overview​

Executes widget data loading for a provided widget array payload and returns the resulting widgets with calculated data.

Authentication​

This endpoint accepts requests without API authentication parameters.

Permissions​

This endpoint does not enforce dashboard access or role-based permission checks.

Request Parameters​

ParameterTypeRequiredDescription
widgetsJSON String (Array)NoJSON-stringified widget array. If invalid or missing, the handler proceeds with an empty array and returns [].

widgets Array Structure​

Each element should be a widget object similar to dashboard widget payloads.

Example decoded array:

[
  {
    "widget_type": "analytics",
    "feature": "core",
    "apps": ["6991c75b024cb89cdc04efd2"],
    "data_type": "session",
    "metrics": ["t"]
  }
]

Examples​

Test one analytics widget payload​

/o/dashboards/test?
  widgets=[
    {
      "widget_type":"analytics",
      "feature":"core",
      "apps":["6991c75b024cb89cdc04efd2"],
      "data_type":"session",
      "metrics":["t"]
    }
  ]

Response​

Success Response​

[
  {
    "widget_type": "analytics",
    "apps": ["6991c75b024cb89cdc04efd2"],
    "dashData": {
      "isValid": true,
      "data": {
        "6991c75b024cb89cdc04efd2": {
          "t": 2145
        }
      }
    }
  }
]

Response Fields​

FieldTypeDescription
[]ArrayRoot array of widget objects after processing.
[].widget_typeStringWidget type for the processed item.
[].appsArrayApp IDs for the widget.
[].dashDataObjectComputed data container for widget output.

Error Responses​

This handler does not define explicit structured error responses in normal flow; invalid widgets input typically yields an empty array.

Behavior​

Behavior Modes​

ModeTriggerProcessing PathResponse Shape
Process widgetsValid JSON widgets array providedParses widgets and runs widget data loading per entry.Raw array of processed widgets
Empty fallbackMissing or invalid widgets JSONContinues with empty widget array.Raw empty array

Impact on Other Data​

  • Read-only endpoint.

Limitations​

  • This endpoint does not enforce dashboard ownership or sharing checks.
  • Output structure depends on widget type and may vary across features.
Implementation details

Database Collections

This endpoint has no fixed collection list at handler level. Data reads depend on widget types passed in widgets and the data processors they trigger.