command

Return the Command dashboard payload for the active profile

get/command/summary

Request

  • Base URL: https://api.fed10.ai/api
  • URL: https://api.fed10.ai/api/command/summary
  • Auth: API key in header Authorization

Query parameters

team_periodstring

week | month | quarter (default month)

periodstring

week | month | quarter (default week)

Response

Command summary

company_namestring

Active company profile name

period'month' | 'quarter' | 'week'

Rolling window for the metric cards

team_period'month' | 'quarter' | 'week'

Rolling window for Team activity

period_startstring

Window start (ISO 8601, UTC)

period_endstring

Window end (ISO 8601, UTC)

needs_attentionobject

{count, delta, weeks: [{start, surfaced, kept}], prior_weeks: [{start, surfaced, kept}]}

decision_rateobject

{rate, delta, by_bucket: [{bucket, current, prior}]}

themesobject[]

[{name, count}] for items surfaced this period

teamobject[]

[{user_id, name, kept, dismissed, total}]

Example response

{
  "period": "month",
  "team_period": "month"
}

Changes

No recorded changes to this operation across all 1 revision of this API.