Notion: Get agent insights
Notion agents.getAgentInsights: arguments, response, policy and SDK examples.
← Agents operations · Get started
Operation notion.get_agent_insights
Provider route: GET /v1/agents/{agent_id}/insights. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/notion with npm, or alter-sdk-notion with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { NotionIntegration } from "@alter-ai/notion";
async function execute(input: Parameters<NotionIntegration["agents"]["getAgentInsights"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new NotionIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.agents.getAgentInsights(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_notion import NotionIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = NotionIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.agents.get_agent_insights(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.agent_id | JSON | Required within parent | The agent ID (a UUID), or `notion_ai` for the personal agent. Endpoint-specific restrictions still apply. |
path.agent_id (anyOf 1) | string | Alternative | |
path.agent_id (anyOf 2) | string | Alternative | Always `notion_ai` Must equal: notion_ai |
query | object | Optional | Additional keys: not allowed |
query.start_time | integer | Optional | Start of the insights window, as an epoch timestamp in seconds. Must be supplied together with `end_time`; if either is omitted the window defaults to the current billing period. Minimum: 0 |
query.end_time | integer | Optional | End of the insights window, as an epoch timestamp in seconds. Must be supplied together with `start_time`; if either is omitted the window defaults to the current billing period. Minimum: 0 |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
agent_type | string | Required within parent | One of: `notion_ai`, `custom_agent`, `autofill_custom_agent` Known values: notion_ai, custom_agent, autofill_custom_agent |
created_by | JSON | Required within parent | |
created_by (anyOf 1) | object | Alternative | Additional keys: allowed |
created_by (anyOf 1).id | string | Required within parent | |
created_by (anyOf 1).type | string | Required within parent | One of: `user`, `bot` Known values: user, bot |
created_by (anyOf 2) | null | Alternative | |
credit_limit | JSON | Required within parent | Enforced per-agent credit limit; null when none is configured, and “hidden” when the caller lacks full access to the agent. |
credit_limit (anyOf 1) | JSON | Alternative | |
credit_limit (anyOf 1) (anyOf 1) | integer | Alternative | |
credit_limit (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
credit_limit (anyOf 2) | string | Alternative | Always `hidden` Must equal: hidden |
credit_limit (anyOf 3) | null | Alternative | |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Format: uuid |
id (anyOf 2) | string | Alternative | Always `notion_ai` Must equal: notion_ai |
name | string | Required within parent | |
object | string | Required within parent | Always `agent_insights` Must equal: agent_insights |
pause_reason | JSON | Required within parent | |
pause_reason (anyOf 1) | string | Alternative | One of: `run_limit`, `credit_limit`, `runaway_credit_usage`, `workspace_credit_limit`, `owner_allowance_limit`, `failure_limit`, `mark_session_failed_autopause`, `disabled_from_workspace_settings`, `disabled_from_workspace_settings_but_resumable`, `disabled_from_api`, `disabled_from_agent_settings`, `disabled_due_to_no_members_with_access`, `disabled_due_to_lack_of_editors`, `disabled_by_notion`, `internal_error`, `needs_user_review`, `tool_unavailable` Known values: run_limit, credit_limit, runaway_credit_usage, workspace_credit_limit, owner_allowance_limit, failure_limit, mark_session_failed_autopause, disabled_from_workspace_settings, disabled_from_workspace_settings_but_resumable, disabled_from_api, disabled_from_agent_settings, disabled_due_to_no_members_with_access, disabled_due_to_lack_of_editors, disabled_by_notion, internal_error, needs_user_review, tool_unavailable |
pause_reason (anyOf 2) | null | Alternative | |
runs_completed | JSON | Required within parent | |
runs_completed (anyOf 1) | number | Alternative | Number of runs recorded for this agent within the window. |
runs_completed (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
status | string | Required within parent | One of: `active`, `disabled`, `deleted` Known values: active, disabled, deleted |
total_credits_used | JSON | Required within parent | |
total_credits_used (anyOf 1) | number | Alternative | Premium AI credits consumed by this agent within the window. Values of 1 or more are whole credits, and values below 1 have at most two significant figures. Both round down. |
total_credits_used (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: notion.get_agent_insights. Catalog operation: get_agent_insights. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Pinned headers: {"Notion-Version": "2026-03-11"}