{"openapi":"3.0.4","info":{"title":"Kenso API: Analytics","version":"1.1","description":"The Analytics endpoints of the Kenso API, with every component they use. The full spec is https://api.ken.so/v1/docs/openapi.json. Every request sends `Authorization: Bearer <your API key>` and `Ken-Version: 2026-11-02`."},"servers":[{"url":"https://api.ken.so"}],"security":[{"Bearer":[]}],"tags":[{"name":"analytics","description":"Analytics reports how campaigns and sending perform over a date window: sends, opens, clicks, replies, interested\nreplies, bounces and meetings, split by day, step, segment, campaign or language. The deliverability reports cover\nyour domains and inboxes, with reputation, alerts and bounce limits. Every operation only reads, and each needs\nCampaigns view. Rates are fractions from 0 to 1, and days are UTC calendar days unless you pass an IANA\n`timeZone`.","x-displayName":"Analytics"}],"paths":{"/v1/analytics/campaign-performance":{"get":{"tags":["analytics"],"summary":"Get campaign performance","description":"Returns send, open, click, reply and bounce metrics for one campaign or the whole workspace over a window. The\nwindow totals are in `metrics`, and `rows` split them by `groupBy`.\n            \nPass `from` and `to`, both inclusive. With `campaignId` you can leave both out to get the campaign to\ndate: from its first send or first imported day, whichever is earlier, to today, at most 3660 days. The response's\n`from` and `to` hold the window used. A window you set is at most 366 days, or 3660 days with\n`groupBy=campaign`.\n`channel` is `email` (the default) or `linkedin`. The `linkedin` channel needs `campaignId`.\n            \n`groupBy` is one of:\n            \n- `day` (the default): one row per day.\n- `step`: one row per sequence step. Needs `campaignId`.\n- `segment`: one row per segment. Needs `campaignId`. On email, each row has `steps`: the segment's email steps in order, each with its sends, contacted, replies, interested replies, bounces and clicks, and one entry per version in `variants`. Opens and unsubscribes are not split by step and read 0. `steps` is omitted for a window over 90 days.\n- `sender_route`: email only, needs `campaignId`. One row per sender rule a contact's first email went out under: each provider rule (`key` is the provider, `label` its name), `everyone_else`, and `not_routed` for sends with no rules or with sender routing off. `routeKey` equals `key`.\n- `language`: needs `campaignId`. One row per language the campaign's emails went out in, sorted by sends, with `unknown` last for sends that recorded no language. The LinkedIn channel has no language rows.\n- `campaign`: email only, without `campaignId`. One row per campaign with email activity in the window, with `campaignId` on each row.\n            \nIn `sender_route` rows, each contact counts in one row only, with its sends, contacted, repliers, interested\nreplies and bounces. Opens, clicks, unsubscribes, `bounceBreakdown`, opportunities and meetings are not split\nby route, so they read 0 or are left out on the rows. A `language` row holds sends, contacted, replies,\ninterested and the reply rate over contacted. A reply counts in the language of the send it answers. Opens, clicks\nand bounces are not split by language. For both, the window `metrics` are the campaign's `groupBy=day`\ntotals, so the rows need not add up to them.\nA `campaign` row with a `timeZone` other than UTC matches that campaign's own `groupBy=day` read in\nthe same zone, so one call returns lifetime numbers for every campaign. With UTC, the rows add up UTC days, so a\ncontact active on several days counts once per day. `campaign` rows leave out the opportunity, meeting and\n`bounceBreakdown` fields, and the window `metrics` add up the rows.\nFor per-inbox numbers, call `GET /v1/analytics/deliverability` with `groupBy=inbox`.\n            \nDays are UTC calendar days unless `timeZone` is an IANA zone other than UTC. Then rows count that zone's days,\nfrom its midnight on `from` to its midnight after `to`, and the window `metrics` add up the day rows.\nFor one campaign, unique opens and unique clicks still count each contact once over the whole window. Imported\nhistory and days before 2026-08-24 stay on UTC days. A segment row's opens and unsubscribes also stay on UTC days.\n            \n`openCount`, `uniqueOpenCount` and `openRate` count human opens. Opens are an estimate and a floor,\nso use reply rate as the headline number. `clickCount` counts human clicks on links Kenso tracks.\nThe opportunity fields appear only when the workspace has the `opportunities` feature and you have Accounts\nview.\n            \nTo read one campaign several ways in one call, pass `views` with `campaignId`, `from` and\n`to`. The response is the `groupBy=day` email read, and `views` in it holds one more read per name,\neach equal to what its own call returns:\n            \n- `previous`: the same read over the window of the same length that ends the day before `from`.\n- `linkedin`: `channel=linkedin` by day. `linkedin_previous`: the same over the previous window.\n- `segment`, `language`, `sender_route`: that `groupBy` on email over the window.\n            \nA view that could not be read is left out and named in `views.errors`, and the rest of the response stands.\n            \nErrors:\n            \n- `400 validation_failed`: the window, `groupBy`, `channel`, `timeZone` or `views` is not valid, or the `groupBy`, channel or `views` needs a `campaignId`.\n- `404 not_found`: the campaign is not in the workspace.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"analytics.get-campaign-performance","parameters":[{"name":"campaignId","in":"query","description":"The campaign to report on. Omitted reports the whole workspace, on the email channel only.","schema":{"type":"integer","format":"int64"}},{"name":"from","in":"query","description":"First day of the window, an ISO 8601 date such as `2026-10-01`. Send it with `to`, or leave both out with\n`campaignId` to report the campaign to date.","schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","description":"Last day of the window, inclusive, an ISO 8601 date on or after `from`. The window spans at most 366 days, or\n3660 days when `groupBy` is `campaign`.","schema":{"type":"string","format":"date-time"}},{"name":"groupBy","in":"query","description":"How to split the rows: `day` (default), `step`, `segment`, `sender_route`, `language` or\n`campaign`. Every value except `day` and `campaign` needs `campaignId`, and `campaign` takes none.","schema":{"type":"string"}},{"name":"channel","in":"query","description":"The channel to report: `email` (default) or `linkedin`. `linkedin` needs `campaignId`, and the\n`groupBy` values `campaign` and `sender_route` work on email only.","schema":{"type":"string"}},{"name":"timeZone","in":"query","description":"IANA time zone whose calendar days the window and day rows use, such as `America/New_York`. Default UTC.","schema":{"type":"string"}},{"name":"views","in":"query","description":"Extra reads of the same campaign to return in `views`, comma-separated: `previous`, `linkedin`,\n`linkedin_previous`, `segment`, `language` and `sender_route`. Needs `campaignId`,\n`from` and `to`, with `groupBy` `day` and `channel` `email` (the defaults).","schema":{"type":"string"}},{"name":"Ken-Version","in":"header","description":"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.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"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`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignPerformanceResponse"}}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","validation_failed","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["rate_limited"]}},"x-ken-permission":{"kind":"page","page":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}}},"/v1/analytics/engagement":{"get":{"tags":["analytics"],"summary":"Get campaign engagement","description":"Ranks one campaign's clicks on tracked links by a dimension, such as device or country, most clicks first.\n            \n`campaignId`, `from` and `to` are required, and the window is at most 366 days.\n`dimension` is `device` (the default), `browser`, `os`, `country`, `region`,\n`city`, `referrer`, `network`, `link` or `source`. `limit` caps the rows, from 1 to\n200, default 50.\nThe `device`, `browser`, `os`, `country`, `city` and `link` rows count human clicks.\nThe `region`, `referrer`, `network` and `source` rows count every click and split it into\n`humanCount` and `botCount`.\n`country` narrows the `city` dimension to one country. `segmentId` narrows the `region`,\n`referrer`, `network` and `source` dimensions to one segment.\n            \nErrors:\n            \n- `400 validation_failed`: `campaignId`, `from` or `to` is missing, the window is too long, or `dimension` or `limit` is not valid.\n- `404 not_found`: the campaign is not in the workspace.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"analytics.get-engagement","parameters":[{"name":"campaignId","in":"query","description":"The campaign to break down. Required.","schema":{"type":"integer","format":"int64"}},{"name":"from","in":"query","description":"First day of the window, an ISO 8601 date such as `2026-10-01`. Required.","schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","description":"Last day of the window, inclusive, an ISO 8601 date. Required, on or after `from` and at most 366 days later.","schema":{"type":"string","format":"date-time"}},{"name":"dimension","in":"query","description":"What to rank by: `device` (default), `browser`, `os`, `country`, `region`, `city`,\n`referrer`, `network`, `link` or `source`.","schema":{"type":"string"}},{"name":"country","in":"query","description":"Only clicks from this country, for the `city` dimension. Use a `key` from the `country` dimension's rows.","schema":{"type":"string"}},{"name":"segmentId","in":"query","description":"Only clicks from this segment of the campaign. Applies to the `region`, `network`, `referrer` and `source` dimensions.","schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","description":"Most rows to return, from 1 to 200. Default 50.","schema":{"maximum":200,"minimum":1,"type":"integer","format":"int32","default":50}},{"name":"Ken-Version","in":"header","description":"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.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"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`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngagementResponse"}}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","validation_failed","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["rate_limited"]}},"x-ken-permission":{"kind":"page","page":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}}},"/v1/analytics/deliverability":{"get":{"tags":["analytics"],"summary":"Get workspace deliverability","description":"Returns the workspace's sending health over a window: sends, replies, bounces, clicks and spam complaints, with\ninbox and domain counts. Split it by day, by domain or by inbox.\n            \n`from` and `to` are required, and the window is at most 366 days. `groupBy` is `day` (the\ndefault), `domain` or `inbox`. `limit` caps the domain and inbox rows, from 1 to 200, default 50.\nDays are UTC calendar days. With an IANA `timeZone` other than UTC, the rows count sends, replies, bounces and\nout-of-office replies on that zone's days, from its midnight on `from` to its midnight after `to`. The\nwindow `sentCount`, `replyCount`, `bounceCount`, `clickCount` and rates are then the sums of\nthe day rows. Complaints always stay on UTC days, because Kenso stores them per UTC day.\n            \nDomain and inbox rows carry `reputation` and `alerts`. Kenso builds the alerts from send pauses,\nblocklists, SPF, DKIM and DMARC checks, placement tests, complaints and recipient refusals. Inbox rows also get\nalerts from bounce rates, Microsoft tenant bans and sender rejections, plus their domain's alerts. Reputation and\nalerts describe the state now: only the `complaint_rate` and `high_bounce_rate` alerts count the window.\n            \nErrors:\n            \n- `400 validation_failed`: `from` or `to` is missing, the window is too long, or `groupBy`, `limit` or `timeZone` is not valid.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"analytics.get-deliverability","parameters":[{"name":"from","in":"query","description":"First day of the window, an ISO 8601 date such as `2026-10-01`. Required.","schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","description":"Last day of the window, inclusive, an ISO 8601 date. Required, on or after `from` and at most 366 days later.","schema":{"type":"string","format":"date-time"}},{"name":"groupBy","in":"query","description":"How to split the rows: `day` (default), `domain` or `inbox`.","schema":{"type":"string"}},{"name":"timeZone","in":"query","description":"IANA time zone whose calendar days the window and rows use, such as `America/New_York`. Default UTC.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Most domain or inbox rows to return, from 1 to 200, default 50. Day rows are not capped.","schema":{"maximum":200,"minimum":1,"type":"integer","format":"int32","default":50}},{"name":"Ken-Version","in":"header","description":"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.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"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`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliverabilityResponse"}}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","validation_failed","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["rate_limited"]}},"x-ken-permission":{"kind":"page","page":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}}},"/v1/analytics/deliverability-gates":{"get":{"tags":["analytics"],"summary":"Get bounce limits","description":"Shows the bounce limits Kenso enforces, and where each domain and inbox stands against them over the last 24 hours.\nUse it to spot inboxes close to being blocked.\n            \nKenso counts accepted cold and one-to-one sends and hard bounces over the last 24 hours. It judges inbox rows by\nthe limit that blocks an inbox, and domain rows by the limit that pauses a campaign, because Kenso has no\ndomain-level bounce block.\nA row's `verdict` is `over` when its bounce rate is above `threshold` with at least `minSends`\nsends and `minBounces` hard bounces. It is `watch` when the row is not over but its rate is at least 80%\nof the threshold, and `ok` otherwise. A row with fewer sends than `minSends` has `isSmallSample`\ntrue and cannot be over.\nKenso itself judges over `enforcedWindowHours`. `isEnforced` is false while Kenso only records the\nlimits and does not block or pause.\nA mailbox with no managed domain counts toward the domain of its address. On a free-mail provider such as\ngmail.com, it has an inbox row only.\nRows come worst first.\n            \nErrors:\n            \n- `400 validation_failed`: `limit` is not from 1 to 200.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"analytics.get-deliverability-gates","parameters":[{"name":"limit","in":"query","description":"The most domain rows and the most inbox rows to return, from 1 to 200. Default 50.","schema":{"maximum":200,"minimum":1,"type":"integer","format":"int32","default":50}},{"name":"Ken-Version","in":"header","description":"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.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"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`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliverabilityGatesResponse"}}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","validation_failed","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["rate_limited"]}},"x-ken-permission":{"kind":"page","page":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}}},"/v1/analytics/reply-classifications":{"get":{"tags":["analytics"],"summary":"Get reply classifications","description":"Counts the people who replied in a window by how Kenso classified their replies. Classes are lowercase snake_case\nnames, such as `interested`.\n            \n`from` and `to` are required, and the window is at most 366 days. Replies count by when they arrived,\nfrom UTC midnight on `from` to UTC midnight after `to`. With an IANA `timeZone` other than UTC, the\nwindow runs from that zone's midnights instead, for the totals and the breakdowns alike.\nCounts are people, not messages. A contact counts once per row and in one class: `interested` if any of its\nmessages is, else the class of its latest reply, else the class of its latest message.\n`campaignId` and `segmentId` narrow the counts. `byCampaign` and `bySegment` add a breakdown\nper campaign or per segment.\n            \nErrors:\n            \n- `400 validation_failed`: `from` or `to` is missing, the window is too long, or `timeZone` is not valid.\n- `404 not_found`: the campaign is not in the workspace.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"analytics.get-reply-classifications","parameters":[{"name":"from","in":"query","description":"First day of the window, an ISO 8601 date such as `2026-10-01`. Required.","schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","description":"Last day of the window, inclusive, an ISO 8601 date. Required, on or after `from` and at most 366 days later.","schema":{"type":"string","format":"date-time"}},{"name":"campaignId","in":"query","description":"Only replies to this campaign.","schema":{"type":"integer","format":"int64"}},{"name":"segmentId","in":"query","description":"Only replies in this segment.","schema":{"type":"integer","format":"int64"}},{"name":"byCampaign","in":"query","description":"When `true`, adds a breakdown by campaign. Default `false`.","schema":{"type":"boolean"}},{"name":"bySegment","in":"query","description":"When `true`, adds a breakdown by segment. Default `false`.","schema":{"type":"boolean"}},{"name":"timeZone","in":"query","description":"IANA time zone whose midnights bound the window, such as `America/New_York`. Default UTC.","schema":{"type":"string"}},{"name":"Ken-Version","in":"header","description":"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.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"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`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplyClassificationsResponse"}}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","validation_failed","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["rate_limited"]}},"x-ken-permission":{"kind":"page","page":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}}},"/v1/analytics/query":{"post":{"tags":["analytics"],"summary":"Run an analytics query","description":"Runs a custom report: pick metrics, split them by up to two dimensions, filter them, and compare with the previous\nperiod. Use it when the fixed reports do not have the cut you need.\n            \n`metrics` holds 1 to 8 metric names. `groupBy` holds up to 2 dimensions. `filters` keeps only the\nlisted values of a dimension. `window` is a preset, or `from` and `to` dates at most 400 days apart.\n`limit` caps the rows, from 1 to 200, default 50, and `truncated` is true when more groups matched.\nA null dimension value is the Unknown group.\n            \nBy default (`rateBasis` `event_time`), Kenso counts a rate's numerator and denominator by when each event\nhappened, in the same window and group. A rate is then usually from 0 to 1, but can pass 1 in short windows, in\n`day` or `week` rows, or by `step`, when replies or accepts answer earlier sends. A rate is null when\nits denominator is 0.\nWith `rateBasis` `cohort`, Kenso counts each reply and accept against the send it answers, in that send's\ngroup and day, whenever it arrived. Replies, interested, not interested, accepted and their rates then stay within\nthe group's contacted and invites, from 0 to 1. Every row and the totals then carry `stillFilling`, true while\nmost of their sends are under 7 days old. Other counts use event time on both bases.\n            \nWith `compareTo` set to `previous_period`, Kenso runs the same query over the window of equal length just\nbefore, and returns it in `previousWindow` and in each `previous`. Rows grouped by `day` or\n`week` usually get `previous` null, because the earlier window holds other dates, so compare their totals.\nEach call counts against the workspace's analytics query limit: 60 per minute and 3,000 per day.\n            \nErrors:\n            \n- `400 validation_failed`: the body breaks a rule above. `error.details` has one entry per field.\n- `404 not_found`: a `campaignId` filter names a campaign that is not in the workspace.\n- `429 quota_exceeded`: the workspace used up its analytics query limit. Retry after `Retry-After`.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `generative_ui` feature on your workspace. Until it is on, calls answer 404.","operationId":"analytics.query","parameters":[{"name":"Ken-Version","in":"header","description":"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.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"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`.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsQueryRequest"}}}},"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsQueryResultResponse"}}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","validation_failed","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["quota_exceeded","rate_limited"]}},"x-ken-features":["generative_ui"],"x-ken-permission":{"kind":"page","page":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key","summary":"60 requests a minute and 3,000 a day per workspace (Free plan: 6 a minute and 300 a day)","quotas":[{"policy":"analyticsQueries","per":"workspace","limits":[{"limit":60,"windowSeconds":60},{"limit":3000,"windowSeconds":86400}],"plans":[{"plan":"Free","limits":[{"limit":6,"windowSeconds":60},{"limit":300,"windowSeconds":86400}]}]}]}}},"/v1/analytics/variant-performance":{"get":{"tags":["analytics"],"summary":"Get variant performance","description":"Compares the variants of each step in one campaign, so you can see which variant wins. The answer has the same\nshape as `POST /v1/analytics/query`, with the metrics `contacted`, `replies`, `interested`,\n`reply_rate` and `positive_reply_rate`, grouped by `step` and `variant`.\n            \n`campaignId` is required. `from` and `to` are inclusive calendar days in `timeZone`, at most 400\ndays apart. Leave both out for the campaign to date. `timeZone` defaults to the campaign's sending zone, else\nUTC.\nEach row counts distinct contacts. Replies come from the inbox. Out-of-office replies and other messages that are\nnot replies do not count. Each reply counts against the step and variant of the send it answers, whenever it\narrived, so replies and interested stay within `contacted` and the rates run from 0 to 1. A rate is null when\nnobody was contacted. Every row and the totals carry `stillFilling`, true while most of their sends are under 7\ndays old and replies to them are still arriving.\nEmail and LinkedIn rows both come back. LinkedIn rows read \"LinkedIn step N\" and \"LinkedIn variant X\". Contacts with\nno variant are in the Unknown row.\nEach call counts against the workspace's analytics query limit: 60 per minute and 3,000 per day.\n            \nErrors:\n            \n- `400 validation_failed`: `campaignId` is missing, or the window or `timeZone` is not valid.\n- `404 not_found`: the campaign is not in the workspace.\n- `429 quota_exceeded`: the workspace used up its analytics query limit. Retry after `Retry-After`.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `variant_performance` feature on your workspace. Until it is on, calls answer 404.","operationId":"analytics.get-variant-performance","parameters":[{"name":"campaignId","in":"query","description":"The campaign to report on. Required.","schema":{"type":"integer","format":"int64"}},{"name":"from","in":"query","description":"First calendar day of the window, as `YYYY-MM-DD`, inclusive. Send it with `to`, or leave both out to report\nthe campaign to date.","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","description":"Last calendar day of the window, as `YYYY-MM-DD`, inclusive. The window spans at most 400 days.","schema":{"type":"string","format":"date"}},{"name":"timeZone","in":"query","description":"IANA time zone the days are counted in, such as `America/New_York`. Default the campaign's sending time zone,\nelse UTC.","schema":{"type":"string"}},{"name":"Ken-Version","in":"header","description":"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.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"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`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsQueryResultResponse"}}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","validation_failed","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["quota_exceeded","rate_limited"]}},"x-ken-features":["variant_performance"],"x-ken-permission":{"kind":"page","page":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key","summary":"60 requests a minute and 3,000 a day per workspace (Free plan: 6 a minute and 300 a day)","quotas":[{"policy":"analyticsQueries","per":"workspace","limits":[{"limit":60,"windowSeconds":60},{"limit":3000,"windowSeconds":86400}],"plans":[{"plan":"Free","limits":[{"limit":6,"windowSeconds":60},{"limit":300,"windowSeconds":86400}]}]}]}}}},"components":{"securitySchemes":{"Bearer":{"type":"http","description":"Enter: Bearer {your Kenso API key}. Create one in the Kenso app under Settings > Integrations > API Keys.","scheme":"bearer","bearerFormat":"Opaque API key"}},"headers":{"RateLimit-Limit":{"description":"The request limit of the rate limit this request is closest to reaching: your plan's limit for this kind of call, your API key's own limit, or the operation's own limit, whichever has the fewest requests left.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"The requests left under that limit. `0` on a `429`.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"The seconds until that limit resets.","schema":{"type":"integer"}}},"schemas":{"AnalyticsQueryRequest":{"required":["metrics","window"],"type":"object","properties":{"metrics":{"type":"array","items":{"type":"string"},"description":"Required. 1 to 8 metrics: `contacted`, `sent`, `delivered`, `bounced`, `clicked`,\n`replies`, `interested`, `not_interested`, `unsubscribed`, `meetings`, `invites`,\n`accepted`, `reply_rate`, `positive_reply_rate`, `bounce_rate` or `acceptance_rate`."},"groupBy":{"type":"array","items":{"type":"string"},"description":"Up to 2 dimensions to group rows by: `campaign`, `segment`, `step`, `variant`, `channel`,\n`inbox`, `domain`, `seniority`, `function`, `title_group`, `industry`,\n`company_size`, `country`, `week`, `day` or `language`. Omit it to get only the totals.","nullable":true},"filters":{"type":"object","additionalProperties":{},"description":"Values to narrow the query, keyed by `campaignId`, `segmentId`, `inboxId`, `domainId` or a\ndimension name other than `week` and `day`. Each key takes a non-empty array of at most 100 values. Ids are\nnumbers or digit strings, `channel` takes `email` or `linkedin`, and other values are strings of at\nmost 200 characters.","nullable":true},"window":{"allOf":[{"$ref":"#/components/schemas/AnalyticsWindowInput"}],"description":"Required. The days the query covers: a preset, or a `from` and `to` date."},"compareTo":{"type":"string","description":"`previous_period` to also compute every metric over the window of the same length just before. Omit it to skip\nthe comparison.","nullable":true},"timeZone":{"type":"string","description":"The IANA time zone for days and weeks, such as `Europe/Berlin`. Defaults to the campaign's sending time zone when\nthe filters name exactly one campaign, else UTC.","nullable":true},"limit":{"type":"integer","description":"The most rows to return, from 1 to 200. Default 50.","format":"int32","nullable":true},"rateBasis":{"type":"string","description":"How replies and accepts are counted. `event_time` (the default) counts them in the window and group they arrived\nin, so a rate can pass 1. `cohort` counts each against the send it answers, with that send's group, so a rate\nstays from 0 to 1. Every other count uses event time on both bases.","nullable":true}},"additionalProperties":false,"description":"An analytics query: the metrics to compute, how to group and filter them, and over which window."},"AnalyticsQueryResult":{"type":"object","properties":{"window":{"allOf":[{"$ref":"#/components/schemas/AnalyticsWindow"}],"description":"The days the query covered."},"previousWindow":{"allOf":[{"$ref":"#/components/schemas/AnalyticsWindow"}],"description":"The days the comparison covered with `compareTo`. Always present, and null without `compareTo`."},"rows":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsQueryRow"},"description":"The groups, most contacted first, at most `limit`. Empty without `groupBy`."},"totals":{"allOf":[{"$ref":"#/components/schemas/AnalyticsQueryTotals"}],"description":"The whole window across every group."},"truncated":{"type":"boolean","description":"True when more groups matched than `limit` let through."},"asOf":{"type":"string","description":"When the query ran, in UTC.","format":"date-time"}},"additionalProperties":false,"description":"The answer to an analytics query."},"AnalyticsQueryResultResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/AnalyticsQueryResult"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"AnalyticsQueryRow":{"type":"object","properties":{"dimensions":{"type":"object","additionalProperties":{},"description":"The group's value for each `groupBy` dimension. A number for `campaign`, `segment`, `inbox`,\n`domain` and `step`, a string for the others, and null for values Kenso does not know."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"A display label for each dimension value, such as `Step 2`. A null value reads `Unknown`."},"metrics":{"type":"object","additionalProperties":{"type":"number","format":"double","nullable":true},"description":"The requested metrics, by name. Counts are whole numbers. Rates are fractions rounded to 6 decimals, and null when\ntheir base is 0."},"previous":{"type":"object","additionalProperties":{"type":"number","format":"double","nullable":true},"description":"The same metrics over the previous period with `compareTo`. Always present. Null without `compareTo`, and when\nthe group had no activity in the previous period.","nullable":true},"sample":{"type":"object","additionalProperties":{"type":"integer","format":"int64"},"description":"The counts behind the metrics: always `contacted`, `delivered`, `sent` and `bounced`, plus the\ncounts behind each requested rate, such as `replies` for `reply_rate` or `email_sent` for\n`bounce_rate`."},"stillFilling":{"type":"boolean","description":"Only with `rateBasis` `cohort`. True when more than half of the row's sends went out in the last 7 days, so\nreplies to them are still arriving.","nullable":true}},"additionalProperties":false,"description":"One group of the result, such as one campaign or one campaign and week."},"AnalyticsQueryTotals":{"type":"object","properties":{"metrics":{"type":"object","additionalProperties":{"type":"number","format":"double","nullable":true},"description":"The requested metrics, by name, as on a row."},"previous":{"type":"object","additionalProperties":{"type":"number","format":"double","nullable":true},"description":"The same metrics over the previous period with `compareTo`. Always present, and null without `compareTo`.","nullable":true},"sample":{"type":"object","additionalProperties":{"type":"integer","format":"int64"},"description":"The counts behind the metrics, as on a row."},"stillFilling":{"type":"boolean","description":"Only with `rateBasis` `cohort`: the row rule applied to the whole window.","nullable":true}},"additionalProperties":false,"description":"The whole window across every group, including values Kenso does not know."},"AnalyticsWindow":{"type":"object","properties":{"from":{"type":"string","description":"The first day, as `YYYY-MM-DD`.","format":"date"},"to":{"type":"string","description":"The last day, as `YYYY-MM-DD`.","format":"date"},"timeZone":{"type":"string","description":"The IANA time zone the days are in."}},"additionalProperties":false,"description":"The calendar days a query covered, both included, in its time zone."},"AnalyticsWindowInput":{"type":"object","properties":{"preset":{"type":"string","description":"`last_7_days`, `last_14_days`, `last_30_days`, `last_90_days` or `campaign_to_date`.\n`campaign_to_date` needs a `campaignId` filter with exactly one campaign.","nullable":true},"from":{"type":"string","description":"The first day, as `YYYY-MM-DD` in the query's time zone. From 2000-01-01 to 2100-12-31.","format":"date","nullable":true},"to":{"type":"string","description":"The last day, included, as `YYYY-MM-DD`. At most 400 days after `from`.","format":"date","nullable":true}},"additionalProperties":false,"description":"The days an analytics query covers: a preset, or a `from` and `to` date. Send one or the other."},"ApiKeyError":{"required":["error"],"type":"object","properties":{"error":{"type":"string","description":"A sentence for people that says what went wrong. It can change, so do not parse it."}},"additionalProperties":false,"description":"The body the API key check in front of the operations answered until November 2026, instead of the error body (`Failure`): `{ \"error\": \"Invalid or revoked API key\" }` on a `401`, `{ \"error\": \"Rate limit exceeded\" }` on a `429` and `{ \"error\": \"Authentication is temporarily unavailable\" }` on a `503`. It has no `code`, so branch on the HTTP status."},"CampaignPerformance":{"type":"object","properties":{"campaignId":{"type":"integer","description":"The campaign the numbers cover. Omitted when the call covered every campaign in the workspace.","format":"int64","nullable":true},"from":{"type":"string","description":"The start of the window, in UTC.","format":"date-time"},"to":{"type":"string","description":"The end of the window, in UTC.","format":"date-time"},"timeZone":{"type":"string","description":"The IANA time zone the call asked for. Omitted when none was sent, and days are then UTC days.","nullable":true},"groupBy":{"type":"string","description":"How `rows` are grouped: `day`, `step`, `segment`, `sender_route`, `language` or `campaign`."},"channel":{"type":"string","description":"The channel the numbers cover: `email` or `linkedin`."},"metrics":{"allOf":[{"$ref":"#/components/schemas/CampaignPerformanceMetrics"}],"description":"The window's totals. For a campaign imported from another tool, they can include bounces and unsubscribes that\nbelong to no day, so they can exceed the sum of the rows."},"rows":{"type":"array","items":{"$ref":"#/components/schemas/CampaignPerformanceRow"},"description":"One row per group, such as one per day for `groupBy=day`."},"views":{"allOf":[{"$ref":"#/components/schemas/CampaignPerformanceViews"}],"description":"The extra reads the call asked for with `views`. Omitted when it asked for none."}},"additionalProperties":false,"description":"A campaign's or the workspace's sending results over a window, as totals and grouped rows."},"CampaignPerformanceBounceBreakdown":{"type":"object","properties":{"hardCount":{"type":"integer","description":"Hard bounces: the address is permanently refused.","format":"int32"},"softCount":{"type":"integer","description":"Soft bounces: a temporary failure, such as a full mailbox.","format":"int32"},"unknownCount":{"type":"integer","description":"Bounces with no type signal. `hardCount`, `softCount` and `unknownCount` add up to every classified bounce.","format":"int32"},"byReason":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"Bounce counts keyed by reason, such as `invalidRecipient` or `policyBlocked`. Only reasons with a count above 0 appear."}},"additionalProperties":false,"description":"Bounces split by type and reason."},"CampaignPerformanceMetrics":{"type":"object","properties":{"sentCount":{"type":"integer","description":"Messages sent. On LinkedIn, invites plus messages and InMails.","format":"int32"},"deliveredCount":{"type":"integer","description":"Emails delivered: sent and not bounced.","format":"int32"},"bounceCount":{"type":"integer","description":"Emails that bounced.","format":"int32"},"openCount":{"type":"integer","description":"Human opens, counting repeat opens.","format":"int32"},"uniqueOpenCount":{"type":"integer","description":"Human opens, without repeat opens.","format":"int32"},"clickCount":{"type":"integer","description":"Human link clicks, counting repeat clicks.","format":"int32"},"uniqueClickCount":{"type":"integer","description":"Human link clicks, without repeat clicks.","format":"int32"},"botClickCount":{"type":"integer","description":"Clicks from bots and link scanners. Not part of `clickCount` or `clickRate`.","format":"int32"},"machineOpenCount":{"type":"integer","description":"Contacts whose every open in the window was a machine open: Apple Mail Privacy Protection, a crawler, or an open\nwithin a minute of the send, such as a security scanner fetching the email. Not part of `openCount`,\n`uniqueOpenCount` or `openRate`. Present on the email window totals and step rows, and omitted elsewhere.\nTreat opens as an estimate: image blocking hides some, and Kenso can tell apart only some machine opens.","format":"int32","nullable":true},"opensTracked":{"type":"boolean","description":"Whether Kenso records this campaign's opens. `false` means do not read `openRate` as real: a plain-text\ncampaign (Send as plain text on) carries no open pixel, and a campaign with Track opens off records none. Steps kept\nas HTML (a drawn letter, a Studio email, an image, a video or a provider-built message) can still carry the pixel,\nso a plain-text campaign's opens are partial rather than none. It reflects the campaign's settings now, not the\nsettings in force when each email went out: a campaign switched to plain text part way through reads `false`\nfor its earlier HTML days too, and one switched back reads `true` for its plain-text days. Opens imported from\nanother tool are the vendor's own, so an imported campaign's `opensTracked` is omitted (unknown) wherever it would read `false`.\nA workspace past its billing grace sends with no open pixel from then on, while its earlier emails carried one, so\nits opens are partly tracked: `opensTracked` is omitted (never `true`, and not `false`, which says\nnone were recorded). On an email campaign's window totals, rows, and a segment\nrow's steps and versions, and on `groupBy=campaign` rows. Omitted on `language` and `sender_route`\nrows (they split no opens), when the call covers more than one campaign, on LinkedIn, and when it is unknown.\nWherever it is omitted, opens are partly tracked or unknown: read `openRate` as a floor, never as a real rate or\nas zero. On one campaign's own figures (a one-campaign email read, or a `groupBy=campaign` row) that means the\nworkspace is past its billing grace, the campaign was imported, or the read failed. A figure that spans campaigns\n(the window totals, and every row of a read with no `campaignId` other than `groupBy=campaign` rows) has\nno value of its own and is unknown: check the `groupBy=campaign` rows, or one campaign's read, before relying\non its opens.","nullable":true},"clicksTracked":{"type":"boolean","description":"Whether Kenso records this campaign's link clicks. `false` means do not read `clickCount` or\n`clickRate` as real: the campaign has Send as plain text on, and since 15 Nov 2026 a plain-text email shows each\nlink's own address with no click-tracking link. Steps kept as HTML (a drawn letter, a Studio email, an image, a video\nor a provider-built message) and earlier emails still count clicks, so its clicks are partial, not none.\n`true` otherwise, including provider tracks that send plain text to Google leads only. It does not reflect\nTrack link clicks off (`trackClicks`). From the campaign's settings now, on the same metrics as\n`opensTracked`, and omitted where that is omitted for the whole call, past billing grace (no click link from\nthen on), and on an imported campaign that would read `false` (vendor clicks): read `clickRate` as a floor there.","nullable":true},"replyCount":{"type":"integer","description":"Contacts who replied.","format":"int32"},"unsubscribeCount":{"type":"integer","description":"Unsubscribes.","format":"int32"},"interestedCount":{"type":"integer","description":"Replies classified as interested.","format":"int32"},"contactedCount":{"type":"integer","description":"Distinct contacts sent at least one message.","format":"int32"},"inviteCount":{"type":"integer","description":"LinkedIn only: connection invites sent. Omitted on email.","format":"int32","nullable":true},"acceptedCount":{"type":"integer","description":"LinkedIn only: connection invites accepted. Omitted on email.","format":"int32","nullable":true},"messageCount":{"type":"integer","description":"LinkedIn only: messages and InMails sent. Omitted on email.","format":"int32","nullable":true},"deliveryRate":{"type":"number","description":"Delivery rate: `deliveredCount` divided by `sentCount`.","format":"double"},"openRate":{"type":"number","description":"Open rate: `uniqueOpenCount` divided by `deliveredCount`, or by `sentCount` when nothing counts as delivered.","format":"double"},"clickRate":{"type":"number","description":"Click rate: `uniqueClickCount` divided by the contacts reached, or by `sentCount` when that count is 0.","format":"double"},"replyRate":{"type":"number","description":"Reply rate: `replyCount` divided by the contacts reached, or by `sentCount` when that count is 0.","format":"double"},"bounceRate":{"type":"number","description":"Bounce rate: `bounceCount` divided by `sentCount`.","format":"double"},"bounceBreakdown":{"allOf":[{"$ref":"#/components/schemas/CampaignPerformanceBounceBreakdown"}],"description":"Bounces split by type and reason. Present on the window totals and on segment rows when the window has a\nclassified bounce, and omitted otherwise. Its total need not equal `bounceCount`."},"opportunitiesCreated":{"type":"integer","description":"Opportunities created in the window from this campaign, or from any campaign when the call named none, counted\non the day each was created. Omitted on segment rows and on LinkedIn. This field and the three after it are\nomitted unless the workspace has the `opportunities` feature and the caller has Accounts view.","format":"int32","nullable":true},"pipelineAmount":{"type":"number","description":"The current open amount of those opportunities, in the workspace's currency.","format":"double","nullable":true},"wonAmount":{"type":"number","description":"The current won amount of those opportunities, in the workspace's currency.","format":"double","nullable":true},"wonCount":{"type":"integer","description":"How many of those opportunities are won now.","format":"int32","nullable":true},"meetingsBooked":{"type":"integer","description":"Meetings booked in the window from this campaign, or from any campaign when the call named none. A moved meeting\ncounts once. Omitted on segment rows and on LinkedIn.","format":"int32","nullable":true}},"additionalProperties":false,"description":"Sending results for the window or for one row. Rates are fractions from 0 to 1, rounded to 4 decimals, and 0 when the base is 0."},"CampaignPerformanceResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/CampaignPerformance"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"CampaignPerformanceRow":{"type":"object","properties":{"key":{"type":"string","description":"The group's value: the date for `day`, the step for `step`, the segment id for `segment`, the\ncampaign id for `campaign`, the language for `language`, or the route for `sender_route`."},"date":{"type":"string","description":"Day rows only: the date as `YYYY-MM-DD`.","nullable":true},"stepOrder":{"type":"integer","description":"Step rows only: the step's position in the sequence.","format":"int32","nullable":true},"segmentId":{"type":"integer","description":"The segment the row covers, on segment rows and on LinkedIn step rows.","format":"int64","nullable":true},"campaignId":{"type":"integer","description":"Campaign rows only: the campaign the row counts.","format":"int64","nullable":true},"label":{"type":"string","description":"The row's display name: the segment name on segment rows, and the rule name on sender route rows.","nullable":true},"routeKey":{"type":"string","description":"Sender route rows only, equal to `key`: the sender rule's provider, `everyone_else` or\n`not_routed`.","nullable":true},"metrics":{"allOf":[{"$ref":"#/components/schemas/CampaignPerformanceMetrics"}],"description":"The row's results."},"variants":{"type":"array","items":{"$ref":"#/components/schemas/CampaignPerformanceVariant"},"description":"LinkedIn step rows only: one entry per version, `a` to `d`, for comparing versions of the invite.","nullable":true},"steps":{"type":"array","items":{"$ref":"#/components/schemas/CampaignPerformanceStep"},"description":"Email segment rows only: the segment's email steps by `stepOrder`, each with its versions. Omitted when the\nwindow is over 90 days or the segment has no step counts.","nullable":true},"notesWaiting":{"type":"integer","description":"LinkedIn step rows only: AI invite notes requested or waiting for approval.","format":"int32","nullable":true},"notesSkippedFreeAccount":{"type":"integer","description":"LinkedIn step rows only: invites sent without a note because the LinkedIn account is not Premium.","format":"int32","nullable":true},"notesFailed":{"type":"integer","description":"LinkedIn step rows only: invite notes that failed to generate.","format":"int32","nullable":true}},"additionalProperties":false,"description":"One group of the results, such as one day or one step."},"CampaignPerformanceStep":{"type":"object","properties":{"stepOrder":{"type":"integer","description":"The step's position in the segment's sequence.","format":"int32"},"metrics":{"allOf":[{"$ref":"#/components/schemas/CampaignPerformanceMetrics"}],"description":"The step's results."},"variants":{"type":"array","items":{"$ref":"#/components/schemas/CampaignPerformanceStepVariant"},"description":"One entry per version of the step, `a` to `d`, sorted. Empty when the step has none."}},"additionalProperties":false,"description":"Results for one email step of a segment. Opens, unsubscribes, bot clicks, opportunities and meetings are not split by\nstep, so they read 0 or are omitted."},"CampaignPerformanceStepVariant":{"type":"object","properties":{"variant":{"type":"string","description":"The version: `a`, `b`, `c` or `d`."},"metrics":{"allOf":[{"$ref":"#/components/schemas/CampaignPerformanceMetrics"}],"description":"The version's results, counted the same way as the step's."}},"additionalProperties":false,"description":"Results for one version of an email step of a segment."},"CampaignPerformanceVariant":{"type":"object","properties":{"variant":{"type":"string","description":"The version: `a`, `b`, `c` or `d`."},"sentCount":{"type":"integer","description":"Invites sent.","format":"int32"},"acceptedCount":{"type":"integer","description":"Invites accepted.","format":"int32"},"replyCount":{"type":"integer","description":"Contacts who replied.","format":"int32"},"failedCount":{"type":"integer","description":"Invites that failed to send.","format":"int32"},"acceptRate":{"type":"number","description":"Acceptance rate: `acceptedCount` divided by `sentCount`, as a fraction from 0 to 1. 0 when nothing was sent.","format":"double"}},"additionalProperties":false,"description":"Results for one version of a LinkedIn invite step."},"CampaignPerformanceViewError":{"type":"object","properties":{"view":{"type":"string","description":"The view, as named in the request: `previous`, `linkedin`, `linkedin_previous`, `segment`, `language` or `sender_route`."},"code":{"type":"string","description":"The error code the view's own call returns, such as `internal_error`."},"message":{"type":"string","description":"What went wrong, for a person to read."}},"additionalProperties":false,"description":"A view of a call with `views` that could not be read."},"CampaignPerformanceViews":{"type":"object","properties":{"previous":{"allOf":[{"$ref":"#/components/schemas/CampaignPerformance"}],"description":"View `previous`: the email read by day over the window of the same length that ends the day before `from`."},"linkedin":{"allOf":[{"$ref":"#/components/schemas/CampaignPerformance"}],"description":"View `linkedin`: the LinkedIn channel by day over the window."},"linkedinPrevious":{"allOf":[{"$ref":"#/components/schemas/CampaignPerformance"}],"description":"View `linkedin_previous`: the LinkedIn channel by day over the previous window."},"segment":{"allOf":[{"$ref":"#/components/schemas/CampaignPerformance"}],"description":"View `segment`: the email read with `groupBy=segment` over the window."},"language":{"allOf":[{"$ref":"#/components/schemas/CampaignPerformance"}],"description":"View `language`: the email read with `groupBy=language` over the window."},"senderRoute":{"allOf":[{"$ref":"#/components/schemas/CampaignPerformance"}],"description":"View `sender_route`: the email read with `groupBy=sender_route` over the window."},"errors":{"type":"array","items":{"$ref":"#/components/schemas/CampaignPerformanceViewError"},"description":"The views that could not be read. Omitted when every view was.","nullable":true}},"additionalProperties":false,"description":"The extra reads of a call with `views`, one field per view it asked for. Each is the response its own call\nreturns, with its own `from`, `to`, `groupBy` and `channel`, and no `views` of its own. A\nview the call did not ask for is omitted, and so is one that could not be read, which `errors` names."},"Deliverability":{"type":"object","properties":{"from":{"type":"string","description":"The start of the window, in UTC.","format":"date-time"},"to":{"type":"string","description":"The end of the window, in UTC.","format":"date-time"},"groupBy":{"type":"string","description":"How `rows` are grouped: `day`, `domain` or `inbox`."},"timeZone":{"type":"string","description":"The IANA time zone the call asked for. Omitted when none was sent, and days are then UTC days.","nullable":true},"metrics":{"allOf":[{"$ref":"#/components/schemas/DeliverabilityMetrics"}],"description":"The window's totals and the workspace's inbox counts."},"rows":{"type":"array","items":{"$ref":"#/components/schemas/DeliverabilityRow"},"description":"One row per day, domain or inbox, as `groupBy` asks."}},"additionalProperties":false,"description":"The workspace's sending health over a window, as totals and rows by day, domain or inbox."},"DeliverabilityAlert":{"type":"object","properties":{"code":{"type":"string","description":"The problem: `sending_paused`, `blocklisted`, `authentication_failing`, `dmarc_failing`,\n`placement_spam`, `placement_low_inbox`, `complaint_rate`, `microsoft_tenant_ban`,\n`sender_rejections`, `high_bounce_rate` or `recipient_refusals`. Expect new codes over time."},"scope":{"type":"string","description":"What the alert is about: `domain` or `inbox`."},"severity":{"type":"string","description":"How serious it is: `warning` or `critical`."},"message":{"type":"string","description":"One plain sentence that states the problem with its number."},"action":{"type":"string","description":"One sentence on what to do."},"since":{"type":"string","description":"When the signal was seen, in UTC. Omitted when unknown.","format":"date-time","nullable":true},"until":{"type":"string","description":"When the pause ends, in UTC. Only on `sending_paused`.","format":"date-time","nullable":true},"rate":{"type":"number","description":"The rate behind the alert, as a fraction from 0 to 1. Omitted when no rate drives it.","format":"double","nullable":true},"threshold":{"type":"number","description":"The threshold the rate crossed, as a fraction from 0 to 1. Omitted when no rate drives it.","format":"double","nullable":true}},"additionalProperties":false,"description":"A problem with a domain's or inbox's sending."},"DeliverabilityGate":{"type":"object","properties":{"threshold":{"type":"number","description":"The hard bounce rate a row must be above to be `over`, as a fraction from 0 to 1.","format":"double"},"minSends":{"type":"integer","description":"The fewest sends in the window before a row can be `over`.","format":"int32"},"minBounces":{"type":"integer","description":"The fewest hard bounces in the window before a row can be `over`.","format":"int32"}},"additionalProperties":false,"description":"A bounce limit."},"DeliverabilityGateDomain":{"type":"object","properties":{"domainId":{"type":"integer","description":"The domain's id in Kenso. Omitted for the address domain of mailboxes with no domain in Kenso. Free-mail\nproviders such as gmail.com get no domain row.","format":"int64","nullable":true},"domainName":{"type":"string","description":"The domain name.","nullable":true},"inboxCount":{"type":"integer","description":"Inboxes on the domain that sent in the window.","format":"int32"},"sentCount":{"type":"integer","description":"Sends in the window.","format":"int32"},"bounceCount":{"type":"integer","description":"Hard bounces in the window.","format":"int32"},"bounceRate":{"type":"number","description":"Bounce rate: `bounceCount` divided by `sentCount`, as a fraction from 0 to 1.","format":"double"},"verdict":{"type":"string","description":"The verdict: `over`, `watch` (not over, but the rate is at least 80% of the threshold) or `ok`."},"isSmallSample":{"type":"boolean","description":"True when the domain has fewer sends than `domainGate.minSends`, so it cannot be `over` yet, whatever its rate."}},"additionalProperties":false,"description":"A domain's sends and hard bounces against the domain limit."},"DeliverabilityGateInbox":{"type":"object","properties":{"inboxId":{"type":"integer","description":"The inbox's id.","format":"int64"},"email":{"type":"string","description":"The inbox's email address.","nullable":true},"domainId":{"type":"integer","description":"The id of the inbox's domain in Kenso. Omitted for a mailbox with no domain in Kenso.","format":"int64","nullable":true},"domainName":{"type":"string","description":"The inbox's domain name.","nullable":true},"sentCount":{"type":"integer","description":"Sends in the window.","format":"int32"},"bounceCount":{"type":"integer","description":"Hard bounces in the window.","format":"int32"},"bounceRate":{"type":"number","description":"Bounce rate: `bounceCount` divided by `sentCount`, as a fraction from 0 to 1.","format":"double"},"verdict":{"type":"string","description":"The verdict: `over`, `watch` (not over, but the rate is at least 80% of the threshold) or `ok`."},"isSmallSample":{"type":"boolean","description":"True when the inbox has fewer sends than `inboxGate.minSends`, so it cannot be `over` yet, whatever its rate."}},"additionalProperties":false,"description":"An inbox's sends and hard bounces against the inbox limit."},"DeliverabilityGates":{"type":"object","properties":{"from":{"type":"string","description":"The start of the window, in UTC.","format":"date-time"},"to":{"type":"string","description":"The end of the window, in UTC.","format":"date-time"},"windowHours":{"type":"integer","description":"Hours of sends and hard bounces the rows count. Always 24.","format":"int32"},"isEnforced":{"type":"boolean","description":"True when Kenso blocks inboxes and pauses campaigns on these limits. False when it only records them."},"enforcedWindowHours":{"type":"integer","description":"Hours of the rolling window Kenso itself judges an inbox or campaign over.","format":"int32"},"domainGate":{"allOf":[{"$ref":"#/components/schemas/DeliverabilityGate"}],"description":"The limit domain rows are judged by: the one that pauses a campaign. Kenso has no domain-level bounce block."},"inboxGate":{"allOf":[{"$ref":"#/components/schemas/DeliverabilityGate"}],"description":"The limit inbox rows are judged by: the one that blocks an inbox."},"domainCount":{"type":"integer","description":"Domains that sent in the window, before `limit` cuts the list.","format":"int32"},"inboxCount":{"type":"integer","description":"Inboxes that sent in the window, before `limit` cuts the list.","format":"int32"},"domains":{"type":"array","items":{"$ref":"#/components/schemas/DeliverabilityGateDomain"},"description":"Domain rows, worst first: `over`, then `watch`, then `ok`, each by bounce rate."},"inboxes":{"type":"array","items":{"$ref":"#/components/schemas/DeliverabilityGateInbox"},"description":"Inbox rows, worst first: `over`, then `watch`, then `ok`, each by bounce rate."}},"additionalProperties":false,"description":"The bounce limits Kenso enforces, and where each domain and inbox stands against them over the last 24 hours."},"DeliverabilityGatesResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/DeliverabilityGates"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"DeliverabilityMetrics":{"type":"object","properties":{"sentCount":{"type":"integer","description":"Emails sent.","format":"int64"},"replyCount":{"type":"integer","description":"Replies, not counting out-of-office replies.","format":"int64"},"bounceCount":{"type":"integer","description":"Emails that bounced.","format":"int64"},"clickCount":{"type":"integer","description":"Link clicks.","format":"int64"},"replyRate":{"type":"number","description":"Reply rate: `replyCount` divided by `sentCount`.","format":"double","nullable":true},"bounceRate":{"type":"number","description":"Bounce rate: `bounceCount` divided by `sentCount`.","format":"double","nullable":true},"clickRate":{"type":"number","description":"Click rate: `clickCount` divided by `sentCount`.","format":"double","nullable":true},"inboxCount":{"type":"integer","description":"Every inbox in the workspace, whatever its status.","format":"int32"},"activeInboxCount":{"type":"integer","description":"Inboxes whose status is active.","format":"int32"},"domainCount":{"type":"integer","description":"Domains in the workspace.","format":"int32"},"inboxesPerDomain":{"type":"number","description":"Average inboxes per domain: `inboxCount` divided by `domainCount`, rounded to 1 decimal. Omitted when the workspace has no domain.","format":"double","nullable":true},"healthyInboxCount":{"type":"integer","description":"Inboxes the inbox provider's health check rates healthy.","format":"int32"},"lowActivityInboxCount":{"type":"integer","description":"Inboxes the inbox provider's health check rates low activity.","format":"int32"},"inactiveInboxCount":{"type":"integer","description":"Inboxes the inbox provider's health check rates inactive.","format":"int32"},"complaintCount":{"type":"integer","description":"Spam complaints in the window. Omitted when the complaint data could not be read.","format":"int64","nullable":true},"complaintRate":{"type":"number","description":"Complaint rate: `complaintCount` divided by `sentCount`, as a fraction from 0 to 1. Omitted when nothing was sent.","format":"double","nullable":true}},"additionalProperties":false,"description":"The window's totals and the workspace's inbox counts. Rates are fractions from 0 to 1, omitted when nothing was sent."},"DeliverabilityResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/Deliverability"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"DeliverabilityRow":{"type":"object","properties":{"date":{"type":"string","description":"Day rows only: the date as `YYYY-MM-DD`.","nullable":true},"domainId":{"type":"integer","description":"The domain's id, on domain and inbox rows.","format":"int64","nullable":true},"domainName":{"type":"string","description":"The domain name, on domain and inbox rows.","nullable":true},"inboxId":{"type":"integer","description":"Inbox rows only: the inbox's id.","format":"int64","nullable":true},"email":{"type":"string","description":"Inbox rows only: the inbox's email address.","nullable":true},"inboxCount":{"type":"integer","description":"Domain rows only: the domain's inboxes.","format":"int32","nullable":true},"sentCount":{"type":"integer","description":"Emails sent.","format":"int64"},"replyCount":{"type":"integer","description":"Replies, not counting out-of-office replies.","format":"int64"},"bounceCount":{"type":"integer","description":"Emails that bounced.","format":"int64"},"clickCount":{"type":"integer","description":"Link clicks.","format":"int64"},"replyRate":{"type":"number","description":"Reply rate: `replyCount` divided by `sentCount`.","format":"double","nullable":true},"bounceRate":{"type":"number","description":"Bounce rate: `bounceCount` divided by `sentCount`.","format":"double","nullable":true},"clickRate":{"type":"number","description":"Click rate: `clickCount` divided by `sentCount`.","format":"double","nullable":true},"complaintCount":{"type":"integer","description":"Spam complaints, on day and domain rows. Omitted on inbox rows and when the complaint data could not be read.","format":"int64","nullable":true},"oooCount":{"type":"integer","description":"Out-of-office replies, on domain and inbox rows. Omitted on day rows and when the count could not be read.","format":"int64","nullable":true},"oooRate":{"type":"number","description":"Out-of-office rate: `oooCount` divided by `sentCount`. Omitted on day rows and when nothing was sent.","format":"double","nullable":true},"reputation":{"type":"string","description":"Domain and inbox rows: `paused` (an active Kenso pause covers the row), `at_risk` (a critical alert),\n`watch` (a warning alert), `good` (no alert) or `unknown` (a signal could not be read, or there is no\nrecent evidence). Omitted on day rows. It describes the state now: only the `complaint_rate` and\n`high_bounce_rate` alerts look at the requested window.","nullable":true},"alerts":{"type":"array","items":{"$ref":"#/components/schemas/DeliverabilityAlert"},"description":"Domain and inbox rows: plain-language alerts, empty when nothing is wrong. An inbox row also carries its domain's\nalerts, with `scope` set to `domain`. Omitted on day rows.","nullable":true},"domainHealth":{"allOf":[{"$ref":"#/components/schemas/DomainHealthStatus"}],"description":"Domain and inbox rows in a workspace where domain health is on: the domain's health rung\n(`good`, `watch`, `throttle`, `quarantine`, `block`), reason, message and next step, as\n`health` on the domain. An inbox row carries its domain's. Omitted otherwise and on day rows."}},"additionalProperties":false,"description":"One day, domain or inbox of sending health. Rates are fractions from 0 to 1, omitted when nothing was sent."},"DomainHealthStatus":{"type":"object","properties":{"rung":{"type":"string"},"reason":{"type":"string"},"message":{"type":"string"},"action":{"type":"string","nullable":true},"since":{"type":"string","format":"date-time"},"until":{"type":"string","format":"date-time","nullable":true},"evaluatedAt":{"type":"string","format":"date-time"}},"additionalProperties":false,"description":"A domain's health on Ken's domain health ladder, customer-facing: `rung` is `good`,\n`watch`, `throttle`, `quarantine` or `block`; `reason` is a vendor-neutral code; `message`\nand `action` are sentences to show a user (`action` omitted when there is nothing to do); `until` is the\nend of a quarantine."},"Engagement":{"type":"object","properties":{"campaignId":{"type":"integer","description":"The campaign the clicks belong to.","format":"int64"},"from":{"type":"string","description":"The start of the window, in UTC.","format":"date-time"},"to":{"type":"string","description":"The end of the window, in UTC.","format":"date-time"},"dimension":{"type":"string","description":"What the rows split clicks by: `device`, `browser`, `os`, `country`, `city`,\n`link`, `region`, `network`, `referrer` or `source`."},"rows":{"type":"array","items":{"$ref":"#/components/schemas/EngagementRow"},"description":"One row per value of the dimension, at most `limit`."}},"additionalProperties":false,"description":"A campaign's link clicks over a window, split by one dimension."},"EngagementResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/Engagement"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"EngagementRow":{"type":"object","properties":{"key":{"type":"string","description":"The value, such as a device type, a country or a link URL."},"label":{"type":"string","description":"A display label for the value.","nullable":true},"count":{"type":"integer","description":"Clicks. For `device`, `browser`, `os`, `country`, `city` and `link`, human clicks\nonly. For `region`, `network`, `referrer` and `source`, every click.","format":"int32"},"humanCount":{"type":"integer","description":"Human clicks. Only for `region`, `network`, `referrer` and `source`.","format":"int32","nullable":true},"botCount":{"type":"integer","description":"Clicks from bots and link scanners. Only for `region`, `network`, `referrer` and `source`.","format":"int32","nullable":true},"uniqueContactCount":{"type":"integer","description":"Distinct contacts who clicked. Only for `region`, `network`, `referrer` and `source`.","format":"int32","nullable":true}},"additionalProperties":false,"description":"The clicks for one value of the dimension."},"ErrorAccount":{"type":"object","properties":{"accountId":{"type":"integer","description":"The account's id.","format":"int64"},"name":{"type":"string","description":"The account's name."},"stakeholderId":{"type":"integer","description":"The person's stakeholder id on this account.","format":"int64"}},"additionalProperties":false,"description":"An account named in an error detail."},"ErrorBody":{"type":"object","properties":{"code":{"type":"string","description":"Stable error code, such as `validation_failed` or `not_found`. Branch on this value."},"message":{"type":"string","description":"A sentence for people that explains the error. It can change, so do not parse it."},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"},"description":"One entry per problem, naming the field or limit it is about. Omitted when there are none.","nullable":true},"requestId":{"type":"string","description":"The id of this request: the same value as the `X-Correlation-Id` response header. Quote it when you write\nto contact@ken.so."},"docUrl":{"type":"string","description":"The page on this code in the developer docs, which says what it means and how to fix it. The errors guide for a\ncode that has no page of its own.","readOnly":true},"refusal":{"allOf":[{"$ref":"#/components/schemas/Refusal"}],"description":"On a `402`, the plan rule or usage limit that refused the request and how to lift it. Omitted otherwise."},"impact":{"allOf":[{"$ref":"#/components/schemas/InvalidationImpact"}],"description":"On a `409` that refuses a change because it would clear stored AI output (a prompt edit, a restore or a\nreset), how much the change would clear. Omitted otherwise."},"surface":{"type":"string","description":"Set only by the voice ticket's `409` (code `voice_conversation_active`): the chat the person's other\nvoice conversation runs in, `support`, `ken` or `onboarding`. Omitted on every other error.","nullable":true}},"additionalProperties":false,"description":"What went wrong in a request."},"ErrorDetail":{"type":"object","properties":{"field":{"type":"string","description":"The request field, header or limit the problem is about, such as `name` or `Ken-Version`."},"code":{"type":"string","description":"Stable code for this problem, such as `required` or `invalid`."},"message":{"type":"string","description":"A sentence for people that explains this problem."},"count":{"type":"integer","description":"On `export_limit_exceeded`, how many rows match the export. Omitted otherwise.","format":"int32","nullable":true},"index":{"type":"integer","description":"The position of the refused item in the request's list. Omitted otherwise.","format":"int32","nullable":true},"limit":{"type":"integer","description":"On `export_limit_exceeded`, the row limit the export ran with. On a `quota_exceeded` detail whose\n`field` names a quota, that quota's limit. On a `rate_limited` detail from your workspace's rate\nlimits, the limit that was hit. Omitted otherwise.","format":"int32","nullable":true},"resetAt":{"type":"string","description":"On some `quota_exceeded` details, when the quota frees up, in UTC. It is the same instant as the top-level\n`quotaResetAt`. On a `rate_limited` detail from your workspace's rate limits, when that limit resets.\nOmitted otherwise.","format":"date-time","nullable":true},"retryAfterSeconds":{"type":"integer","description":"On those `quota_exceeded` details and on most `rate_limited` details, the seconds to wait. It is the\nsame value as the `Retry-After` header. Omitted otherwise.","format":"int32","nullable":true},"inboxId":{"type":"integer","description":"The inbox the problem is about. Omitted otherwise.","format":"int64","nullable":true},"domainId":{"type":"integer","description":"The domain the problem is about. Omitted otherwise.","format":"int64","nullable":true},"domainName":{"type":"string","description":"The name of that domain, or the domain name the request gave. Omitted otherwise.","nullable":true},"accountId":{"type":"integer","description":"On `domain_taken`, `already_stakeholder` and `previously_removed`, the existing account to use\ninstead. Omitted otherwise.","format":"int64","nullable":true},"personId":{"type":"integer","description":"On `email_taken` and `linkedin_url_taken`, the existing person to use instead. Omitted otherwise.","format":"int64","nullable":true},"stakeholderId":{"type":"integer","description":"The account stakeholder the problem is about. Omitted otherwise.","format":"int64","nullable":true},"championId":{"type":"integer","description":"Not used. Always omitted.","format":"int64","nullable":true},"callTaskId":{"type":"integer","description":"On `call_task_exists`, the open call task that already holds the person's slot. Omitted otherwise.","format":"int64","nullable":true},"status":{"type":"string","description":"On `invalid_transition`, the current status. Omitted otherwise.","nullable":true},"allowed":{"type":"array","items":{"type":"string"},"description":"On `out_of_range`, the allowed values. On `invalid_transition`, the statuses the change is allowed\nfrom. Omitted otherwise.","nullable":true},"scope":{"type":"string","description":"On a `permission_denied` for an account owner change, the account scope the call needs (`all`). On\n`sending_paused`, what the pause covers: `inbox`, `domain` or `workspace`. Omitted otherwise.","nullable":true},"removedAt":{"type":"string","description":"On `previously_removed`, when a person removed the stakeholder, in UTC. Omitted otherwise.","format":"date-time","nullable":true},"page":{"type":"string","description":"On `permission_denied`, the page the call needs, such as `campaigns`. Omitted otherwise.","nullable":true},"required":{"type":"string","description":"On `permission_denied`, the access `page` needs: `view` or `edit`. Omitted otherwise.","nullable":true},"feature":{"type":"string","description":"On `permission_denied`, the permission the call needs, such as `launch`. Omitted otherwise.","nullable":true},"runId":{"type":"integer","description":"On `committee_run_active` and `run_not_finding`, the committee run the problem is about. Omitted\notherwise.","format":"int64","nullable":true},"mergedIntoId":{"type":"integer","description":"On `person_merged`, the person the merged person now lives on. On `account_merged`, the account the\nmerged account now lives on. Omitted otherwise.","format":"int64","nullable":true},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/ErrorAccount"},"description":"On `person_on_accounts`, the accounts that block the change. Omitted otherwise.","nullable":true},"stage":{"type":"string","description":"On `stage_in_use` and `system_stage`, the opportunity stage key the problem is about. Omitted otherwise.","nullable":true},"opportunityCount":{"type":"integer","description":"On `stage_in_use`, how many opportunities are in that stage. Omitted otherwise.","format":"int32","nullable":true},"rule":{"type":"string","description":"On `guardrail_violation`, the contact limit rule the change breaks. Omitted otherwise.","nullable":true},"nextAllowedAt":{"type":"string","description":"On `guardrail_violation`, the first `dueAt` that passes every contact limit, in UTC. On a refused\nsend, when to retry. Omitted otherwise, and when waiting does not clear it.","format":"date-time","nullable":true},"fix":{"type":"string","description":"On a refused send, what to do next, in plain words. Omitted otherwise.","nullable":true},"opensAt":{"type":"string","description":"On `outside_calling_hours`, when the person's calling window opens, in UTC. Omitted otherwise.","format":"date-time","nullable":true},"currentVersion":{"type":"integer","description":"On a knowledge file's `version_conflict`, the file's current version. Omitted otherwise.","format":"int32","nullable":true},"provider":{"type":"string","description":"On a CRM connection error (`provider_error`, `exchange_failed`, `already_connected`,\n`account_mismatch` or `provider_unavailable`), the CRM it is about. Omitted otherwise.","nullable":true},"sharedWithMaster":{"type":"boolean","description":"True on a `quota_exceeded` detail when the shared limit of the white-label master workspace was hit, so\n`limit` is the limit of the whole white-label account. Omitted otherwise. The master's id is never sent.","nullable":true},"stepId":{"type":"integer","description":"On `link_reputation_blocked`, the saved sequence step that holds the blocked link. Omitted otherwise, and\nfor a step the save would have created.","format":"int64","nullable":true},"stepOrder":{"type":"integer","description":"On `link_reputation_blocked`, the `stepOrder` of that step. Omitted otherwise.","format":"int32","nullable":true},"url":{"type":"string","description":"On `link_reputation_blocked`, the blocked link as the step's copy writes it. Omitted otherwise.","nullable":true},"key":{"type":"string","description":"On `unfilled_template_key`, the template key the text still holds, such as `first_name` for\n`{first_name}`. Omitted otherwise.","nullable":true},"marker":{"type":"string","description":"On `unfilled_template_key`, that key as the text writes it, such as `{first_name}` or `[company]`.\nOmitted otherwise.","nullable":true},"retryAt":{"type":"string","description":"On a warm path Start's `guardrail_connector_monthly`, `guardrail_account_monthly`,\n`guardrail_connector_cooldown` and `guardrail_handoff_weekly`, when the limit frees up, in UTC. Omitted\notherwise.","format":"date-time","nullable":true},"workspaceId":{"type":"integer","description":"On `last_admin`, a workspace that needs a new admin before the account can be deleted. On\n`new_admin_not_found`, the workspace of the refused choice. Omitted otherwise.","format":"int64","nullable":true},"workspaceName":{"type":"string","description":"On `last_admin`, the name of that workspace. Omitted otherwise.","nullable":true},"class":{"type":"string","description":"On a `rate_limited` detail from your workspace's rate limits, the class of call that hit its limit:\n`read`, `write`, `bulk`, `heavy` or `sensitive`. Omitted otherwise.","nullable":true},"window":{"type":"string","description":"On that detail, the window whose limit was hit: `minute`, `day` or `bulkItemsDay`. Omitted\notherwise.","nullable":true}},"additionalProperties":false,"description":"One problem in an error: the field or limit it is about, a stable `code` and a `message`. The other fields\nappear only with the codes their descriptions name."},"Failure":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false on an error."},"error":{"allOf":[{"$ref":"#/components/schemas/ErrorBody"}],"description":"What went wrong."},"quotaResetAt":{"type":"string","description":"When the quota that refused the request frees up, in UTC. Set on some quota refusals. Omitted otherwise.","format":"date-time","nullable":true},"currentVersion":{"type":"integer","description":"The current revision of a workflow draft, on a draft save's `409 version_conflict`. Read the workflow\nagain, then send this value as `baseVersion`. Omitted otherwise.","format":"int32","nullable":true},"current":{"allOf":[{"$ref":"#/components/schemas/MeetingRepNotesCurrent"}],"description":"Your meeting notes and their version as stored now, on a meeting notes save's `409 version_conflict`.\nMerge your change, then save again with `baseVersion` set to `current.repNotesVersion`. Omitted\notherwise."},"refusal":{"allOf":[{"$ref":"#/components/schemas/Refusal"}],"description":"A copy of `error.refusal`, set on some billing refusals. Omitted otherwise."},"message":{"type":"string","description":"A copy of `error.message`, set together with `refusal`. Omitted otherwise.","nullable":true},"lookalikeSeeds":{"description":"How Kenso read each seed of a lookalike search, on its `422 no_usable_seeds`:\n`{resolved: [{input, companyId, personId, name, domain}], unresolved: [{input, reason}]}`. Use it to show\nwhy no seed was usable. Omitted otherwise."}},"additionalProperties":false,"description":"The body of every error, with a 4xx or 5xx status. Branch on `error.code`."},"InvalidationImpact":{"type":"object","properties":{"qualificationResponses":{"type":"integer","description":"Stored qualification answers the change would clear.","format":"int32"},"qualifiedFlags":{"type":"integer","description":"Contacts whose qualified result the change would clear.","format":"int32"},"segmentationReasoning":{"type":"integer","description":"Stored segmentation explanations the change would clear.","format":"int32"},"segmentationAssignmentsKept":{"type":"integer","description":"Contacts that keep their segment.","format":"int32"},"segmentationAssignmentsReset":{"type":"integer","description":"Contacts that go back to the default segment.","format":"int32"},"personalizationLines":{"type":"integer","description":"Personalized lines the change would clear.","format":"int32"},"personalizationLeads":{"type":"integer","description":"Contacts that would lose their personalized lines.","format":"int32"},"rewritingLines":{"type":"integer","description":"Rewritten lines the change would clear.","format":"int32"},"rewritingLeads":{"type":"integer","description":"Contacts that would lose their rewritten lines.","format":"int32"}},"additionalProperties":false,"description":"How much stored AI output a change would clear in each AI step of a campaign, and how many segment assignments it\nkeeps or resets."},"MeetingRepNotesCurrent":{"type":"object","properties":{"repNotes":{"type":"string","description":"Your notes as stored now. Empty before your first save."},"repNotesVersion":{"type":"integer","description":"The stored notes' version. Send it as `baseVersion` when you save again.","format":"int32"}},"additionalProperties":false,"description":"Your meeting notes as Kenso stores them now, sent with a `409 version_conflict` on a notes save."},"RateLimitedText":{"type":"string","description":"The gateway's plain-text body of a `429` over the operation's own limit, until November 2026: `Number of requests exceeded. Please try again later.`","example":"Number of requests exceeded. Please try again later."},"Refusal":{"type":"object","properties":{"code":{"type":"string","description":"Stable refusal code in upper case, such as `CAMPAIGN_LIMIT_REACHED` or `INSUFFICIENT_CREDITS`."},"metric":{"type":"string","description":"What the limit counts: `Campaigns`, `Leads`, `Emails`, `LinkedInSeats` or `AiCredits`,\n`jobs_export_rows` or `funding_export_rows` for an export allowance, `credit_pack_credits`,\n`credit_spend_usd_7d`, `domains` or `mailboxes` for a limit on a new paying workspace, or for a\nKenso Lifetime cap its key: `workspaces`, `inboxes`, `contacts`, `email_verifications_day`,\n`email_verifications_month`, `people_results_day`, `company_results_day`,\n`funding_results_day`, `job_post_results_day`, `website_visits_month` or\n`visitor_lookups_day`. Omitted when a plan rule, not a count, refused the request.","nullable":true},"used":{"type":"integer","description":"How much of the limit is used, in the unit of `metric`. Omitted when the refusal has no count.","format":"int32","nullable":true},"limit":{"type":"integer","description":"The limit, in the unit of `metric`. Omitted when the refusal has no count.","format":"int32","nullable":true},"remaining":{"type":"integer","description":"How much of the limit is left, in the unit of `metric`. Omitted when the refusal has no count.","format":"int32","nullable":true},"planType":{"type":"string","description":"The workspace's plan as its snake plan id, for example `free`, `legacy_core` or `growth`."},"remedy":{"type":"string","description":"What lifts the refusal: `Upgrade`, `BuyAddOn`, `UpdatePaymentMethod` or `ContactSupport`.\n`None` means no action of yours lifts it."},"unlocksAt":{"type":"string","description":"When the limit lifts by itself, in UTC: for a limit on a new paying workspace once it has paid an invoice, and for\na Kenso Lifetime daily or monthly cap its reset (00:00 UTC, or the 1st of the month). Omitted on every other\nrefusal.","format":"date-time","nullable":true},"requiredMillicredits":{"type":"integer","description":"On a credit refusal, the millicredits the action needed. 1,000 millicredits are one credit. Omitted on every\nother refusal.","format":"int64","nullable":true},"availableMillicredits":{"type":"integer","description":"On a credit refusal, the millicredits available. On `FREE_CREDITS_NOT_ELIGIBLE`, only the credits that may\npay for inboxes and domains. Omitted on every other refusal.","format":"int64","nullable":true},"restrictedMillicredits":{"type":"integer","description":"On `FREE_CREDITS_NOT_ELIGIBLE`, the free and bonus millicredits in the balance that cannot pay for inboxes\nand domains. Omitted on every other refusal.","format":"int64","nullable":true},"feature":{"type":"string","description":"On `PLAN_FEATURE_NOT_AVAILABLE`, the plan feature the plan does not include, in snake case (for example\n`website_visitor_id`). Omitted on every other refusal.","nullable":true},"requiredPlan":{"type":"string","description":"On `PLAN_FEATURE_NOT_AVAILABLE`, the cheapest plan that includes `feature`, in snake case (for example\n`growth`). For a feature the self-serve trial locks (`browser_runs`), the trial's own plan,\nwhich paying for unlocks it. Omitted on every other refusal.","nullable":true},"requiredTier":{"type":"integer","description":"On a Kenso Lifetime refusal, the lowest tier that lifts it: the next tier with a higher cap, or the lowest tier\nthat includes `feature`. Omitted at the top tier, when no tier includes the feature, and on every other\nrefusal.","format":"int32","nullable":true},"upgradeUrl":{"type":"string","description":"On a Kenso Lifetime refusal that a higher tier lifts, the AppSumo page where the buyer upgrades their license.\nOmitted until Kenso has read that page from AppSumo, when no tier lifts the refusal, and on every other refusal.","nullable":true}},"additionalProperties":false,"description":"Why a plan rule or usage limit refused the request, and how to lift it."},"ReplyClassificationCount":{"type":"object","properties":{"classification":{"type":"string","description":"The classification, such as `interested`, `question`, `not_interested`, `negative`, `objection`,\n`referral`, `wrong_contact`, `unsubscribe`, `out_of_office`, `automated`,\n`hard_bounce`, `soft_bounce`, `complaint`, `ndr`, `unknown` or `unclassified`."},"count":{"type":"integer","description":"People in this classification.","format":"int32"}},"additionalProperties":false,"description":"The number of people in one classification."},"ReplyClassificationGroup":{"type":"object","properties":{"campaignId":{"type":"integer","description":"The campaign, on `byCampaign` rows.","format":"int64","nullable":true},"segmentId":{"type":"integer","description":"The segment, on `bySegment` rows. Omitted on the row for people with no segment.","format":"int64","nullable":true},"name":{"type":"string","description":"Set to `Unattributed` on the row for people with no segment, and on the `byConfiguration` row. Omitted on other rows.","nullable":true},"totalCount":{"type":"integer","description":"People who replied in the window.","format":"int32"},"interestedCount":{"type":"integer","description":"People classified as interested.","format":"int32"},"counts":{"type":"array","items":{"$ref":"#/components/schemas/ReplyClassificationCount"},"description":"People per classification, sorted by classification name. Classifications with nobody in them are left out."}},"additionalProperties":false,"description":"Reply classification counts for one campaign or segment."},"ReplyClassifications":{"type":"object","properties":{"from":{"type":"string","description":"The start of the window, in UTC.","format":"date-time"},"to":{"type":"string","description":"The end of the window, in UTC.","format":"date-time"},"campaignId":{"type":"integer","description":"The campaign the counts cover. Omitted when they cover every campaign in the workspace.","format":"int64","nullable":true},"totalCount":{"type":"integer","description":"People who replied in the window. For a campaign imported from another tool, it also counts imported repliers\nwho came with no classification, so `counts` can add up to less.","format":"int32"},"interestedCount":{"type":"integer","description":"People classified as interested.","format":"int32"},"counts":{"type":"array","items":{"$ref":"#/components/schemas/ReplyClassificationCount"},"description":"People per classification, sorted by classification name. Classifications with nobody in them are left out."},"byCampaign":{"type":"array","items":{"$ref":"#/components/schemas/ReplyClassificationGroup"},"description":"The same counts for each campaign when the call sets `byCampaign`. Empty otherwise."},"bySegment":{"type":"array","items":{"$ref":"#/components/schemas/ReplyClassificationGroup"},"description":"The same counts for each segment when the call sets `bySegment`. Empty otherwise. People with no segment\nshare one row named `Unattributed`."},"byConfiguration":{"type":"array","items":{"$ref":"#/components/schemas/ReplyClassificationGroup"},"description":"Empty. Kenso does not tie replies to a sending configuration, so there is no breakdown by one. A caller that still\nsends the retired `byConfiguration` flag gets one row named `Unattributed` that holds everyone."}},"additionalProperties":false,"description":"How the people who replied in a window were classified, in total and by campaign and segment."},"ReplyClassificationsResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/ReplyClassifications"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"TooManyRequestsError":{"oneOf":[{"$ref":"#/components/schemas/Failure"},{"$ref":"#/components/schemas/ApiKeyError"}],"description":"The JSON body of a `429`: the error body (`Failure`), with code `rate_limited` or `quota_exceeded`, over your workspace's rate limits, your API key's own limit, the operation's own limit or a usage quota. Until November 2026, over your API key's own limit the API key check answered `{ \"error\": \"Rate limit exceeded\" }` (`ApiKeyError`), and over the operation's own limit the gateway answered plain text (`RateLimitedText`): `Number of requests exceeded. Please try again later.` A client built against those answers keeps working: handle each shape. Wait the `Retry-After` seconds."},"UnauthorizedError":{"oneOf":[{"$ref":"#/components/schemas/Failure"},{"$ref":"#/components/schemas/ApiKeyError"}],"description":"The body of a `401`: the error body (`Failure`), whose `code` says what is wrong with the credential. Until November 2026, when the API key was not valid (unknown, expired or revoked, or its member no longer active), the API key check in front of the operations answered `{ \"error\": \"Invalid or revoked API key\" }` (`ApiKeyError`), and a request with no API key got a `401` that has no body. A client built against those answers keeps working: handle both shapes and a `401` with no body."}}}}