Digest

The workspace digest is a synthesized overview: what needs review, who's moving, top SEO opportunities, and coverage stats. It powers the dashboard Overview tab.

Get digest

GET /v1/workspaces/:id/digest?period=7d

curl "https://api.competiflow.com/v1/workspaces/42/digest?period=7d" \
  -H "Authorization: Bearer $COMPETIFLOW_API_KEY"

Response (200 OK):

{
  "digest": {
    "period": "7d",
    "generated_at": "2026-07-14T12:00:00Z",
    "generating": false,
    "needs_review": {
      "count": 3,
      "max_severity": "high",
      "items": [
        {
          "change_id": 901,
          "competitor": "Example Co",
          "summary": "Pro plan dropped from $99 to $79/mo",
          "severity": "high",
          "recommended_action": "Review positioning",
          "review_status": "unreviewed",
          "created_at": "2026-07-14T12:30:00Z"
        }
      ]
    },
    "this_week": {
      "bullets": [
        { "text": "Example Co cut Pro pricing by $20/mo", "change_ids": [901] }
      ]
    },
    "whos_moving": [
      {
        "competitor_id": 7,
        "name": "Example Co",
        "change_count": 4,
        "max_severity": "high",
        "sparkline": [0, 1, 0, 2, 1]
      }
    ],
    "top_opportunities": [
      {
        "change_id": 902,
        "competitor": "Rival Inc",
        "recommended_action": "Publish comparison content",
        "opportunity_score": 85
      }
    ],
    "coverage": {
      "competitors_count": 4,
      "monitors_total": 18,
      "monitors_healthy": 17,
      "monitors_failing": 1,
      "failing_monitor_ids": [105]
    },
    "consumption": {
      "pending": 3,
      "max_unreviewed_severity": "high",
      "reviewed_in_period": 12
    }
  }
}

Cold cache

When generating is true, the digest is being built in the background. Retry after a few seconds.

MCP equivalent

The MCP tool get_digest wraps this endpoint. See MCP server.