Skip to main content

​
What are insights?

Insights are read-only, workspace-scoped analytics derived from your own submissions, issues, and processing jobs. They answer questions like how many assets did we process this month, which rules trip most often, what share of submissions pass clean, and how much review time are we saving. The workspace is implicit — every insights request is scoped to the workspace behind your API key, so there is no workspace parameter to pass.
Sandbox submissions are excluded from every insights metric. Sandbox keys are for integration testing only, so their canned results never count toward your workspace’s counts, rates, or durations.

​
Endpoints

Each metric is its own endpoint, so an endpoint’s query parameters apply to exactly the stat it returns (no parameter that quietly does nothing).
EndpointReturnsParams
GET /insights/assets/countassets created per daydays, sidekickId
GET /insights/assets/by-typeasset distribution by file typesidekickId
GET /insights/assets/violation-rateshare of assets with issues, per daydays, sidekickId
GET /insights/issues/by-severityissue counts by severity, per daydays, sidekickId
GET /insights/issues/by-sidekickissues grouped by sidekickdays
GET /insights/issues/by-file-typeissues grouped by file typedays, sidekickId
GET /insights/submissions/pass-rateclean-completion rate, per daydays, sidekickId
GET /insights/submissions/by-file-type-sidekicksuccess/failure by type × sidekickdays
GET /insights/rules/top-violationsmost-triggered rule codesdays, limit, sidekickId
GET /insights/processing/durationduration avg + percentilesdays, sidekickId
GET /insights/processing/time-savedestimated review time saveddays, sidekickId, manualBaselineSeconds
All paths are prefixed with /api/integrations.

​
Parameters

  • days — size of the rolling window, 1–365 (default 28). Trend series return one point per day in the window, with empty days filled as zero.
  • sidekickId — narrows a metric to a single sidekick. Only present on the endpoints where it applies; by-sidekick and by-file-type-sidekick already group by sidekick, so they don’t take it.
  • limit — caps top-violations, 1–50 (default 10).
  • manualBaselineSeconds — the manual-review baseline for the time-saved calculation, default 300. Time saved per asset is max(0, manualBaselineSeconds − averageProcessingSeconds).

​
Example

curl -H "X-API-Key: your-api-key-here" \
  "https://mm-midmarket-integrations-api-preview.azurewebsites.net/api/integrations/insights/rules/top-violations?days=30&limit=5"

[
  { "ruleCode": "RULE_A", "count": 9 },
  { "ruleCode": "RULE_B", "count": 4 }
]

​
Notes

  • All counts and rates reflect live data for your workspace — no collection or opt-in step is required — and exclude sandbox submissions.
  • Processing-duration and time-saved are computed per asset, from the time each asset spends in processing (start to completion). Assets still in flight are excluded until they finish.
  • For high-frequency dashboards, cache responses for a short interval — these are daily rollups, so a few seconds of staleness is usually acceptable.