@graph8/sdk 0.265.0 → 0.293.0

package/docs/api/integrations.d.ts

@@ -2046,10 +2046,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 /** Pull every CRM contact into graph8. */

package/docs/api/intent.d.ts

@@ -273,7 +273,7 @@ export interface IntentOperations {
   };
 }
 
-// 27 schemas referenced above (the same as G8Contract.<Name>).
+// 28 schemas referenced above (the same as G8Contract.<Name>).
 
 export interface ApiResponse_KeywordCreateFromDomainResponse_ {
   data: KeywordCreateFromDomainResponse;
@@ -300,6 +300,13 @@ export interface ApiResponse_PagesSearchResponse_ {
   pagination?: PaginationMeta | null;
 }
 
+export interface CreateFromDomainSampleContact {
+  company_domain?: string | null;
+  company_name?: string | null;
+  job_title?: string | null;
+  name?: string | null;
+}
+
 export interface IntentPageItem {
   audience?: string | null;
   commercial_score?: number | null;
@@ -309,6 +316,8 @@ export interface IntentPageItem {
   summary?: string | null;
   title?: string | null;
   url?: string | null;
+  /** Distinct visitors (hashed emails) in the lookback window. Set only by pages/search with include_visitors=true when the count succeeded; null otherwise. */
+  visitors?: number | null;
 }
 
 export interface KeywordAddedItem {
@@ -324,6 +333,8 @@ export interface KeywordCreateFromDomainRequest {
   contact_limit?: number;
   /** Competitor domain to track, e.g. 'cognism.com'. */
   domain: string;
+  /** Preview only: find the on-domain pages and resolve contacts exactly as a real run would, but save nothing. The counts then say what WOULD be seeded, keyword_id stays null, and sample_pages / sample_contacts show a preview. Default false keeps the one-call create. */
+  dry_run?: boolean;
   /** Max pages to seed from the domain. */
   page_limit?: number;
 }
@@ -331,11 +342,17 @@ export interface KeywordCreateFromDomainRequest {
 export interface KeywordCreateFromDomainResponse {
   companies_seeded?: number;
   contacts_seeded?: number;
+  /** True when nothing was saved (preview). */
+  dry_run?: boolean;
   keyword: string;
   keyword_id?: string | null;
   message?: string;
   off_domain_rejected?: number;
   pages_seeded?: number;
+  /** Dry run only: up to 10 of the contacts that would be pre-resolved (no emails). */
+  sample_contacts?: Array<CreateFromDomainSampleContact>;
+  /** Dry run only: up to 10 of the pages that would be seeded. */
+  sample_pages?: Array<IntentPageItem>;
 }
 
 export interface KeywordCreateFromSearchItem {
@@ -441,11 +458,19 @@ export interface PagesSearchRequest {
 }
 
 export interface PagesSearchResponse {
+  /** Hits hidden because they had no visitors in the lookback window (include_visitors=true). total_hits counts them; pages does not. */
+  filtered_no_visitors?: number;
   mode?: string;
   pages?: Array<IntentPageItem>;
   query: string;
+  /** How this search scoped the results, when it differs from a sibling tool (e.g. a bare-domain query matches the apex + www only). */
+  scope_note?: string | null;
   took_ms?: number;
   total_hits?: number;
+  /** Why visitor enrichment was skipped (include_visitors=true only). */
+  visitors_error?: string | null;
+  /** Non-fatal problems: visitor counts timed out or failed (pages are then returned unfiltered, visitors=null), every hit was hidden by the has-visitors filter, or the search backend failed. */
+  warnings?: Array<string>;
 }
 
 export interface PagesVisitorCountsRequest {
@@ -468,10 +493,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 export interface UrlCompaniesRequest {

package/docs/api/intent.md

@@ -168,6 +168,9 @@ const result = await g8.api.intent.keywordContacts({
 
 Replace a keyword's `search_filters` JSON.
 
+404 when the keyword does not exist for this org or was deleted (IN-07:
+the bare ALTER matched no row and still answered "success").
+
 **Input**
 
 | Field | Type | Required | Description |
@@ -339,6 +342,7 @@ Body fields (`KeywordCreateFromDomainRequest`):
 |---|---|---|---|
 | `body.domain` | `string` | yes | Competitor domain to track, e.g. 'cognism.com'. min length 3, max length 253 |
 | `body.contact_limit` | `integer` | no | Max contacts to pre-resolve. default `200`, min 1, max 500 |
+| `body.dry_run` | `boolean` | no | Preview only: find the on-domain pages and resolve contacts exactly as a real run would, but save nothing. The counts then say what WOULD be seeded, keyword_id stays null, and sample_pages / sample_contacts show a preview. Default false keeps the one-call create. default `false` |
 | `body.page_limit` | `integer` | no | Max pages to seed from the domain. default `200`, min 1, max 500 |
 
 **Returns** `ApiResponse_KeywordCreateFromDomainResponse_`: the envelope `{ data: KeywordCreateFromDomainResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
@@ -352,10 +356,13 @@ Other envelope fields: `pagination` (PaginationMeta).
 | `keyword` | `string` | yes |  |
 | `companies_seeded` | `integer` | no | default `0` |
 | `contacts_seeded` | `integer` | no | default `0` |
+| `dry_run` | `boolean` | no | True when nothing was saved (preview). default `false` |
 | `keyword_id` | `string \| null` | no |  |
 | `message` | `string` | no | default `""` |
 | `off_domain_rejected` | `integer` | no | default `0` |
 | `pages_seeded` | `integer` | no | default `0` |
+| `sample_contacts` | `Array<CreateFromDomainSampleContact>` | no | Dry run only: up to 10 of the contacts that would be pre-resolved (no emails). |
+| `sample_pages` | `Array<IntentPageItem>` | no | Dry run only: up to 10 of the pages that would be seeded. |
 
 **Example**
 
@@ -652,10 +659,14 @@ Other envelope fields: `pagination` (PaginationMeta).
 | Field | Type | Required | Description |
 |---|---|---|---|
 | `query` | `string` | yes |  |
+| `filtered_no_visitors` | `integer` | no | Hits hidden because they had no visitors in the lookback window (include_visitors=true). total_hits counts them; pages does not. default `0` |
 | `mode` | `string` | no | default `"text"` |
 | `pages` | `Array<IntentPageItem>` | no | default `[]` |
+| `scope_note` | `string \| null` | no | How this search scoped the results, when it differs from a sibling tool (e.g. a bare-domain query matches the apex + www only). |
 | `took_ms` | `integer` | no | default `0` |
 | `total_hits` | `integer` | no | default `0` |
+| `visitors_error` | `string \| null` | no | Why visitor enrichment was skipped (include_visitors=true only). |
+| `warnings` | `Array<string>` | no | Non-fatal problems: visitor counts timed out or failed (pages are then returned unfiltered, visitors=null), every hit was hidden by the has-visitors filter, or the search backend failed. |
 
 **Example**
 
@@ -808,6 +819,17 @@ const result = await g8.api.intent.urlCompanies({ body: { url: "https://example.
 
 Named types that appear in the tables above. Full TypeScript definitions: `G8Contract.<Name>` (`import type { G8Contract } from "@graph8/sdk"`).
 
+<a id="type-createfromdomainsamplecontact"></a>
+
+### `CreateFromDomainSampleContact`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `company_domain` | `string \| null` | no |  |
+| `company_name` | `string \| null` | no |  |
+| `job_title` | `string \| null` | no |  |
+| `name` | `string \| null` | no |  |
+
 <a id="type-intentpageitem"></a>
 
 ### `IntentPageItem`
@@ -822,6 +844,7 @@ Named types that appear in the tables above. Full TypeScript definitions: `G8Con
 | `summary` | `string \| null` | no |  |
 | `title` | `string \| null` | no |  |
 | `url` | `string \| null` | no |  |
+| `visitors` | `integer \| null` | no | Distinct visitors (hashed emails) in the lookback window. Set only by pages/search with include_visitors=true when the count succeeded; null otherwise. |
 
 <a id="type-keywordaddeditem"></a>
 

package/docs/api/knowledge.d.ts

@@ -468,10 +468,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 /**

package/docs/api/knowledgeBase.d.ts

@@ -77,8 +77,14 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }

package/docs/api/landingPages.d.ts

@@ -1330,10 +1330,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 /**

package/docs/api/leads.d.ts

@@ -126,8 +126,14 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }

package/docs/api/library.d.ts

@@ -199,10 +199,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 /** One Studio object, open-shaped. See the module docstring. */

package/docs/api/linkedIn.d.ts

@@ -220,8 +220,14 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }

package/docs/api/linkedInOutreach.d.ts

@@ -720,8 +720,14 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }

package/docs/api/lists.d.ts

@@ -783,8 +783,14 @@ export interface ApiResponse_list_ListResponse__ {
 /** Lighter contact representation for list endpoints. */
 export interface ContactListItem {
   city?: string | null;
+  company_domain?: string | null;
+  company_employee_count?: string | null;
   company_id?: number | null;
+  company_industry?: string | null;
+  company_name?: string | null;
+  company_website?: string | null;
   country?: string | null;
+  created_at?: string | null;
   custom_fields?: (Record<string, string | null>) | null;
   direct_phone?: string | null;
   first_name?: string | null;
@@ -798,6 +804,7 @@ export interface ContactListItem {
   owner_name?: string | null;
   seniority_level?: string | null;
   state?: string | null;
+  updated_at?: string | null;
   work_email?: string | null;
 }
 
@@ -889,11 +896,15 @@ export interface ListCreateRequest {
 
 export interface ListCreateResponse {
   description?: string | null;
+  /** Ids of existing lists with the same name (case-insensitive), when any. */
+  duplicate_list_ids?: Array<number> | null;
   id: number;
   status?: string | null;
   title: string;
   total?: number;
   type?: string | null;
+  /** Set when another list already has this name. The list was still created. */
+  warning?: string | null;
 }
 
 /**
@@ -992,6 +1003,10 @@ export interface ListPerformanceResponse {
 
 /** Audience/list representation for the public API. */
 export interface ListResponse {
+  /** Number of companies in a company list (null for other list types) */
+  company_count?: number | null;
+  /** Number of contacts in a contact list (null for other list types) */
+  contact_count?: number | null;
   created_at?: string | null;
   created_by?: string | null;
   /** Agent/human-readable note describing the list's purpose (#16641) */
@@ -1006,6 +1021,7 @@ export interface ListResponse {
   total?: number;
   /** List type (contacts, companies, suppressions, deals, leads) */
   type?: string | null;
+  /** Last change to the list. Equals created_at for a list never edited since creation. */
   updated_at?: string | null;
 }
 
@@ -1030,10 +1046,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 /**

package/docs/api/lists.md

@@ -75,6 +75,10 @@ Exact TypeScript types for every operation on this page, and every schema they u
 
 Add contacts to a list by their IDs.
 
+``added`` is the number of membership rows really created. Ids that are not
+live contacts in this org come back in ``not_found``; ids already on the
+list in ``already_member`` (LI-01). A missing or deleted list is a 404.
+
 **Input**
 
 | Field | Type | Required | Description |
@@ -350,9 +354,11 @@ Other envelope fields: `pagination` (PaginationMeta).
 | `id` | `integer` | yes |  |
 | `title` | `string` | yes |  |
 | `description` | `string \| null` | no |  |
+| `duplicate_list_ids` | `Array<integer> \| null` | no | Ids of existing lists with the same name (case-insensitive), when any. |
 | `status` | `string \| null` | no |  |
 | `total` | `integer` | no | default `0` |
 | `type` | `string \| null` | no |  |
+| `warning` | `string \| null` | no | Set when another list already has this name. The list was still created. |
 
 **Example**
 
@@ -815,8 +821,14 @@ Other envelope fields: `pagination` (PaginationMeta).
 | Field | Type | Required | Description |
 |---|---|---|---|
 | `city` | `string \| null` | no |  |
+| `company_domain` | `string \| null` | no |  |
+| `company_employee_count` | `string \| null` | no |  |
 | `company_id` | `integer \| null` | no |  |
+| `company_industry` | `string \| null` | no |  |
+| `company_name` | `string \| null` | no |  |
+| `company_website` | `string \| null` | no |  |
 | `country` | `string \| null` | no |  |
+| `created_at` | `string \| null` | no |  |
 | `custom_fields` | `Record<string, string \| null> \| null` | no |  |
 | `direct_phone` | `string \| null` | no |  |
 | `first_name` | `string \| null` | no |  |
@@ -830,6 +842,7 @@ Other envelope fields: `pagination` (PaginationMeta).
 | `owner_name` | `string \| null` | no |  |
 | `seniority_level` | `string \| null` | no |  |
 | `state` | `string \| null` | no |  |
+| `updated_at` | `string \| null` | no |  |
 | `work_email` | `string \| null` | no |  |
 
 **Example**
@@ -1069,6 +1082,8 @@ Other envelope fields: `pagination` (PaginationMeta).
 |---|---|---|---|
 | `id` | `integer` | yes |  |
 | `title` | `string` | yes |  |
+| `company_count` | `integer \| null` | no | Number of companies in a company list (null for other list types) |
+| `contact_count` | `integer \| null` | no | Number of contacts in a contact list (null for other list types) |
 | `created_at` | `string (date-time) \| null` | no |  |
 | `created_by` | `string \| null` | no |  |
 | `description` | `string \| null` | no | Agent/human-readable note describing the list's purpose (#16641) |
@@ -1078,7 +1093,7 @@ Other envelope fields: `pagination` (PaginationMeta).
 | `tags` | `Array<string>` | no |  |
 | `total` | `integer` | no | default `0` |
 | `type` | `string \| null` | no | List type (contacts, companies, suppressions, deals, leads) |
-| `updated_at` | `string (date-time) \| null` | no |  |
+| `updated_at` | `string (date-time) \| null` | no | Last change to the list. Equals created_at for a list never edited since creation. |
 
 **Example**
 
@@ -1374,6 +1389,11 @@ const result = await g8.api.lists.refreshMasterListNow({ path: { audience_id: 12
 
 Remove contacts from a list.
 
+``removed`` is the number of membership rows really deleted; requested ids
+that were not on the list come back in ``not_member`` (LI-01). A missing or
+deleted list is a 404 (a deleted list's membership is frozen, so nothing
+could be removed from it anyway).
+
 **Input**
 
 | Field | Type | Required | Description |
@@ -1476,6 +1496,8 @@ Other envelope fields: `pagination` (PaginationMeta).
 |---|---|---|---|
 | `id` | `integer` | yes |  |
 | `title` | `string` | yes |  |
+| `company_count` | `integer \| null` | no | Number of companies in a company list (null for other list types) |
+| `contact_count` | `integer \| null` | no | Number of contacts in a contact list (null for other list types) |
 | `created_at` | `string (date-time) \| null` | no |  |
 | `created_by` | `string \| null` | no |  |
 | `description` | `string \| null` | no | Agent/human-readable note describing the list's purpose (#16641) |
@@ -1485,7 +1507,7 @@ Other envelope fields: `pagination` (PaginationMeta).
 | `tags` | `Array<string>` | no |  |
 | `total` | `integer` | no | default `0` |
 | `type` | `string \| null` | no | List type (contacts, companies, suppressions, deals, leads) |
-| `updated_at` | `string (date-time) \| null` | no |  |
+| `updated_at` | `string (date-time) \| null` | no | Last change to the list. Equals created_at for a list never edited since creation. |
 
 **Example**
 

package/docs/api/logs.d.ts

@@ -51,10 +51,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 export interface RequestLogEntry {

package/docs/api/mailboxes.d.ts

@@ -980,10 +980,16 @@ export interface PaginationMeta {
   limit: number;
   /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
   next_cursor?: string | null;
+  /** Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order. */
+  notes?: Array<string> | null;
   /** Current page number (1-indexed) */
   page: number;
   /** Total number of items */
   total: number;
+  /** Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search. */
+  total_available?: number | null;
+  /** Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search. */
+  total_is_lower_bound?: boolean | null;
 }
 
 /**

package/docs/api/marketingIntelligence.d.ts

@@ -43,6 +43,10 @@ export interface MarketingIntelligenceOperations {
       sort_by?: "visitors" | "meetings_booked" | "reply_rate" | "engaged_pct";
       /** Comma-separated public keys to filter by */
       write_key?: string | null;
+      /** Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. */
+      include_bots?: boolean;
+      /** Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. */
+      include_internal?: boolean;
     };
     headers?: {
       "X-Org-Id"?: string | null;
@@ -66,6 +70,10 @@ export interface MarketingIntelligenceOperations {
       sort_by?: "views" | "meetings_booked" | "reply_rate" | "unique_visitors";
       /** Comma-separated public keys to filter by */
       write_key?: string | null;
+      /** Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. */
+      include_bots?: boolean;
+      /** Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. */
+      include_internal?: boolean;
     };
     headers?: {
       "X-Org-Id"?: string | null;
@@ -87,6 +95,10 @@ export interface MarketingIntelligenceOperations {
       limit?: number;
       /** Comma-separated public keys to filter by */
       write_key?: string | null;
+      /** Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. */
+      include_bots?: boolean;
+      /** Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. */
+      include_internal?: boolean;
     };
     headers?: {
       "X-Org-Id"?: string | null;
@@ -106,6 +118,10 @@ export interface MarketingIntelligenceOperations {
       days?: number;
       /** Comma-separated public keys to filter by */
       write_key?: string | null;
+      /** Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. */
+      include_bots?: boolean;
+      /** Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. */
+      include_internal?: boolean;
     };
     headers?: {
       "X-Org-Id"?: string | null;
@@ -127,6 +143,10 @@ export interface MarketingIntelligenceOperations {
       limit?: number;
       /** Comma-separated public keys to filter by */
       write_key?: string | null;
+      /** Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. */
+      include_bots?: boolean;
+      /** Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. */
+      include_internal?: boolean;
     };
     headers?: {
       "X-Org-Id"?: string | null;
@@ -146,6 +166,10 @@ export interface MarketingIntelligenceOperations {
       days?: number;
       /** Comma-separated public keys to filter by */
       write_key?: string | null;
+      /** Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. */
+      include_bots?: boolean;
+      /** Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. */
+      include_internal?: boolean;
     };
     headers?: {
       "X-Org-Id"?: string | null;
@@ -167,6 +191,10 @@ export interface MarketingIntelligenceOperations {
       limit?: number;
       /** Comma-separated public keys to filter by */
       write_key?: string | null;
+      /** Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. */
+      include_bots?: boolean;
+      /** Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. */
+      include_internal?: boolean;
     };
     headers?: {
       "X-Org-Id"?: string | null;
@@ -186,6 +214,10 @@ export interface MarketingIntelligenceOperations {
       days?: number;
       /** Comma-separated public keys to filter by */
       write_key?: string | null;
+      /** Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. */
+      include_bots?: boolean;
+      /** Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. */
+      include_internal?: boolean;
     };
     headers?: {
       "X-Org-Id"?: string | null;
@@ -205,6 +237,10 @@ export interface MarketingIntelligenceOperations {
       days?: number;
       /** Comma-separated public keys to filter by */
       write_key?: string | null;
+      /** Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. */
+      include_bots?: boolean;
+      /** Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. */
+      include_internal?: boolean;
     };
     headers?: {
       "X-Org-Id"?: string | null;
@@ -226,6 +262,10 @@ export interface MarketingIntelligenceOperations {
       limit?: number;
       /** Comma-separated public keys to filter by */
       write_key?: string | null;
+      /** Count bot and crawler traffic too. Off by default: page views from self-identified crawlers, headless browsers, HTTP libraries and datacenter/cloud networks are excluded. Set true for the raw, unfiltered counts these reports returned before the filter existed. */
+      include_bots?: boolean;
+      /** Count internal traffic too. Off by default: page views on the graph8 app (app.graph8.com) and local development hosts, and browsers identified as your own team members (member emails and your company email domains), are excluded. */
+      include_internal?: boolean;
     };
     headers?: {
       "X-Org-Id"?: string | null;