featurebase-node 0.14.3 → 0.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/client.d.mts +5 -5
- package/client.d.mts.map +1 -1
- package/client.d.ts +5 -5
- package/client.d.ts.map +1 -1
- package/package.json +1 -1
- package/resources/audit-logs.d.mts +3 -3
- package/resources/audit-logs.d.mts.map +1 -1
- package/resources/audit-logs.d.ts +3 -3
- package/resources/audit-logs.d.ts.map +1 -1
- package/resources/changelogs/changelogs.d.mts +116 -116
- package/resources/changelogs/changelogs.d.mts.map +1 -1
- package/resources/changelogs/changelogs.d.ts +116 -116
- package/resources/changelogs/changelogs.d.ts.map +1 -1
- package/resources/changelogs/changelogs.js +74 -74
- package/resources/changelogs/changelogs.js.map +1 -1
- package/resources/changelogs/changelogs.mjs +74 -74
- package/resources/changelogs/changelogs.mjs.map +1 -1
- package/resources/changelogs/index.d.mts +1 -1
- package/resources/changelogs/index.d.mts.map +1 -1
- package/resources/changelogs/index.d.ts +1 -1
- package/resources/changelogs/index.d.ts.map +1 -1
- package/resources/changelogs/subscribers.d.mts +3 -3
- package/resources/changelogs/subscribers.d.mts.map +1 -1
- package/resources/changelogs/subscribers.d.ts +3 -3
- package/resources/changelogs/subscribers.d.ts.map +1 -1
- package/resources/conversation-attributes.d.mts +17 -17
- package/resources/conversation-attributes.d.mts.map +1 -1
- package/resources/conversation-attributes.d.ts +17 -17
- package/resources/conversation-attributes.d.ts.map +1 -1
- package/resources/conversation-attributes.js +19 -19
- package/resources/conversation-attributes.js.map +1 -1
- package/resources/conversation-attributes.mjs +19 -19
- package/resources/conversation-attributes.mjs.map +1 -1
- package/resources/feedback/boards.d.mts +19 -19
- package/resources/feedback/boards.d.mts.map +1 -1
- package/resources/feedback/boards.d.ts +19 -19
- package/resources/feedback/boards.d.ts.map +1 -1
- package/resources/feedback/boards.js +20 -20
- package/resources/feedback/boards.js.map +1 -1
- package/resources/feedback/boards.mjs +20 -20
- package/resources/feedback/boards.mjs.map +1 -1
- package/resources/feedback/comments.d.mts +113 -113
- package/resources/feedback/comments.d.mts.map +1 -1
- package/resources/feedback/comments.d.ts +113 -113
- package/resources/feedback/comments.d.ts.map +1 -1
- package/resources/feedback/comments.js +93 -93
- package/resources/feedback/comments.js.map +1 -1
- package/resources/feedback/comments.mjs +93 -93
- package/resources/feedback/comments.mjs.map +1 -1
- package/resources/feedback/custom-fields.d.mts +36 -36
- package/resources/feedback/custom-fields.d.mts.map +1 -1
- package/resources/feedback/custom-fields.d.ts +36 -36
- package/resources/feedback/custom-fields.d.ts.map +1 -1
- package/resources/feedback/custom-fields.js +36 -36
- package/resources/feedback/custom-fields.js.map +1 -1
- package/resources/feedback/custom-fields.mjs +36 -36
- package/resources/feedback/custom-fields.mjs.map +1 -1
- package/resources/feedback/feedback.d.mts +5 -5
- package/resources/feedback/feedback.d.mts.map +1 -1
- package/resources/feedback/feedback.d.ts +5 -5
- package/resources/feedback/feedback.d.ts.map +1 -1
- package/resources/feedback/index.d.mts +5 -5
- package/resources/feedback/index.d.mts.map +1 -1
- package/resources/feedback/index.d.ts +5 -5
- package/resources/feedback/index.d.ts.map +1 -1
- package/resources/feedback/post-statuses.d.mts +20 -20
- package/resources/feedback/post-statuses.d.mts.map +1 -1
- package/resources/feedback/post-statuses.d.ts +20 -20
- package/resources/feedback/post-statuses.d.ts.map +1 -1
- package/resources/feedback/post-statuses.js +23 -23
- package/resources/feedback/post-statuses.js.map +1 -1
- package/resources/feedback/post-statuses.mjs +23 -23
- package/resources/feedback/post-statuses.mjs.map +1 -1
- package/resources/feedback/posts/index.d.mts +1 -1
- package/resources/feedback/posts/index.d.mts.map +1 -1
- package/resources/feedback/posts/index.d.ts +1 -1
- package/resources/feedback/posts/index.d.ts.map +1 -1
- package/resources/feedback/posts/posts.d.mts +132 -132
- package/resources/feedback/posts/posts.d.mts.map +1 -1
- package/resources/feedback/posts/posts.d.ts +132 -132
- package/resources/feedback/posts/posts.d.ts.map +1 -1
- package/resources/feedback/posts/posts.js +107 -107
- package/resources/feedback/posts/posts.js.map +1 -1
- package/resources/feedback/posts/posts.mjs +107 -107
- package/resources/feedback/posts/posts.mjs.map +1 -1
- package/resources/feedback/posts/voters.d.mts +3 -3
- package/resources/feedback/posts/voters.d.mts.map +1 -1
- package/resources/feedback/posts/voters.d.ts +3 -3
- package/resources/feedback/posts/voters.d.ts.map +1 -1
- package/resources/help-center/articles.d.mts +213 -97
- package/resources/help-center/articles.d.mts.map +1 -1
- package/resources/help-center/articles.d.ts +213 -97
- package/resources/help-center/articles.d.ts.map +1 -1
- package/resources/help-center/articles.js +73 -73
- package/resources/help-center/articles.js.map +1 -1
- package/resources/help-center/articles.mjs +73 -73
- package/resources/help-center/articles.mjs.map +1 -1
- package/resources/help-center/collections.d.mts +158 -71
- package/resources/help-center/collections.d.mts.map +1 -1
- package/resources/help-center/collections.d.ts +158 -71
- package/resources/help-center/collections.d.ts.map +1 -1
- package/resources/help-center/collections.js +65 -65
- package/resources/help-center/collections.js.map +1 -1
- package/resources/help-center/collections.mjs +65 -65
- package/resources/help-center/collections.mjs.map +1 -1
- package/resources/help-center/help-center.d.mts +4 -4
- package/resources/help-center/help-center.d.mts.map +1 -1
- package/resources/help-center/help-center.d.ts +4 -4
- package/resources/help-center/help-center.d.ts.map +1 -1
- package/resources/help-center/help-centers.d.mts +77 -48
- package/resources/help-center/help-centers.d.mts.map +1 -1
- package/resources/help-center/help-centers.d.ts +77 -48
- package/resources/help-center/help-centers.d.ts.map +1 -1
- package/resources/help-center/help-centers.js +43 -43
- package/resources/help-center/help-centers.js.map +1 -1
- package/resources/help-center/help-centers.mjs +43 -43
- package/resources/help-center/help-centers.mjs.map +1 -1
- package/resources/help-center/index.d.mts +4 -4
- package/resources/help-center/index.d.mts.map +1 -1
- package/resources/help-center/index.d.ts +4 -4
- package/resources/help-center/index.d.ts.map +1 -1
- package/resources/help-center/redirect-rules.d.mts +124 -124
- package/resources/help-center/redirect-rules.d.mts.map +1 -1
- package/resources/help-center/redirect-rules.d.ts +124 -124
- package/resources/help-center/redirect-rules.d.ts.map +1 -1
- package/resources/help-center/redirect-rules.js +112 -112
- package/resources/help-center/redirect-rules.js.map +1 -1
- package/resources/help-center/redirect-rules.mjs +112 -112
- package/resources/help-center/redirect-rules.mjs.map +1 -1
- package/resources/index.d.mts +5 -5
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +5 -5
- package/resources/index.d.ts.map +1 -1
- package/resources/organization/admins.d.mts +26 -26
- package/resources/organization/admins.d.mts.map +1 -1
- package/resources/organization/admins.d.ts +26 -26
- package/resources/organization/admins.d.ts.map +1 -1
- package/resources/organization/admins.js +25 -25
- package/resources/organization/admins.js.map +1 -1
- package/resources/organization/admins.mjs +25 -25
- package/resources/organization/admins.mjs.map +1 -1
- package/resources/organization/brands.d.mts +52 -52
- package/resources/organization/brands.d.mts.map +1 -1
- package/resources/organization/brands.d.ts +52 -52
- package/resources/organization/brands.d.ts.map +1 -1
- package/resources/organization/brands.js +54 -54
- package/resources/organization/brands.js.map +1 -1
- package/resources/organization/brands.mjs +54 -54
- package/resources/organization/brands.mjs.map +1 -1
- package/resources/organization/index.d.mts +3 -3
- package/resources/organization/index.d.mts.map +1 -1
- package/resources/organization/index.d.ts +3 -3
- package/resources/organization/index.d.ts.map +1 -1
- package/resources/organization/organization.d.mts +3 -3
- package/resources/organization/organization.d.mts.map +1 -1
- package/resources/organization/organization.d.ts +3 -3
- package/resources/organization/organization.d.ts.map +1 -1
- package/resources/organization/teams.d.mts +47 -47
- package/resources/organization/teams.d.mts.map +1 -1
- package/resources/organization/teams.d.ts +47 -47
- package/resources/organization/teams.d.ts.map +1 -1
- package/resources/organization/teams.js +44 -44
- package/resources/organization/teams.js.map +1 -1
- package/resources/organization/teams.mjs +44 -44
- package/resources/organization/teams.mjs.map +1 -1
- package/resources/reports.d.mts +249 -215
- package/resources/reports.d.mts.map +1 -1
- package/resources/reports.d.ts +249 -215
- package/resources/reports.d.ts.map +1 -1
- package/resources/reports.js +99 -99
- package/resources/reports.js.map +1 -1
- package/resources/reports.mjs +99 -99
- package/resources/reports.mjs.map +1 -1
- package/resources/support/conversation-tags.d.mts +43 -43
- package/resources/support/conversation-tags.d.mts.map +1 -1
- package/resources/support/conversation-tags.d.ts +43 -43
- package/resources/support/conversation-tags.d.ts.map +1 -1
- package/resources/support/conversation-tags.js +32 -32
- package/resources/support/conversation-tags.js.map +1 -1
- package/resources/support/conversation-tags.mjs +32 -32
- package/resources/support/conversation-tags.mjs.map +1 -1
- package/resources/support/conversations/conversations.d.mts +337 -327
- package/resources/support/conversations/conversations.d.mts.map +1 -1
- package/resources/support/conversations/conversations.d.ts +337 -327
- package/resources/support/conversations/conversations.d.ts.map +1 -1
- package/resources/support/conversations/conversations.js +293 -283
- package/resources/support/conversations/conversations.js.map +1 -1
- package/resources/support/conversations/conversations.mjs +293 -283
- package/resources/support/conversations/conversations.mjs.map +1 -1
- package/resources/support/conversations/index.d.mts +1 -1
- package/resources/support/conversations/index.d.mts.map +1 -1
- package/resources/support/conversations/index.d.ts +1 -1
- package/resources/support/conversations/index.d.ts.map +1 -1
- package/resources/support/conversations/participants.d.mts +2 -2
- package/resources/support/conversations/participants.d.mts.map +1 -1
- package/resources/support/conversations/participants.d.ts +2 -2
- package/resources/support/conversations/participants.d.ts.map +1 -1
- package/resources/support/index.d.mts +3 -3
- package/resources/support/index.d.mts.map +1 -1
- package/resources/support/index.d.ts +3 -3
- package/resources/support/index.d.ts.map +1 -1
- package/resources/support/support.d.mts +3 -3
- package/resources/support/support.d.mts.map +1 -1
- package/resources/support/support.d.ts +3 -3
- package/resources/support/support.d.ts.map +1 -1
- package/resources/support/tickets/categories.d.mts +20 -20
- package/resources/support/tickets/categories.d.mts.map +1 -1
- package/resources/support/tickets/categories.d.ts +20 -20
- package/resources/support/tickets/categories.d.ts.map +1 -1
- package/resources/support/tickets/categories.js +25 -25
- package/resources/support/tickets/categories.js.map +1 -1
- package/resources/support/tickets/categories.mjs +25 -25
- package/resources/support/tickets/categories.mjs.map +1 -1
- package/resources/support/tickets/custom-fields.d.mts +22 -22
- package/resources/support/tickets/custom-fields.d.mts.map +1 -1
- package/resources/support/tickets/custom-fields.d.ts +22 -22
- package/resources/support/tickets/custom-fields.d.ts.map +1 -1
- package/resources/support/tickets/custom-fields.js +19 -19
- package/resources/support/tickets/custom-fields.js.map +1 -1
- package/resources/support/tickets/custom-fields.mjs +19 -19
- package/resources/support/tickets/custom-fields.mjs.map +1 -1
- package/resources/support/tickets/index.d.mts +4 -4
- package/resources/support/tickets/index.d.mts.map +1 -1
- package/resources/support/tickets/index.d.ts +4 -4
- package/resources/support/tickets/index.d.ts.map +1 -1
- package/resources/support/tickets/statuses.d.mts +19 -19
- package/resources/support/tickets/statuses.d.mts.map +1 -1
- package/resources/support/tickets/statuses.d.ts +19 -19
- package/resources/support/tickets/statuses.d.ts.map +1 -1
- package/resources/support/tickets/statuses.js +21 -21
- package/resources/support/tickets/statuses.js.map +1 -1
- package/resources/support/tickets/statuses.mjs +21 -21
- package/resources/support/tickets/statuses.mjs.map +1 -1
- package/resources/support/tickets/tickets.d.mts +75 -75
- package/resources/support/tickets/tickets.d.mts.map +1 -1
- package/resources/support/tickets/tickets.d.ts +75 -75
- package/resources/support/tickets/tickets.d.ts.map +1 -1
- package/resources/support/tickets/tickets.js +44 -44
- package/resources/support/tickets/tickets.js.map +1 -1
- package/resources/support/tickets/tickets.mjs +44 -44
- package/resources/support/tickets/tickets.mjs.map +1 -1
- package/resources/surveys.d.mts +43 -43
- package/resources/surveys.d.mts.map +1 -1
- package/resources/surveys.d.ts +43 -43
- package/resources/surveys.d.ts.map +1 -1
- package/resources/surveys.js +44 -44
- package/resources/surveys.js.map +1 -1
- package/resources/surveys.mjs +44 -44
- package/resources/surveys.mjs.map +1 -1
- package/resources/users/companies/companies.d.mts +121 -130
- package/resources/users/companies/companies.d.mts.map +1 -1
- package/resources/users/companies/companies.d.ts +121 -130
- package/resources/users/companies/companies.d.ts.map +1 -1
- package/resources/users/companies/companies.js +125 -125
- package/resources/users/companies/companies.js.map +1 -1
- package/resources/users/companies/companies.mjs +125 -125
- package/resources/users/companies/companies.mjs.map +1 -1
- package/resources/users/companies/contacts.d.mts +3 -3
- package/resources/users/companies/contacts.d.mts.map +1 -1
- package/resources/users/companies/contacts.d.ts +3 -3
- package/resources/users/companies/contacts.d.ts.map +1 -1
- package/resources/users/companies/index.d.mts +1 -1
- package/resources/users/companies/index.d.mts.map +1 -1
- package/resources/users/companies/index.d.ts +1 -1
- package/resources/users/companies/index.d.ts.map +1 -1
- package/resources/users/contacts/by-user-id/by-user-id.d.mts +2 -2
- package/resources/users/contacts/by-user-id/by-user-id.d.mts.map +1 -1
- package/resources/users/contacts/by-user-id/by-user-id.d.ts +2 -2
- package/resources/users/contacts/by-user-id/by-user-id.d.ts.map +1 -1
- package/resources/users/contacts/by-user-id/email-preferences.d.mts +2 -2
- package/resources/users/contacts/by-user-id/email-preferences.d.mts.map +1 -1
- package/resources/users/contacts/by-user-id/email-preferences.d.ts +2 -2
- package/resources/users/contacts/by-user-id/email-preferences.d.ts.map +1 -1
- package/resources/users/contacts/contacts.d.mts +249 -235
- package/resources/users/contacts/contacts.d.mts.map +1 -1
- package/resources/users/contacts/contacts.d.ts +249 -235
- package/resources/users/contacts/contacts.d.ts.map +1 -1
- package/resources/users/contacts/contacts.js +211 -184
- package/resources/users/contacts/contacts.js.map +1 -1
- package/resources/users/contacts/contacts.mjs +211 -184
- package/resources/users/contacts/contacts.mjs.map +1 -1
- package/resources/users/contacts/email-preferences.d.mts +2 -2
- package/resources/users/contacts/email-preferences.d.mts.map +1 -1
- package/resources/users/contacts/email-preferences.d.ts +2 -2
- package/resources/users/contacts/email-preferences.d.ts.map +1 -1
- package/resources/users/contacts/index.d.mts +1 -1
- package/resources/users/contacts/index.d.mts.map +1 -1
- package/resources/users/contacts/index.d.ts +1 -1
- package/resources/users/contacts/index.d.ts.map +1 -1
- package/resources/users/index.d.mts +2 -2
- package/resources/users/index.d.mts.map +1 -1
- package/resources/users/index.d.ts +2 -2
- package/resources/users/index.d.ts.map +1 -1
- package/resources/users/users.d.mts +2 -2
- package/resources/users/users.d.mts.map +1 -1
- package/resources/users/users.d.ts +2 -2
- package/resources/users/users.d.ts.map +1 -1
- package/resources/webhooks.d.mts +83 -83
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +83 -83
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js +77 -77
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs +77 -77
- package/resources/webhooks.mjs.map +1 -1
- package/src/client.ts +6 -6
- package/src/resources/audit-logs.ts +7 -1
- package/src/resources/changelogs/changelogs.ts +320 -175
- package/src/resources/changelogs/index.ts +1 -1
- package/src/resources/changelogs/subscribers.ts +31 -2
- package/src/resources/conversation-attributes.ts +34 -34
- package/src/resources/feedback/boards.ts +30 -30
- package/src/resources/feedback/comments.ts +137 -137
- package/src/resources/feedback/custom-fields.ts +46 -46
- package/src/resources/feedback/feedback.ts +6 -6
- package/src/resources/feedback/index.ts +6 -6
- package/src/resources/feedback/post-statuses.ts +33 -33
- package/src/resources/feedback/posts/index.ts +2 -2
- package/src/resources/feedback/posts/posts.ts +176 -176
- package/src/resources/feedback/posts/voters.ts +3 -3
- package/src/resources/help-center/articles.ts +631 -109
- package/src/resources/help-center/collections.ts +349 -88
- package/src/resources/help-center/help-center.ts +5 -5
- package/src/resources/help-center/help-centers.ts +202 -57
- package/src/resources/help-center/index.ts +5 -5
- package/src/resources/help-center/redirect-rules.ts +294 -178
- package/src/resources/index.ts +6 -6
- package/src/resources/organization/admins.ts +36 -36
- package/src/resources/organization/brands.ts +68 -68
- package/src/resources/organization/index.ts +3 -3
- package/src/resources/organization/organization.ts +3 -3
- package/src/resources/organization/teams.ts +54 -54
- package/src/resources/reports.ts +311 -262
- package/src/resources/support/conversation-tags.ts +62 -62
- package/src/resources/support/conversations/conversations.ts +429 -419
- package/src/resources/support/conversations/index.ts +4 -4
- package/src/resources/support/conversations/participants.ts +2 -2
- package/src/resources/support/index.ts +7 -7
- package/src/resources/support/support.ts +7 -7
- package/src/resources/support/tickets/categories.ts +35 -35
- package/src/resources/support/tickets/custom-fields.ts +29 -29
- package/src/resources/support/tickets/index.ts +4 -4
- package/src/resources/support/tickets/statuses.ts +31 -31
- package/src/resources/support/tickets/tickets.ts +101 -101
- package/src/resources/surveys.ts +60 -60
- package/src/resources/users/companies/companies.ts +158 -172
- package/src/resources/users/companies/contacts.ts +3 -3
- package/src/resources/users/companies/index.ts +2 -2
- package/src/resources/users/contacts/by-user-id/by-user-id.ts +2 -2
- package/src/resources/users/contacts/by-user-id/email-preferences.ts +2 -2
- package/src/resources/users/contacts/contacts.ts +284 -280
- package/src/resources/users/contacts/email-preferences.ts +2 -2
- package/src/resources/users/contacts/index.ts +3 -3
- package/src/resources/users/index.ts +5 -5
- package/src/resources/users/users.ts +5 -5
- package/src/resources/webhooks.ts +106 -100
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/reports.d.mts
CHANGED
|
@@ -6,6 +6,43 @@ import { RequestOptions } from "../internal/request-options.mjs";
|
|
|
6
6
|
* Query your workspace analytics: conversation volume, response times, CSAT, SLA compliance, teammate performance, AI agent resolutions and more. Start with the datasets catalog to discover metrics and attributes, then run queries with filters, grouping and period comparison.
|
|
7
7
|
*/
|
|
8
8
|
export declare class Reports extends APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Returns the paginated row-level records behind a metric — either the whole
|
|
11
|
+
* reporting window, or one specific data point from a previous
|
|
12
|
+
* `POST /v2/reports/query` response.
|
|
13
|
+
*
|
|
14
|
+
* Send the **same** `metric`, date range, `granularity`, `filters`, `groupBy` /
|
|
15
|
+
* `segmentBy` and `view` as the query you're drilling into, plus
|
|
16
|
+
* `dataPointFilters` selecting the data point:
|
|
17
|
+
*
|
|
18
|
+
* - `timeBucket` — a `date` from the time series
|
|
19
|
+
* - `groupValue` / `segmentValue` — a `group` / `segment` value from grouped data
|
|
20
|
+
* - `dayOfWeek` + `hourOfDay` — a heatmap cell (`hourly_heatmap` view)
|
|
21
|
+
* - `flowPathId` or `sourceNodeId` + `targetNodeId` — a flow edge (`sankey` view)
|
|
22
|
+
*
|
|
23
|
+
* Pass `dataPointFilters: {}` to list all rows behind the metric for the window.
|
|
24
|
+
*
|
|
25
|
+
* Results are paginated with `page` / `pageSize` (max 200 per page);
|
|
26
|
+
* `availableColumns` describes every column the dataset can return and
|
|
27
|
+
* `defaultColumnIds` the recommended subset. Rows are keyed by column ID; identity
|
|
28
|
+
* cells (teammates, contacts) are objects with `id` + `label`.
|
|
29
|
+
*
|
|
30
|
+
* ### Version Availability
|
|
31
|
+
*
|
|
32
|
+
* This endpoint is only available in API version 2026-01-01.nova and newer, and
|
|
33
|
+
* only for workspaces with the Reports product enabled (404 otherwise).
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* ```ts
|
|
37
|
+
* const response = await client.reports.drillIn({
|
|
38
|
+
* endDate: '2026-07-15',
|
|
39
|
+
* granularity: 'day',
|
|
40
|
+
* metric: 'new_conversations',
|
|
41
|
+
* startDate: '2026-07-14',
|
|
42
|
+
* });
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
45
|
+
drillIn(params: ReportDrillInParams, options?: RequestOptions): APIPromise<ReportDrillInResponse>;
|
|
9
46
|
/**
|
|
10
47
|
* Returns the reporting catalog: every dataset available to your workspace with
|
|
11
48
|
* its metrics and attributes.
|
|
@@ -36,6 +73,37 @@ export declare class Reports extends APIResource {
|
|
|
36
73
|
* ```
|
|
37
74
|
*/
|
|
38
75
|
listDatasets(params?: ReportListDatasetsParams | null | undefined, options?: RequestOptions): APIPromise<ReportListDatasetsResponse>;
|
|
76
|
+
/**
|
|
77
|
+
* Returns the available values for a filterable attribute — use it to build valid
|
|
78
|
+
* `filters` rules for `POST /v2/reports/query`.
|
|
79
|
+
*
|
|
80
|
+
* Works for attributes whose values live in your workspace data (tags, teammates,
|
|
81
|
+
* teams, companies, plans, countries, ...). Attributes with `staticOptions` in the
|
|
82
|
+
* catalog don't need this endpoint — their value set is already inline.
|
|
83
|
+
*
|
|
84
|
+
* - `query` narrows results by search string
|
|
85
|
+
* - `selectedValues` resolves labels for values you already hold (returned
|
|
86
|
+
* alongside search results)
|
|
87
|
+
*
|
|
88
|
+
* ### Example
|
|
89
|
+
*
|
|
90
|
+
* ```json
|
|
91
|
+
* { "fieldId": "conversation.tags", "query": "bill", "limit": 20 }
|
|
92
|
+
* ```
|
|
93
|
+
*
|
|
94
|
+
* ### Version Availability
|
|
95
|
+
*
|
|
96
|
+
* This endpoint is only available in API version 2026-01-01.nova and newer, and
|
|
97
|
+
* only for workspaces with the Reports product enabled (404 otherwise).
|
|
98
|
+
*
|
|
99
|
+
* @example
|
|
100
|
+
* ```ts
|
|
101
|
+
* const response = await client.reports.lookupFilterValues({
|
|
102
|
+
* fieldId: 'conversation.tags',
|
|
103
|
+
* });
|
|
104
|
+
* ```
|
|
105
|
+
*/
|
|
106
|
+
lookupFilterValues(params: ReportLookupFilterValuesParams, options?: RequestOptions): APIPromise<ReportLookupFilterValuesResponse>;
|
|
39
107
|
/**
|
|
40
108
|
* Executes an ad-hoc reporting query: one metric + aggregation over a date range,
|
|
41
109
|
* with optional filters, grouping, segmentation and period-over-period comparison.
|
|
@@ -48,7 +116,7 @@ export declare class Reports extends APIResource {
|
|
|
48
116
|
* `percentile: 95` for p95); rate metrics use `value`.
|
|
49
117
|
* 2. Set the reporting window with `startDate` / `endDate` (ISO 8601) and a
|
|
50
118
|
* `granularity` (`hour`, `day`, `week`, `month`) for the returned time series.
|
|
51
|
-
* Reporting data is available from **July
|
|
119
|
+
* Reporting data is available from **July 14, 2026**. Windows ending earlier
|
|
52
120
|
* are rejected; crossing windows are clamped to that boundary in the requested
|
|
53
121
|
* timezone.
|
|
54
122
|
* 3. Optionally narrow with `filters` — a rule
|
|
@@ -91,7 +159,7 @@ export declare class Reports extends APIResource {
|
|
|
91
159
|
* {
|
|
92
160
|
* "metric": "new_conversations",
|
|
93
161
|
* "aggregation": "count",
|
|
94
|
-
* "startDate": "2026-07-
|
|
162
|
+
* "startDate": "2026-07-14",
|
|
95
163
|
* "endDate": "2026-07-15",
|
|
96
164
|
* "granularity": "day",
|
|
97
165
|
* "groupBy": "conversation.channel",
|
|
@@ -131,79 +199,11 @@ export declare class Reports extends APIResource {
|
|
|
131
199
|
* endDate: '2026-07-15',
|
|
132
200
|
* granularity: 'day',
|
|
133
201
|
* metric: 'new_conversations',
|
|
134
|
-
* startDate: '2026-07-
|
|
202
|
+
* startDate: '2026-07-14',
|
|
135
203
|
* });
|
|
136
204
|
* ```
|
|
137
205
|
*/
|
|
138
206
|
query(params: ReportQueryParams, options?: RequestOptions): APIPromise<ReportQueryResponse>;
|
|
139
|
-
/**
|
|
140
|
-
* Returns the available values for a filterable attribute — use it to build valid
|
|
141
|
-
* `filters` rules for `POST /v2/reports/query`.
|
|
142
|
-
*
|
|
143
|
-
* Works for attributes whose values live in your workspace data (tags, teammates,
|
|
144
|
-
* teams, companies, plans, countries, ...). Attributes with `staticOptions` in the
|
|
145
|
-
* catalog don't need this endpoint — their value set is already inline.
|
|
146
|
-
*
|
|
147
|
-
* - `query` narrows results by search string
|
|
148
|
-
* - `selectedValues` resolves labels for values you already hold (returned
|
|
149
|
-
* alongside search results)
|
|
150
|
-
*
|
|
151
|
-
* ### Example
|
|
152
|
-
*
|
|
153
|
-
* ```json
|
|
154
|
-
* { "fieldId": "conversation.tags", "query": "bill", "limit": 20 }
|
|
155
|
-
* ```
|
|
156
|
-
*
|
|
157
|
-
* ### Version Availability
|
|
158
|
-
*
|
|
159
|
-
* This endpoint is only available in API version 2026-01-01.nova and newer, and
|
|
160
|
-
* only for workspaces with the Reports product enabled (404 otherwise).
|
|
161
|
-
*
|
|
162
|
-
* @example
|
|
163
|
-
* ```ts
|
|
164
|
-
* const response = await client.reports.lookupFilterValues({
|
|
165
|
-
* fieldId: 'conversation.tags',
|
|
166
|
-
* });
|
|
167
|
-
* ```
|
|
168
|
-
*/
|
|
169
|
-
lookupFilterValues(params: ReportLookupFilterValuesParams, options?: RequestOptions): APIPromise<ReportLookupFilterValuesResponse>;
|
|
170
|
-
/**
|
|
171
|
-
* Returns the paginated row-level records behind a metric — either the whole
|
|
172
|
-
* reporting window, or one specific data point from a previous
|
|
173
|
-
* `POST /v2/reports/query` response.
|
|
174
|
-
*
|
|
175
|
-
* Send the **same** `metric`, date range, `granularity`, `filters`, `groupBy` /
|
|
176
|
-
* `segmentBy` and `view` as the query you're drilling into, plus
|
|
177
|
-
* `dataPointFilters` selecting the data point:
|
|
178
|
-
*
|
|
179
|
-
* - `timeBucket` — a `date` from the time series
|
|
180
|
-
* - `groupValue` / `segmentValue` — a `group` / `segment` value from grouped data
|
|
181
|
-
* - `dayOfWeek` + `hourOfDay` — a heatmap cell (`hourly_heatmap` view)
|
|
182
|
-
* - `flowPathId` or `sourceNodeId` + `targetNodeId` — a flow edge (`sankey` view)
|
|
183
|
-
*
|
|
184
|
-
* Pass `dataPointFilters: {}` to list all rows behind the metric for the window.
|
|
185
|
-
*
|
|
186
|
-
* Results are paginated with `page` / `pageSize` (max 200 per page);
|
|
187
|
-
* `availableColumns` describes every column the dataset can return and
|
|
188
|
-
* `defaultColumnIds` the recommended subset. Rows are keyed by column ID; identity
|
|
189
|
-
* cells (teammates, contacts) are objects with `id` + `label`.
|
|
190
|
-
*
|
|
191
|
-
* ### Version Availability
|
|
192
|
-
*
|
|
193
|
-
* This endpoint is only available in API version 2026-01-01.nova and newer, and
|
|
194
|
-
* only for workspaces with the Reports product enabled (404 otherwise).
|
|
195
|
-
*
|
|
196
|
-
* @example
|
|
197
|
-
* ```ts
|
|
198
|
-
* const response = await client.reports.drillIn({
|
|
199
|
-
* endDate: '2026-07-15',
|
|
200
|
-
* granularity: 'day',
|
|
201
|
-
* metric: 'new_conversations',
|
|
202
|
-
* startDate: '2026-07-12',
|
|
203
|
-
* });
|
|
204
|
-
* ```
|
|
205
|
-
*/
|
|
206
|
-
drillIn(params: ReportDrillInParams, options?: RequestOptions): APIPromise<ReportDrillInResponse>;
|
|
207
207
|
}
|
|
208
208
|
export interface ReportAttribute {
|
|
209
209
|
/**
|
|
@@ -308,9 +308,13 @@ export interface ReportMetric {
|
|
|
308
308
|
* Metric ID — use as `metric` in query requests.
|
|
309
309
|
*/
|
|
310
310
|
id: string;
|
|
311
|
+
algebra: ReportMetric.Algebra;
|
|
311
312
|
allowedAggregations: Array<'count' | 'sum' | 'avg' | 'median' | 'min' | 'max' | 'range' | 'percentile' | 'value'>;
|
|
312
313
|
description: string;
|
|
314
|
+
executionKind: 'pipe_aggregate' | 'pipe_computed_ratio';
|
|
313
315
|
name: string;
|
|
316
|
+
presentationFamily: 'count' | 'duration' | 'percentage' | 'decimal' | 'fibi' | 'ai';
|
|
317
|
+
releaseState: 'available' | 'unavailable';
|
|
314
318
|
/**
|
|
315
319
|
* Attribute IDs this specific metric accepts in filter expressions.
|
|
316
320
|
*/
|
|
@@ -329,6 +333,7 @@ export interface ReportMetric {
|
|
|
329
333
|
supportsPeriodComparison: boolean;
|
|
330
334
|
type: 'count' | 'percentage' | 'duration' | 'number';
|
|
331
335
|
unit: 'count' | 'percentage' | 'duration_ms' | 'number';
|
|
336
|
+
availabilityReason?: string;
|
|
332
337
|
/**
|
|
333
338
|
* Local calendar date (ISO 8601) from which this specific metric has data, when it
|
|
334
339
|
* differs from the global reporting floor. Windows ending before this date are
|
|
@@ -339,6 +344,8 @@ export interface ReportMetric {
|
|
|
339
344
|
* Whether this variant is the default selection for its `variantGroupId`.
|
|
340
345
|
*/
|
|
341
346
|
isDefaultVariant?: boolean;
|
|
347
|
+
qualifiers?: Array<string>;
|
|
348
|
+
searchAliases?: Array<string>;
|
|
342
349
|
/**
|
|
343
350
|
* Metrics sharing a `variantGroupId` are timestamp variants of one logical metric
|
|
344
351
|
* (same display `name`); each measures the same population at a different
|
|
@@ -355,6 +362,11 @@ export interface ReportMetric {
|
|
|
355
362
|
*/
|
|
356
363
|
variantLabel?: string;
|
|
357
364
|
}
|
|
365
|
+
export declare namespace ReportMetric {
|
|
366
|
+
interface Algebra {
|
|
367
|
+
kind: 'direct_aggregate' | 'pipe_computed_ratio';
|
|
368
|
+
}
|
|
369
|
+
}
|
|
358
370
|
export interface ReportSegmentDatum {
|
|
359
371
|
segment: string;
|
|
360
372
|
value: number;
|
|
@@ -453,6 +465,8 @@ export interface ReportListDatasetsResponse {
|
|
|
453
465
|
export interface ReportLookupFilterValuesResponse {
|
|
454
466
|
data: Array<ReportAttributeOption>;
|
|
455
467
|
object: 'list';
|
|
468
|
+
nextCursor?: string;
|
|
469
|
+
unavailableSelectedValues?: Array<string>;
|
|
456
470
|
}
|
|
457
471
|
export interface ReportQueryResponse {
|
|
458
472
|
meta: ReportQueryResponse.Meta;
|
|
@@ -564,23 +578,10 @@ export declare namespace ReportQueryResponse {
|
|
|
564
578
|
}
|
|
565
579
|
}
|
|
566
580
|
}
|
|
567
|
-
export interface
|
|
568
|
-
/**
|
|
569
|
-
* API version for this request. Defaults to your organization's configured API
|
|
570
|
-
* version if not specified.
|
|
571
|
-
*/
|
|
572
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
573
|
-
}
|
|
574
|
-
export interface ReportQueryParams {
|
|
575
|
-
/**
|
|
576
|
-
* Body param: Aggregation function applied to the metric. Each metric supports a
|
|
577
|
-
* subset of aggregations — see the `allowedAggregations` field in the
|
|
578
|
-
* `GET /v2/reports/datasets` catalog.
|
|
579
|
-
*/
|
|
580
|
-
aggregation: 'count' | 'sum' | 'avg' | 'median' | 'min' | 'max' | 'range' | 'percentile' | 'value';
|
|
581
|
+
export interface ReportDrillInParams {
|
|
581
582
|
/**
|
|
582
583
|
* Body param: End of the reporting window (ISO 8601 date or datetime, inclusive).
|
|
583
|
-
* Windows ending before 2026-07-
|
|
584
|
+
* Windows ending before 2026-07-14 are rejected.
|
|
584
585
|
*/
|
|
585
586
|
endDate: string;
|
|
586
587
|
/**
|
|
@@ -588,26 +589,30 @@ export interface ReportQueryParams {
|
|
|
588
589
|
*/
|
|
589
590
|
granularity: 'hour' | 'day' | 'week' | 'month';
|
|
590
591
|
/**
|
|
591
|
-
* Body param: Metric ID
|
|
592
|
-
* via `GET /v2/reports/datasets`.
|
|
592
|
+
* Body param: Metric ID the drill-in belongs to.
|
|
593
593
|
*/
|
|
594
594
|
metric: string;
|
|
595
595
|
/**
|
|
596
596
|
* Body param: Start of the reporting window (ISO 8601 date or datetime,
|
|
597
|
-
* inclusive). Reporting data is available from 2026-07-
|
|
597
|
+
* inclusive). Reporting data is available from 2026-07-14; crossing windows are
|
|
598
598
|
* clamped to that boundary.
|
|
599
599
|
*/
|
|
600
600
|
startDate: string;
|
|
601
601
|
/**
|
|
602
|
-
* Body param:
|
|
603
|
-
* `compareStartDate`.
|
|
602
|
+
* Body param: Stable editor ID of the saved chart that launched this drill-in.
|
|
604
603
|
*/
|
|
605
|
-
|
|
604
|
+
chartEditorId?: string;
|
|
606
605
|
/**
|
|
607
|
-
* Body param:
|
|
608
|
-
*
|
|
606
|
+
* Body param: Column IDs to include in each returned row. Omit for legacy
|
|
607
|
+
* full-width static rows; pass an empty array to use `defaultColumnIds`.
|
|
609
608
|
*/
|
|
610
|
-
|
|
609
|
+
columns?: Array<string>;
|
|
610
|
+
/**
|
|
611
|
+
* Body param: Narrows the drill-in to one data point from a previous query (time
|
|
612
|
+
* bucket, group value, heatmap cell, or flow edge). Pass `{}` to list all
|
|
613
|
+
* underlying rows.
|
|
614
|
+
*/
|
|
615
|
+
dataPointFilters?: ReportDrillInParams.DataPointFilters;
|
|
611
616
|
/**
|
|
612
617
|
* Body param: Filter expression: a single rule, or an `and`/`or` group combining
|
|
613
618
|
* rules and nested groups. Attribute IDs and their allowed operators come from
|
|
@@ -615,61 +620,43 @@ export interface ReportQueryParams {
|
|
|
615
620
|
*/
|
|
616
621
|
filters?: ReportFilterRule | ReportFilterExpression;
|
|
617
622
|
/**
|
|
618
|
-
* Body param
|
|
619
|
-
* `supportsGroupBy` in the catalog.
|
|
623
|
+
* Body param
|
|
620
624
|
*/
|
|
621
625
|
groupBy?: string;
|
|
622
626
|
/**
|
|
623
|
-
* Body param
|
|
624
|
-
* supported by some metrics (see `supportsOfficeHours` in the catalog).
|
|
627
|
+
* Body param
|
|
625
628
|
*/
|
|
626
629
|
officeHoursOnly?: boolean;
|
|
627
630
|
/**
|
|
628
|
-
* Body param:
|
|
631
|
+
* Body param: Page number (1-based).
|
|
629
632
|
*/
|
|
630
|
-
|
|
633
|
+
page?: number;
|
|
631
634
|
/**
|
|
632
|
-
* Body param:
|
|
633
|
-
* bucket.
|
|
635
|
+
* Body param: Rows per page (1-200, default 25).
|
|
634
636
|
*/
|
|
635
|
-
|
|
637
|
+
pageSize?: number;
|
|
636
638
|
/**
|
|
637
|
-
* Body param
|
|
638
|
-
* synthetic `__other__` / `Other` segment. Only supported for additive
|
|
639
|
-
* aggregations (`count`, `sum`, `value`) and not for percentage metrics. The
|
|
640
|
-
* `__other__` segment cannot be drilled into. Requires `segmentBy` and
|
|
641
|
-
* `segmentTopValuesLimit`.
|
|
639
|
+
* Body param
|
|
642
640
|
*/
|
|
643
|
-
|
|
641
|
+
segmentBy?: string;
|
|
644
642
|
/**
|
|
645
|
-
* Body param:
|
|
646
|
-
*
|
|
647
|
-
*
|
|
648
|
-
* the ranking is applied within each retained parent group. Allowed values: `5`,
|
|
649
|
-
* `7`, `10`, `15`, `20`. Requires `segmentBy`.
|
|
643
|
+
* Body param: A metric ID from the datasets catalog. Use when the originating
|
|
644
|
+
* chart aggregates several metrics to pick which one the drill-in follows.
|
|
645
|
+
* Defaults to `metric`.
|
|
650
646
|
*/
|
|
651
|
-
|
|
647
|
+
selectedMetricId?: string;
|
|
652
648
|
/**
|
|
653
|
-
* Body param:
|
|
654
|
-
* label `Other` that sums the values of every `groupBy` value outside the top set.
|
|
655
|
-
* Only supported for additive aggregations (`count`, `sum`, `value`) and not for
|
|
656
|
-
* percentage metrics. The `__other__` group cannot be drilled into. Requires
|
|
657
|
-
* `groupBy` and `topValuesLimit`.
|
|
649
|
+
* Body param: Stable metric-row ID selected within the launching chart.
|
|
658
650
|
*/
|
|
659
|
-
|
|
651
|
+
selectedMetricRowId?: string;
|
|
660
652
|
/**
|
|
661
|
-
* Body param
|
|
662
|
-
* to UTC.
|
|
653
|
+
* Body param
|
|
663
654
|
*/
|
|
664
|
-
|
|
655
|
+
sort?: Array<ReportDrillInParams.Sort>;
|
|
665
656
|
/**
|
|
666
|
-
* Body param
|
|
667
|
-
* selected metric/aggregation over the full filtered primary range. Allowed
|
|
668
|
-
* values: `5`, `7`, `10`, `15`, `20`. The ranked set is stable across every time
|
|
669
|
-
* bucket, and a comparison period reuses the primary period's ranked set (never
|
|
670
|
-
* re-ranked). Requires `groupBy`.
|
|
657
|
+
* Body param
|
|
671
658
|
*/
|
|
672
|
-
|
|
659
|
+
timezone?: string;
|
|
673
660
|
/**
|
|
674
661
|
* Body param: Result shape. `standard` returns a time series (plus grouped/segment
|
|
675
662
|
* data when requested), `hourly_heatmap` buckets by day-of-week × hour-of-day,
|
|
@@ -681,7 +668,61 @@ export interface ReportQueryParams {
|
|
|
681
668
|
* Header param: API version for this request. Defaults to your organization's
|
|
682
669
|
* configured API version if not specified.
|
|
683
670
|
*/
|
|
684
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
671
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
672
|
+
}
|
|
673
|
+
export declare namespace ReportDrillInParams {
|
|
674
|
+
/**
|
|
675
|
+
* Narrows the drill-in to one data point from a previous query (time bucket, group
|
|
676
|
+
* value, heatmap cell, or flow edge). Pass `{}` to list all underlying rows.
|
|
677
|
+
*/
|
|
678
|
+
interface DataPointFilters {
|
|
679
|
+
/**
|
|
680
|
+
* Day of week (1 = Monday … 7 = Sunday) — for `hourly_heatmap` views.
|
|
681
|
+
*/
|
|
682
|
+
dayOfWeek?: number;
|
|
683
|
+
/**
|
|
684
|
+
* Flow path ID — for `sankey` views.
|
|
685
|
+
*/
|
|
686
|
+
flowPathId?: string;
|
|
687
|
+
/**
|
|
688
|
+
* Group value to drill into (a `group` value from `groupedData`).
|
|
689
|
+
*/
|
|
690
|
+
groupValue?: string;
|
|
691
|
+
/**
|
|
692
|
+
* Hour of day (0-23) — for `hourly_heatmap` views.
|
|
693
|
+
*/
|
|
694
|
+
hourOfDay?: number;
|
|
695
|
+
/**
|
|
696
|
+
* Segment value to drill into (a `segment` value from segment data).
|
|
697
|
+
*/
|
|
698
|
+
segmentValue?: string;
|
|
699
|
+
/**
|
|
700
|
+
* Flow source node ID — for `sankey` views.
|
|
701
|
+
*/
|
|
702
|
+
sourceNodeId?: string;
|
|
703
|
+
/**
|
|
704
|
+
* Flow target node ID — for `sankey` views.
|
|
705
|
+
*/
|
|
706
|
+
targetNodeId?: string;
|
|
707
|
+
/**
|
|
708
|
+
* Time bucket to drill into (a `date` value from the query time series).
|
|
709
|
+
*/
|
|
710
|
+
timeBucket?: string;
|
|
711
|
+
}
|
|
712
|
+
interface Sort {
|
|
713
|
+
direction: 'asc' | 'desc';
|
|
714
|
+
/**
|
|
715
|
+
* Column ID to sort by (an attribute ID or `metric.value`).
|
|
716
|
+
*/
|
|
717
|
+
fieldId: string;
|
|
718
|
+
}
|
|
719
|
+
}
|
|
720
|
+
export interface ReportListDatasetsParams {
|
|
721
|
+
/**
|
|
722
|
+
* API version for this request. Defaults to your organization's configured API
|
|
723
|
+
* version if not specified.
|
|
724
|
+
*/
|
|
725
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
685
726
|
}
|
|
686
727
|
export interface ReportLookupFilterValuesParams {
|
|
687
728
|
/**
|
|
@@ -689,14 +730,34 @@ export interface ReportLookupFilterValuesParams {
|
|
|
689
730
|
* `valueSource: "remote_search"` or static options in the catalog).
|
|
690
731
|
*/
|
|
691
732
|
fieldId: string;
|
|
733
|
+
/**
|
|
734
|
+
* Body param
|
|
735
|
+
*/
|
|
736
|
+
cursor?: string;
|
|
737
|
+
/**
|
|
738
|
+
* Body param
|
|
739
|
+
*/
|
|
740
|
+
datasetId?: string;
|
|
741
|
+
/**
|
|
742
|
+
* Body param
|
|
743
|
+
*/
|
|
744
|
+
groupBy?: string;
|
|
692
745
|
/**
|
|
693
746
|
* Body param: Maximum number of options to return (1-50, default 20).
|
|
694
747
|
*/
|
|
695
748
|
limit?: number;
|
|
749
|
+
/**
|
|
750
|
+
* Body param
|
|
751
|
+
*/
|
|
752
|
+
metricId?: string;
|
|
696
753
|
/**
|
|
697
754
|
* Body param: Optional search string to narrow the returned options.
|
|
698
755
|
*/
|
|
699
756
|
query?: string;
|
|
757
|
+
/**
|
|
758
|
+
* Body param
|
|
759
|
+
*/
|
|
760
|
+
segmentBy?: string;
|
|
700
761
|
/**
|
|
701
762
|
* Body param: Already-selected values to resolve labels for (returned alongside
|
|
702
763
|
* search results).
|
|
@@ -706,12 +767,18 @@ export interface ReportLookupFilterValuesParams {
|
|
|
706
767
|
* Header param: API version for this request. Defaults to your organization's
|
|
707
768
|
* configured API version if not specified.
|
|
708
769
|
*/
|
|
709
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
770
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
710
771
|
}
|
|
711
|
-
export interface
|
|
772
|
+
export interface ReportQueryParams {
|
|
773
|
+
/**
|
|
774
|
+
* Body param: Aggregation function applied to the metric. Each metric supports a
|
|
775
|
+
* subset of aggregations — see the `allowedAggregations` field in the
|
|
776
|
+
* `GET /v2/reports/datasets` catalog.
|
|
777
|
+
*/
|
|
778
|
+
aggregation: 'count' | 'sum' | 'avg' | 'median' | 'min' | 'max' | 'range' | 'percentile' | 'value';
|
|
712
779
|
/**
|
|
713
780
|
* Body param: End of the reporting window (ISO 8601 date or datetime, inclusive).
|
|
714
|
-
* Windows ending before 2026-07-
|
|
781
|
+
* Windows ending before 2026-07-14 are rejected.
|
|
715
782
|
*/
|
|
716
783
|
endDate: string;
|
|
717
784
|
/**
|
|
@@ -719,30 +786,26 @@ export interface ReportDrillInParams {
|
|
|
719
786
|
*/
|
|
720
787
|
granularity: 'hour' | 'day' | 'week' | 'month';
|
|
721
788
|
/**
|
|
722
|
-
* Body param: Metric ID
|
|
789
|
+
* Body param: Metric ID to query (e.g. `new_conversations`). Discover metric IDs
|
|
790
|
+
* via `GET /v2/reports/datasets`.
|
|
723
791
|
*/
|
|
724
792
|
metric: string;
|
|
725
793
|
/**
|
|
726
794
|
* Body param: Start of the reporting window (ISO 8601 date or datetime,
|
|
727
|
-
* inclusive). Reporting data is available from 2026-07-
|
|
795
|
+
* inclusive). Reporting data is available from 2026-07-14; crossing windows are
|
|
728
796
|
* clamped to that boundary.
|
|
729
797
|
*/
|
|
730
798
|
startDate: string;
|
|
731
799
|
/**
|
|
732
|
-
* Body param:
|
|
733
|
-
|
|
734
|
-
chartEditorId?: string;
|
|
735
|
-
/**
|
|
736
|
-
* Body param: Column IDs to include in each returned row. Omit for legacy
|
|
737
|
-
* full-width static rows; pass an empty array to use `defaultColumnIds`.
|
|
800
|
+
* Body param: End of the comparison window. Must be paired with
|
|
801
|
+
* `compareStartDate`.
|
|
738
802
|
*/
|
|
739
|
-
|
|
803
|
+
compareEndDate?: string;
|
|
740
804
|
/**
|
|
741
|
-
* Body param:
|
|
742
|
-
*
|
|
743
|
-
* underlying rows.
|
|
805
|
+
* Body param: Start of the comparison window for period-over-period deltas. Must
|
|
806
|
+
* be paired with `compareEndDate`.
|
|
744
807
|
*/
|
|
745
|
-
|
|
808
|
+
compareStartDate?: string;
|
|
746
809
|
/**
|
|
747
810
|
* Body param: Filter expression: a single rule, or an `and`/`or` group combining
|
|
748
811
|
* rules and nested groups. Attribute IDs and their allowed operators come from
|
|
@@ -750,43 +813,61 @@ export interface ReportDrillInParams {
|
|
|
750
813
|
*/
|
|
751
814
|
filters?: ReportFilterRule | ReportFilterExpression;
|
|
752
815
|
/**
|
|
753
|
-
* Body param
|
|
816
|
+
* Body param: Attribute ID to group results by (e.g. `conversation.channel`). See
|
|
817
|
+
* `supportsGroupBy` in the catalog.
|
|
754
818
|
*/
|
|
755
819
|
groupBy?: string;
|
|
756
820
|
/**
|
|
757
|
-
* Body param
|
|
821
|
+
* Body param: Restrict time-based metrics to configured office hours. Only
|
|
822
|
+
* supported by some metrics (see `supportsOfficeHours` in the catalog).
|
|
758
823
|
*/
|
|
759
824
|
officeHoursOnly?: boolean;
|
|
760
825
|
/**
|
|
761
|
-
* Body param:
|
|
762
|
-
*/
|
|
763
|
-
page?: number;
|
|
764
|
-
/**
|
|
765
|
-
* Body param: Rows per page (1-200, default 25).
|
|
826
|
+
* Body param: Percentile (1-100) — required when `aggregation` is `percentile`.
|
|
766
827
|
*/
|
|
767
|
-
|
|
828
|
+
percentile?: number;
|
|
768
829
|
/**
|
|
769
|
-
* Body param
|
|
830
|
+
* Body param: Attribute ID for secondary segmentation within each group or time
|
|
831
|
+
* bucket.
|
|
770
832
|
*/
|
|
771
833
|
segmentBy?: string;
|
|
772
834
|
/**
|
|
773
|
-
* Body param:
|
|
774
|
-
*
|
|
775
|
-
*
|
|
835
|
+
* Body param: When `true`, fold `segmentBy` values outside the top set into a
|
|
836
|
+
* synthetic `__other__` / `Other` segment. Only supported for additive
|
|
837
|
+
* aggregations (`count`, `sum`, `value`) and not for percentage metrics. The
|
|
838
|
+
* `__other__` segment cannot be drilled into. Requires `segmentBy` and
|
|
839
|
+
* `segmentTopValuesLimit`.
|
|
776
840
|
*/
|
|
777
|
-
|
|
841
|
+
segmentShowOther?: boolean;
|
|
778
842
|
/**
|
|
779
|
-
* Body param:
|
|
843
|
+
* Body param: Keep only the top N `segmentBy` values per series, ranked by the
|
|
844
|
+
* selected metric over the full filtered primary range. Under a time View-by the
|
|
845
|
+
* ranked segment set is identical across every bucket; under a dimension View-by
|
|
846
|
+
* the ranking is applied within each retained parent group. Allowed values: `5`,
|
|
847
|
+
* `7`, `10`, `15`, `20`. Requires `segmentBy`.
|
|
780
848
|
*/
|
|
781
|
-
|
|
849
|
+
segmentTopValuesLimit?: 5 | 7 | 10 | 15 | 20;
|
|
782
850
|
/**
|
|
783
|
-
* Body param
|
|
851
|
+
* Body param: When `true`, append a single synthetic group with id `__other__` and
|
|
852
|
+
* label `Other` that sums the values of every `groupBy` value outside the top set.
|
|
853
|
+
* Only supported for additive aggregations (`count`, `sum`, `value`) and not for
|
|
854
|
+
* percentage metrics. The `__other__` group cannot be drilled into. Requires
|
|
855
|
+
* `groupBy` and `topValuesLimit`.
|
|
784
856
|
*/
|
|
785
|
-
|
|
857
|
+
showOther?: boolean;
|
|
786
858
|
/**
|
|
787
|
-
* Body param
|
|
859
|
+
* Body param: IANA timezone for date bucketing (e.g. `America/New_York`). Defaults
|
|
860
|
+
* to UTC.
|
|
788
861
|
*/
|
|
789
862
|
timezone?: string;
|
|
863
|
+
/**
|
|
864
|
+
* Body param: Keep only the top N `groupBy` (View-by) values, ranked by the
|
|
865
|
+
* selected metric/aggregation over the full filtered primary range. Allowed
|
|
866
|
+
* values: `5`, `7`, `10`, `15`, `20`. The ranked set is stable across every time
|
|
867
|
+
* bucket, and a comparison period reuses the primary period's ranked set (never
|
|
868
|
+
* re-ranked). Requires `groupBy`.
|
|
869
|
+
*/
|
|
870
|
+
topValuesLimit?: 5 | 7 | 10 | 15 | 20;
|
|
790
871
|
/**
|
|
791
872
|
* Body param: Result shape. `standard` returns a time series (plus grouped/segment
|
|
792
873
|
* data when requested), `hourly_heatmap` buckets by day-of-week × hour-of-day,
|
|
@@ -798,56 +879,9 @@ export interface ReportDrillInParams {
|
|
|
798
879
|
* Header param: API version for this request. Defaults to your organization's
|
|
799
880
|
* configured API version if not specified.
|
|
800
881
|
*/
|
|
801
|
-
'Featurebase-Version'?: '2026-01-01.nova' | '2025-12-12.clover';
|
|
802
|
-
}
|
|
803
|
-
export declare namespace ReportDrillInParams {
|
|
804
|
-
/**
|
|
805
|
-
* Narrows the drill-in to one data point from a previous query (time bucket, group
|
|
806
|
-
* value, heatmap cell, or flow edge). Pass `{}` to list all underlying rows.
|
|
807
|
-
*/
|
|
808
|
-
interface DataPointFilters {
|
|
809
|
-
/**
|
|
810
|
-
* Day of week (1 = Monday … 7 = Sunday) — for `hourly_heatmap` views.
|
|
811
|
-
*/
|
|
812
|
-
dayOfWeek?: number;
|
|
813
|
-
/**
|
|
814
|
-
* Flow path ID — for `sankey` views.
|
|
815
|
-
*/
|
|
816
|
-
flowPathId?: string;
|
|
817
|
-
/**
|
|
818
|
-
* Group value to drill into (a `group` value from `groupedData`).
|
|
819
|
-
*/
|
|
820
|
-
groupValue?: string;
|
|
821
|
-
/**
|
|
822
|
-
* Hour of day (0-23) — for `hourly_heatmap` views.
|
|
823
|
-
*/
|
|
824
|
-
hourOfDay?: number;
|
|
825
|
-
/**
|
|
826
|
-
* Segment value to drill into (a `segment` value from segment data).
|
|
827
|
-
*/
|
|
828
|
-
segmentValue?: string;
|
|
829
|
-
/**
|
|
830
|
-
* Flow source node ID — for `sankey` views.
|
|
831
|
-
*/
|
|
832
|
-
sourceNodeId?: string;
|
|
833
|
-
/**
|
|
834
|
-
* Flow target node ID — for `sankey` views.
|
|
835
|
-
*/
|
|
836
|
-
targetNodeId?: string;
|
|
837
|
-
/**
|
|
838
|
-
* Time bucket to drill into (a `date` value from the query time series).
|
|
839
|
-
*/
|
|
840
|
-
timeBucket?: string;
|
|
841
|
-
}
|
|
842
|
-
interface Sort {
|
|
843
|
-
direction: 'asc' | 'desc';
|
|
844
|
-
/**
|
|
845
|
-
* Column ID to sort by (an attribute ID or `metric.value`).
|
|
846
|
-
*/
|
|
847
|
-
fieldId: string;
|
|
848
|
-
}
|
|
882
|
+
'Featurebase-Version'?: '2026-08-19.orbit' | '2026-01-01.nova' | '2025-12-12.clover';
|
|
849
883
|
}
|
|
850
884
|
export declare namespace Reports {
|
|
851
|
-
export { type ReportAttribute as ReportAttribute, type ReportAttributeOption as ReportAttributeOption, type ReportDataset as ReportDataset, type ReportFilterExpression as ReportFilterExpression, type ReportFilterRule as ReportFilterRule, type ReportGroupedDatum as ReportGroupedDatum, type ReportMetric as ReportMetric, type ReportSegmentDatum as ReportSegmentDatum, type ReportTimeSeriesDatum as ReportTimeSeriesDatum, type ReportDrillInResponse as ReportDrillInResponse, type ReportListDatasetsResponse as ReportListDatasetsResponse, type ReportLookupFilterValuesResponse as ReportLookupFilterValuesResponse, type ReportQueryResponse as ReportQueryResponse, type
|
|
885
|
+
export { type ReportAttribute as ReportAttribute, type ReportAttributeOption as ReportAttributeOption, type ReportDataset as ReportDataset, type ReportFilterExpression as ReportFilterExpression, type ReportFilterRule as ReportFilterRule, type ReportGroupedDatum as ReportGroupedDatum, type ReportMetric as ReportMetric, type ReportSegmentDatum as ReportSegmentDatum, type ReportTimeSeriesDatum as ReportTimeSeriesDatum, type ReportDrillInResponse as ReportDrillInResponse, type ReportListDatasetsResponse as ReportListDatasetsResponse, type ReportLookupFilterValuesResponse as ReportLookupFilterValuesResponse, type ReportQueryResponse as ReportQueryResponse, type ReportDrillInParams as ReportDrillInParams, type ReportListDatasetsParams as ReportListDatasetsParams, type ReportLookupFilterValuesParams as ReportLookupFilterValuesParams, type ReportQueryParams as ReportQueryParams, };
|
|
852
886
|
}
|
|
853
887
|
//# sourceMappingURL=reports.d.mts.map
|