Skip to content
GitmoapAPIBeta
Schema

ScopeInsights

Activity and delivery insights for a repository or group over a time window: totals, averages, a time series and the DORA metrics.

Shape

  • doraDoraSummary
    • The DoraSummary schema
    • unavailableobjectFor each metric above that is never reported, its field name and the reason — as opposed to a metric that is null only because this window had no data.
    • change_failure_rateRatePair or nulloptionalNot reported: it needs deployment records. unavailable gives the reason.
    • merge_lead_time_seconds_p50number · double or nulloptionalThe median time from a merge request's creation to its merge, in seconds. Narrower than commit-to-production lead time.
    • release_frequency_per_weeknumber · double or nulloptionalPublished, non-draft releases per week over the window.
    • time_to_restore_secondsnumber · double or nulloptionalNot reported: it needs to know when service was degraded. unavailable gives the reason.
  • fromstring
  • granularityGranularitydayweekmonthHow a series is bucketed.
  • meansInsightMeans
    • The InsightMeans schema
    • run_duration_secondsnumber · double or nulloptional
    • time_to_first_review_secondsnumber · double or nulloptional
    • time_to_merge_secondsnumber · double or nulloptional
  • scopeActivityScope
  • seriesarray of InsightBucket
    • The InsightBucket schema
    • datestring
    • issues_closedinteger · int640–∞
    • issues_openedinteger · int640–∞
    • mrs_closedinteger · int640–∞
    • mrs_mergedinteger · int640–∞
    • mrs_openedinteger · int640–∞
    • pushesinteger · int640–∞
    • releases_publishedinteger · int640–∞
    • reviews_submittedinteger · int640–∞
    • runs_failedinteger · int640–∞
    • runs_succeededinteger · int640–∞
    • runs_totalinteger · int640–∞
  • tostring
  • totalsInsightTotals
    • The InsightTotals schema
    • active_contributorsinteger · int640–∞How many different people and service accounts contributed in the window.
    • issues_closedinteger · int640–∞
    • issues_openedinteger · int640–∞
    • mrs_closedinteger · int640–∞
    • mrs_mergedinteger · int640–∞
    • mrs_openedinteger · int640–∞
    • pushesinteger · int640–∞
    • releases_publishedinteger · int640–∞
    • reviews_submittedinteger · int640–∞
    • runsRunTotals
      • The RunTotals schema
      • failedinteger · int640–∞
      • succeededinteger · int640–∞
      • totalinteger · int640–∞
  • breakdown_truncatedbooleanoptionalWhether by_repository lists only the first 25 of the group's repositories. Absent when it lists them all.
  • by_repositoryarray of ScopeTotals or nulloptionalTotals per repository, for a group asked for with breakdown=repository; at most 25. breakdown_truncated says whether the group holds more.
    • The ScopeTotals schema
    • scopeActivityScope
    • totalsInsightTotals
      • The InsightTotals schema
      • active_contributorsinteger · int640–∞How many different people and service accounts contributed in the window.
      • issues_closedinteger · int640–∞
      • issues_openedinteger · int640–∞
      • mrs_closedinteger · int640–∞
      • mrs_mergedinteger · int640–∞
      • mrs_openedinteger · int640–∞
      • pushesinteger · int640–∞
      • releases_publishedinteger · int640–∞
      • reviews_submittedinteger · int640–∞
      • runsRunTotals
        • The RunTotals schema
        • failedinteger · int640–∞
        • succeededinteger · int640–∞
        • totalinteger · int640–∞

Example

Synthesized example
{
"dora": {
"unavailable": {},
"change_failure_rate": {
"denominator": 41,
"numerator": 32
},
"merge_lead_time_seconds_p50": 78,
"release_frequency_per_week": 48,
"time_to_restore_seconds": 7
},
"from": "from-77f5",
"granularity": "day",
"means": {
"run_duration_seconds": 35,
"time_to_first_review_seconds": 4,
"time_to_merge_seconds": 54
},
"scope": {
"full_path": "acme/payments-api",
"id": "id-4838",
"type": "group"
},
"series": [
{
"date": "date-dca4",
"issues_closed": 71,
"issues_opened": 37,
"mrs_closed": 85,
"mrs_merged": 13,
"mrs_opened": 56,
"pushes": 16,
"releases_published": 12,
"reviews_submitted": 5,
"runs_failed": 3,
"runs_succeeded": 33,
"runs_total": 2
}
],
"to": "to-1e42",
"totals": {
"active_contributors": 72,
"issues_closed": 31,
"issues_opened": 13,
"mrs_closed": 42,
"mrs_merged": 80,
"mrs_opened": 66,
"pushes": 37,
"releases_published": 87,
"reviews_submitted": 58,
"runs": {
"failed": 88,
"succeeded": 77,
"total": 5
}
},
"breakdown_truncated": false,
"by_repository": [
{
"scope": {
"full_path": "acme/payments-api",
"id": "id-eb7a",
"type": "group"
},
"totals": {
"active_contributors": 64,
"issues_closed": 14,
"issues_opened": 79,
"mrs_closed": 64,
"mrs_merged": 38,
"mrs_opened": 3,
"pushes": 82,
"releases_published": 12,
"reviews_submitted": 34,
"runs": {
"failed": 1,
"succeeded": 71,
"total": 0
}
}
},
{
"scope": {
"full_path": "acme/payments-api",
"id": "id-1415",
"type": "group"
},
"totals": {
"active_contributors": 20,
"issues_closed": 30,
"issues_opened": 9,
"mrs_closed": 12,
"mrs_merged": 64,
"mrs_opened": 4,
"pushes": 27,
"releases_published": 86,
"reviews_submitted": 5,
"runs": {
"failed": 61,
"succeeded": 61,
"total": 3
}
}
}
]
}

Graph

Used inside

No schema contains this one.

Used by