Skip to content
GitmoapAPIBeta
Schema

DashboardSummary

The counters a dashboard renders before its widgets load.

Shape

  • attentionAttentionCountsThe inbox badge, with its own truncated flag preserved for clients written against it.
    • The AttentionCounts schema
    • by_reasonobjectReasons with at least one pending item, keyed by the wire name.
    • pendinginteger · int64A capped count. When truncated, this is the cap and the client renders "99+".
    • truncatedboolean
  • authored_merge_requests_openinteger · int64
  • contributions_current_streakinteger · int64
  • count_capinteger · int64The ceiling each counter was computed under.
  • issues_assigned_openinteger · int64
  • namespacesarray of NamespaceSummaryView
    • The NamespaceSummaryView schema
    • full_pathstring
    • plan_tierPlanTierfreeproteamenterpriseThe subscription plan an organization is on, which sets its resource limits. From smallest to largest: free, pro, team, enterprise.
    • root_group_idGroupId (string · uuid)
    • storage_bytes_limitinteger · int640–∞
    • storage_bytes_usedinteger · int640–∞
    • storage_used_pctinteger · int32 or nulloptional0–∞Storage used as a percentage of the limit, rounded, at most 100. Absent when the plan has no storage limit, which is not the same as 0%.
  • onboarding_completeboolean
  • pipeline_runs_failed_7dinteger · int64
  • review_requests_pendinginteger · int64
  • truncatedarray of stringThe names of the counters that reached count_cap, whose values are therefore a minimum rather than the full count.

Example

Synthesized example
{
"attention": {
"by_reason": {},
"pending": 86,
"truncated": false
},
"authored_merge_requests_open": 69,
"contributions_current_streak": 59,
"count_cap": 1,
"issues_assigned_open": 53,
"namespaces": [
{
"full_path": "acme/payments-api",
"plan_tier": "free",
"root_group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"storage_bytes_limit": 51,
"storage_bytes_used": 78
},
{
"full_path": "acme/payments-api",
"plan_tier": "free",
"root_group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"storage_bytes_limit": 31,
"storage_bytes_used": 48
}
],
"onboarding_complete": false,
"pipeline_runs_failed_7d": 25,
"review_requests_pending": 40,
"truncated": [
"truncated-0839",
"truncated-754f"
]
}

Graph

Used inside

No schema contains this one.

Used by

Sent by 0 operations

No operation takes it as a request body.