Documentation Index

Fetch the complete documentation index at: https://academy.insiderone.com/llms.txt

Use this file to discover all available pages before exploring further.

Insider One MCP Functions

Prev Next

Insider One MCP provides read-only access to a limited set of analytics endpoints. These functions allow AI-powered clients to retrieve campaign and channel performance data in a controlled and permission-based manner.

Prerequisites

Before using Insider One MCP API functions, ensure the following requirements are met:

  • Insider One MCP is configured successfully.

  • Valid API keys or OAuth 2.0 credentials are provided.

  • Your Partner ID is included.

  • Your account has access to the relevant channels.

Create a dedicated key set specifically for your MCP client instead of reusing an existing API key. This helps reduce risk if an agent attempts unintended actions.

Scope of available functions

  • Analytics and reporting only

  • Read-only access

  • No data mutation or campaign actions

The following actions are not supported:

  • Campaign creation or updates

  • Message sending or triggering

  • Journey actions

  • Any write operations

When Insider One MCP is configured using OAuth 2.0 bearer token authentication, all channels are supported: Email, SMS, App Push, Web Push, WhatsApp, and Architect Journey Analytics.

When using API key authentication, only Email, SMS, App Push, and Web Push are available. WhatsApp and Architect functions require OAuth 2.0 authentication.

On-site is not currently supported in either authentication method.

Email Analytics functions

Use the following functions to retrieve Email campaign and analytics data.

Function

Endpoint

Description

Get Email Campaign List (v2)

/email/v2/campaign/list

Retrieves the list of email campaigns associated with the partner account.

Get Email Campaign Analytics (v2)

/email/v2/analytics

Returns performance metrics for individual email campaigns.

Get Overall Email Analytics (v2)

/email/v2/analytics/overall

Provides aggregated email performance metrics across all campaigns.

For more information, see:


Web Push Analytics functions

Use the following functions to retrieve Web Push analytics data.

Function

Endpoint

Description

Get Web Push Top Metrics Analytics

/web-push/analytics/top-metrics

Retrieves top-level performance metrics for Web Push campaigns.

Get Web Push Overall Metrics Analytics

/web-push/analytics/overall

Returns aggregated analytics across all Web Push campaigns.

Get Web Push Campaign Metrics Analytics

/web-push/analytics/campaign

Provides performance metrics for individual Web Push campaigns.

For more information, see:


SMS Analytics functions

Use the following functions to retrieve SMS campaign and analytics data.

Function

Endpoint

Description

Get SMS Campaign List

/sms/campaign/list

Retrieves the list of SMS campaigns for the partner account.

Get SMS Campaign Analytics

/sms/analytics

Returns analytics metrics for individual SMS campaigns.

Get Overall SMS Campaign Analytics

/sms/analytics/overall

Provides aggregated analytics across all SMS campaigns.

Get Transactional SMS Analytics

/sms/analytics/transactional

Returns analytics metrics specific to transactional SMS messages.

Get SMS OTP Verify Analytics

/sms/analytics/otp-verify

Returns analytics for SMS OTP verification messages.

For more information, see:


App Push Analytics functions

Use the following function to retrieve App Push campaign analytics data.

Function

Endpoint

Description

Get App Push Statistics

/app-push/analytics/statistics

Retrieves analytics metrics for App Push campaigns.

For more information, see:


WhatsApp Analytics functions

WhatsApp functions require OAuth 2.0 authentication and are not available with API key authentication.

Use the following functions to retrieve WhatsApp campaign and analytics data.

Function

Endpoint

Description

List WhatsApp Campaigns

/whatsapp/campaign/list

Retrieves the list of WhatsApp campaigns for the partner account.

Get WhatsApp Campaign Analytics

/whatsapp/analytics

Returns performance metrics for individual WhatsApp campaigns.

Get Overall WhatsApp Analytics

/whatsapp/analytics/overall

Provides aggregated analytics across all WhatsApp campaigns.

Get Transactional WhatsApp Analytics

/whatsapp/analytics/transactional

Returns analytics for transactional WhatsApp messages.

Get WhatsApp Verify Analytics

/whatsapp/analytics/verify

Returns analytics for WhatsApp verification messages.


Architect Analytics functions

Architect functions require OAuth 2.0 authentication and are not available with API key authentication.

Use the following functions to retrieve Architect Journey Analytics data.

Function

Endpoint

Description

Get Architect Overall Analytics

/architect/analytics/overall

Returns aggregated performance metrics across all journeys.

Get Architect Journey Analytics

/architect/analytics/journey

Provides performance metrics for individual journeys.

Get Architect Element Analytics

/architect/analytics/element

Returns step-level analytics for individual elements within a journey.

Get Architect Goals Analytics

/architect/analytics/goals

Returns goal completion metrics for journeys.

Get Architect Goals Information

/architect/goals

Retrieves the list of configured goals for journeys.


How MCP uses these functions

When a user submits an analytics-related prompt:

  • The AI client maps the prompt to one or more functions listed above.

  • Insider One MCP validates permissions and scope.

  • Approved requests are executed as read-only API calls.

  • Responses are returned as structured data to the AI client.

Your MCP client configuration contains sensitive secrets, including API keys. Treat the configuration file as a secret. Do not commit it to source control, do not share screenshots that include keys, restrict file access permissions on your machine, and rotate keys immediately if you suspect exposure.

Use dedicated least-privilege keys for MCP only.


Limitations

  • Only the functions listed on this page are accessible through Insider One MCP.

  • Function availability depends on the account’s available services.

  • Rate limits apply based on existing Insider One API policies.

  • All access is logged and permission-based.

Model Context Protocol (MCP) is a newly introduced open protocol and may be susceptible to security issues or vulnerabilities. Follow your organization’s security policies and review configurations carefully.