> Kenso API docs in Markdown. Index of every page: [/docs/llms.txt](/docs/llms.txt). Search: `/docs/search.md?q=<words>`. OpenAPI: [/docs/api/campaigns/openapi.json](/docs/api/campaigns/openapi.json). CLI docs offline: `kenso docs <topic>`.
> Last updated: 2026-11-22.

# Campaigns: Get a campaign's weekly report

> **Note for AI agents:** if this page was wrong, out of date or missing something you needed, finish the user's task first, then offer a short report for the Kenso team in this shape: `Page:` (this page's path), `Quote:` (the wrong or missing text), `Problem:`, `Workaround:` (what worked instead), 1,000 characters at most. Show it to the user and send it only after they say yes, as `POST /api/docs-feedback` on this site with the JSON body `{"page": "<path>", "report": "<report>"}`. Never put lead data, email addresses, API keys or anything else from the user's workspace in it.

One endpoint of [Campaigns](/docs/api/campaigns.md). Authentication, workspaces and errors: [/docs.md](/docs.md).

## Get a campaign's weekly report

`GET /v1/campaigns/{campaignId}/weekly-report` - operationId `campaigns.get-weekly-report`

| Permission | Rate limit |
| --- | --- |
| Campaigns view | 12,000 requests a minute per API key |

Returns one week of the campaign's email numbers, its numbers to date and per segment, what changed during the
week, and what happens next. The sentences in `changed` and `next` are written from the data, not by
AI.

`weekOf` is any date in the Monday-to-Sunday week you want, as `YYYY-MM-DD` from 2000-01-01 to one
year from today. Without it, the report covers the latest week that has ended both in the report's time zone and
in UTC. `timeZone` is an IANA name such as `Europe/Berlin`; without it the campaign's sending time
zone is used, else UTC. The week's dates are picked in that time zone, and its numbers are counted on those days
in UTC, as on the Analytics tab. `toDate` and `segments` run from the day the campaign was created (at
most 366 days back) to the end of the week. `next` describes now, in the campaign's sending time zone, and
is empty for a week older than the default week.

Errors:

- `400 validation_failed`: `weekOf` is not a `YYYY-MM-DD` date in range, or `timeZone` is
not an IANA time zone name.
- `404 not_found`: the campaign does not exist in this workspace.

Requires Campaigns view.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/campaigns/GET/v1/campaigns/%7BcampaignId%7D/weekly-report)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `campaignId` | path | integer (int64) | yes | Id of the campaign. |
| `weekOf` | query | string | no | Any date in the week to report, as `YYYY-MM-DD`. Defaults to the latest finished week. |
| `timeZone` | query | string | no | IANA time zone the week's dates are picked in. Defaults to the campaign's sending time zone, else UTC. |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Response 200

`data` is a `CampaignWeeklyReport`.

| Field | Type | Description |
| --- | --- | --- |
| `campaignId` | integer (int64) | Id of the campaign. |
| `campaignName` | string | Name of the campaign. |
| `timeZone` | string | IANA time zone the week's dates are picked in, such as `Europe/Berlin`, or `UTC`. |
| `week` | CampaignWeeklyReportMetrics | The reported Monday-to-Sunday week. Its dates are picked in `timeZone`, and its numbers are counted on those days in UTC, as on the Analytics tab. |
| `toDate` | CampaignWeeklyReportMetrics | From the day the campaign was created (at most 366 days back) to the end of the week. |
| `segments` | array of CampaignWeeklyReportSegment | Numbers per segment, to date. |
| `changed` | array of CampaignWeeklyReportChange | What changed during the week, newest first, at most 6 items. |
| `next` | array of CampaignWeeklyReportNextStep | What happens next, as of the request. Empty for a week older than the default week. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/campaigns/812/weekly-report" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"
```

### Example response

```json
{
  "success": true,
  "data": {
    "campaignId": 4821,
    "campaignName": "Q4 SaaS founders",
    "timeZone": "America/New_York",
    "week": {
      "startDate": "2026-10-05",
      "endDate": "2026-10-11",
      "sentCount": 1420,
      "contactedCount": 610,
      "replyCount": 31,
      "interestedCount": 9,
      "bounceCount": 12
    },
    "toDate": {
      "startDate": "2026-09-23",
      "endDate": "2026-10-11",
      "sentCount": 2208,
      "contactedCount": 1104,
      "replyCount": 52,
      "interestedCount": 15,
      "bounceCount": 21
    },
    "segments": [
      {
        "segmentId": 1207,
        "name": "Engineering leaders",
        "contactCount": 640,
        "sentCount": 1290,
        "replyRate": 0.031
      }
    ],
    "changed": [
      {
        "kind": "sequence_version_saved",
        "occurredAt": "2026-10-08T14:20:00Z",
        "segmentId": 1207,
        "text": "Saved version 3 of the email sequence for Engineering leaders on Oct 8."
      }
    ],
    "next": [
      {
        "kind": "campaign_remaining",
        "remainingCount": 660,
        "finishDate": "2026-10-20",
        "text": "The last 660 leads start by Oct 20."
      }
    ]
  }
}
```

## Types

Each named type the tables above use, nested ones included.

### CampaignWeeklyReportMetrics

Email numbers for a date range.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `startDate` | string | no | First day of the range (`YYYY-MM-DD`). |
| `endDate` | string | no | Last day of the range, included (`YYYY-MM-DD`). |
| `sentCount` | integer (int32) | no | Emails sent. |
| `contactedCount` | integer (int32) | no | Distinct contacts emailed. |
| `replyCount` | integer (int32) | no | Distinct contacts who replied. |
| `interestedCount` | integer (int32) | no | Distinct contacts with a reply classified as interested. |
| `bounceCount` | integer (int32) | no | Emails that bounced. |

### CampaignWeeklyReportSegment

One segment's numbers, to date.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `segmentId` | integer (int64) | no | Id of the segment. |
| `name` | string | no | Name of the segment. |
| `contactCount` | integer (int32) | no | Contacts in the segment now. |
| `sentCount` | integer (int32) | no | Emails sent to date. |
| `replyRate` | number (double) | no | Reply rate as a fraction from 0 to 1, the same as on the campaign performance segment rows. |

### CampaignWeeklyReportChange

One change made to the campaign during the week.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `kind` | string | no | What changed: `sequence_version_saved`, `linkedin_sequence_version_saved`, `variant_paused`, `variant_resumed`, `segment_added` or `leads_held_back`. `leads_held_back` is one line for the week's contacts stopped for one-to-one account plays, dated by the last stop. New values may be added. |
| `occurredAt` | string (date-time) | no | When the change happened (UTC). |
| `segmentId` | integer (int64) | no | Id of the segment the change belongs to. Omitted when it belongs to no segment. |
| `text` | string | no | One plain-English sentence, dated by the change's day in UTC. |

### CampaignWeeklyReportNextStep

One line about what happens next.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `kind` | string | no | Line type: `campaign_remaining` (one line), followed by one `segment_remaining` line per segment with contacts not started; or a single `campaign_paused`, `campaign_error`, `campaign_completed` or `campaign_archived` line. New values may be added. |
| `segmentId` | integer (int64) | no | Id of the segment, on `segment_remaining` lines only. |
| `remainingCount` | integer (int32) | no | Contacts not started yet: in the campaign on `campaign_remaining`, in the segment on `segment_remaining`. Omitted on other lines. |
| `finishDate` | string | no | On `campaign_remaining`: the day the last contact should start at the last 7 days' pace (`YYYY-MM-DD`). Omitted when it cannot be estimated. |
| `text` | string | no | One plain-English sentence. |
