Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.agent_idJSONRequired within parentThe agent ID (a UUID), or `notion_ai` for the personal agent. Endpoint-specific restrictions still apply.
path.agent_id (anyOf 1)stringAlternative
path.agent_id (anyOf 2)stringAlternativeAlways `notion_ai`
Must equal: notion_ai
queryobjectOptionalAdditional keys: not allowed
query.start_timeintegerOptionalStart 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_timeintegerOptionalEnd 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 media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
agent_typestringRequired within parentOne of: `notion_ai`, `custom_agent`, `autofill_custom_agent`
Known values: notion_ai, custom_agent, autofill_custom_agent
created_byJSONRequired within parent
created_by (anyOf 1)objectAlternativeAdditional keys: allowed
created_by (anyOf 1).idstringRequired within parent
created_by (anyOf 1).typestringRequired within parentOne of: `user`, `bot`
Known values: user, bot
created_by (anyOf 2)nullAlternative
credit_limitJSONRequired within parentEnforced per-agent credit limit; null when none is configured, and “hidden” when the caller lacks full access to the agent.
credit_limit (anyOf 1)JSONAlternative
credit_limit (anyOf 1) (anyOf 1)integerAlternative
credit_limit (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
credit_limit (anyOf 2)stringAlternativeAlways `hidden`
Must equal: hidden
credit_limit (anyOf 3)nullAlternative
idJSONRequired within parent
id (anyOf 1)stringAlternativeFormat: uuid
id (anyOf 2)stringAlternativeAlways `notion_ai`
Must equal: notion_ai
namestringRequired within parent
objectstringRequired within parentAlways `agent_insights`
Must equal: agent_insights
pause_reasonJSONRequired within parent
pause_reason (anyOf 1)stringAlternativeOne 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)nullAlternative
runs_completedJSONRequired within parent
runs_completed (anyOf 1)numberAlternativeNumber of runs recorded for this agent within the window.
runs_completed (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
statusstringRequired within parentOne of: `active`, `disabled`, `deleted`
Known values: active, disabled, deleted
total_credits_usedJSONRequired within parent
total_credits_used (anyOf 1)numberAlternativePremium 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)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.