Reporting dashboards and targets
Retrieve dashboard-group metadata
/a/ReportDashboardGroup_getMeta
Load a group’s stored metadata, including sharing and dashboard-mode configuration.
When to use this endpoint
Load the saved dashboard/group configuration first, then send this edit from its settings or layout controls. Re-read the configuration after an uncertain write: the handler reports validation, permission, lookup, and write failures as application errors.
Authentication and permissions
Authenticate with signed API-key fields or a logged-in CRM session. All lookups and writes are tenant-local.
Only owned or effectively view/edit-shared groups and their active widgets can be read. A group can be copied when it is readable. None disables its share array; otherwise string user IDs or All grant that share. No reporting-feature or additional CRM2 page-role check is applied.
For signed form requests, sign numeric scalar values as strings, including values inside native nested arrays. Send JSON text only for parameters explicitly accepting JSON strings; see Getting started.
These reporting handlers require tenant schema upgrade 794 before deployment. No request path creates or repairs schema.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | Integer-compatible | Yes | Positive integer ID in the authenticated tenant. Malformed, fractional, zero, or negative values are rejected; deleted records are unavailable. |
Example request
$result = FM_api('ReportDashboardGroup_getMeta', ['id'=> '12']);Example response
{"ok":"1","meta":"{\"sharedUser\":[\"7\"],\"sharedUserEdit\":[\"7\"],\"isNew\":1}"}Errors and unusual responses
| Response | Condition |
|---|---|
{"error":"not logged in"} | No authenticated tenant context is available. Invalid signed credentials can be rejected by the dispatcher before the handler runs. |
{"error":"report group is not existing."} | The group count lookup finds no row. |
{"error":"missing or invalid parameter: id"} | Required id is absent or invalid. |
{"error":"no permission to access api"} | The group is not readable/editable, or the operation requires ownership and the caller is not its owner. |
Legacy application errors may be returned with HTTP 200. Check the decoded response for error, not only the HTTP status.
Behaviour and edge cases
- Only readable active group metadata is returned. Meta is serialized JSON text or SQL NULL, not a decoded object; parse it before editing.
Side effects
- Read-only; no records or edit timestamps are changed.
See it in Fieldmotion
CRM1
The report dashboard configuration loads group metadata for editing. Filter browser Network requests for ReportDashboardGroup_getMeta.
CRM2
Dashboard group settings and sharing dialogs load metadata before saving a patch. Filter browser Network requests for ReportDashboardGroup_getMeta.
Related endpoints
ReportDashboardGroups_listfinds groups visible to the current user.ReportDashboards_listloads stored widget configuration.ReportDashboardGroup_setMetaedits group metadata and sharing.