Skip to main content
GET
TypeScript SDK

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Notion-Version
enum<string>
required

The API version to use for this request. The latest version is 2026-03-11.

Available options:
2026-03-11

Path Parameters

agent_id
required

The agent ID (a UUID), or notion_ai for the personal agent. Endpoint-specific restrictions still apply.

Query Parameters

start_time
integer

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.

Required range: x >= 0
end_time
integer

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.

Required range: x >= 0

Response

object
string
required

Always agent_insights

Allowed value: "agent_insights"
id
string<uuid>
required
name
string
required
agent_type
enum<string>
required

One of: custom_agent, autofill_custom_agent

Available options:
custom_agent,
autofill_custom_agent
status
enum<string>
required

One of: active, disabled, deleted

Available options:
active,
disabled,
deleted
pause_reason
enum<string> | null
required

One of: run_limit, credit_limit, runaway_credit_usage, workspace_credit_limit, failure_limit, mark_session_failed_autopause, disabled_from_workspace_settings, 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

Available options:
run_limit,
credit_limit,
runaway_credit_usage,
workspace_credit_limit,
failure_limit,
mark_session_failed_autopause,
disabled_from_workspace_settings,
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
created_by
object | null
required
total_credits_used
number
required

Premium AI credits consumed by this agent within the window.

credit_limit
required

Enforced per-agent credit limit; null when none is configured, and "hidden" when the caller lacks full access to the agent.

runs_completed
number
required

Number of runs recorded for this agent within the window.