manage_analytics_shares
Create, list, and revoke the public snapshot links that publish a campaign's frozen results.
# MCP tool reference
1 callable tools.
Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference.
Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result.
[Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt)
## manage_analytics_shares
Create, list, and revoke the public snapshot links that publish a campaign's frozen results.
Use when a result set has to leave the workspace. Creating one freezes the numbers as they are at that instant, so the link keeps reporting that moment no matter what the campaign does afterwards.
A snapshot is readable by anyone who receives the link and can never be edited — only revoked. Do not use it for live data, for row-level exports, or to work around someone's lack of workspace access.
Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token.
Scopes: analytics:export
Risk: write; confirmation: explicit; idempotency: supported.
### Input schema (personal API key)
```json
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"create",
"list",
"revoke"
]
},
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"shareId": {
"$ref": "#/$defs/AnalyticsShareId"
},
"create": {
"type": "object",
"properties": {
"startDate": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"endDate": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"senderProviders": {
"type": "array",
"items": {
"type": "string",
"enum": [
"google",
"microsoft",
"other"
]
},
"maxItems": 3
},
"recipientProviders": {
"type": "array",
"items": {
"type": "string",
"enum": [
"google",
"microsoft",
"other"
]
},
"maxItems": 3
},
"senderTagIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"maxItems": 100
},
"senderDomains": {
"type": "array",
"items": {
"$ref": "#/$defs/DomainNameEncoded"
},
"maxItems": 100
},
"title": {
"$ref": "#/$defs/AnalyticsShareTitle"
},
"includeCampaignName": {
"type": "boolean"
},
"expiresInDays": {
"anyOf": [
{
"type": "number",
"enum": [
7,
30
]
},
{
"type": "null"
}
]
}
},
"patternProperties": {
"^(?!(?:startDate|endDate|senderProviders|recipientProviders|senderTagIds|senderDomains|title|includeCampaignName|expiresInDays)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"startDate",
"endDate",
"senderProviders",
"recipientProviders",
"senderTagIds",
"senderDomains",
"title",
"includeCampaignName",
"expiresInDays"
]
}
}
},
"required": [
"action",
"workspaceId"
],
"patternProperties": {
"^(?!(?:action|workspaceId|campaignId|shareId|create)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"action",
"workspaceId",
"campaignId",
"shareId",
"create"
]
},
"$defs": {
"AnalyticsShareId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"UtcDateTimeEncoded": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
},
"DomainNameEncoded": {
"type": "string"
},
"AnalyticsShareTitle": {
"type": "string",
"minLength": 1,
"maxLength": 120
}
}
}
```
### Input schema (OAuth / delegated agent)
```json
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"create",
"list",
"revoke"
]
},
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"shareId": {
"$ref": "#/$defs/AnalyticsShareId"
},
"create": {
"type": "object",
"properties": {
"startDate": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"endDate": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"senderProviders": {
"type": "array",
"items": {
"type": "string",
"enum": [
"google",
"microsoft",
"other"
]
},
"maxItems": 3
},
"recipientProviders": {
"type": "array",
"items": {
"type": "string",
"enum": [
"google",
"microsoft",
"other"
]
},
"maxItems": 3
},
"senderTagIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"maxItems": 100
},
"senderDomains": {
"type": "array",
"items": {
"$ref": "#/$defs/DomainNameEncoded"
},
"maxItems": 100
},
"title": {
"$ref": "#/$defs/AnalyticsShareTitle"
},
"includeCampaignName": {
"type": "boolean"
},
"expiresInDays": {
"anyOf": [
{
"type": "number",
"enum": [
7,
30
]
},
{
"type": "null"
}
]
}
},
"patternProperties": {
"^(?!(?:startDate|endDate|senderProviders|recipientProviders|senderTagIds|senderDomains|title|includeCampaignName|expiresInDays)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"startDate",
"endDate",
"senderProviders",
"recipientProviders",
"senderTagIds",
"senderDomains",
"title",
"includeCampaignName",
"expiresInDays"
]
}
}
},
"required": [
"action",
"workspaceId"
],
"patternProperties": {
"^(?!(?:action|workspaceId|campaignId|shareId|create)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"action",
"workspaceId",
"campaignId",
"shareId",
"create"
]
},
"$defs": {
"AnalyticsShareId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"UtcDateTimeEncoded": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
},
"DomainNameEncoded": {
"type": "string"
},
"AnalyticsShareTitle": {
"type": "string",
"minLength": 1,
"maxLength": 120
}
}
}
```
### Output schema (structuredContent)
```json
{
"$defs": {
"AnalyticsShareId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"AnalyticsShareToken": {
"type": "string",
"minLength": 32,
"maxLength": 32,
"pattern": "^[A-Za-z0-9_-]+$"
},
"AnalyticsShareTitle": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"UtcDateTimeEncoded": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
}
},
"type": "object",
"anyOf": [
{
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/AnalyticsShareId"
},
"token": {
"$ref": "#/$defs/AnalyticsShareToken"
},
"title": {
"$ref": "#/$defs/AnalyticsShareTitle"
},
"expiresAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"revokedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"id",
"token",
"title",
"expiresAt",
"revokedAt",
"createdAt"
],
"patternProperties": {
"^(?!(?:id|token|title|expiresAt|revokedAt|createdAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"token",
"title",
"expiresAt",
"revokedAt",
"createdAt"
]
}
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/AnalyticsShareId"
},
"token": {
"$ref": "#/$defs/AnalyticsShareToken"
},
"title": {
"$ref": "#/$defs/AnalyticsShareTitle"
},
"expiresAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"revokedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"id",
"token",
"title",
"expiresAt",
"revokedAt",
"createdAt"
],
"patternProperties": {
"^(?!(?:id|token|title|expiresAt|revokedAt|createdAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"token",
"title",
"expiresAt",
"revokedAt",
"createdAt"
]
}
},
"maxItems": 20
}
},
"required": [
"items"
],
"patternProperties": {
"^(?!(?:items)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"items"
]
}
]
}
},
{
"type": "object",
"properties": {
"shareId": {
"$ref": "#/$defs/AnalyticsShareId"
},
"revokedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"shareId",
"revokedAt"
],
"patternProperties": {
"^(?!(?:shareId|revokedAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"shareId",
"revokedAt"
]
}
}
]
},
{
"type": "object"
}
]
},
{
"type": "object",
"properties": {
"data": {
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/AnalyticsShareId"
},
"token": {
"$ref": "#/$defs/AnalyticsShareToken"
},
"title": {
"$ref": "#/$defs/AnalyticsShareTitle"
},
"expiresAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"revokedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"id",
"token",
"title",
"expiresAt",
"revokedAt",
"createdAt"
],
"patternProperties": {
"^(?!(?:id|token|title|expiresAt|revokedAt|createdAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"token",
"title",
"expiresAt",
"revokedAt",
"createdAt"
]
}
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/AnalyticsShareId"
},
"token": {
"$ref": "#/$defs/AnalyticsShareToken"
},
"title": {
"$ref": "#/$defs/AnalyticsShareTitle"
},
"expiresAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"revokedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"id",
"token",
"title",
"expiresAt",
"revokedAt",
"createdAt"
],
"patternProperties": {
"^(?!(?:id|token|title|expiresAt|revokedAt|createdAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"token",
"title",
"expiresAt",
"revokedAt",
"createdAt"
]
}
},
"maxItems": 20
}
},
"required": [
"items"
],
"patternProperties": {
"^(?!(?:items)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"items"
]
}
]
}
},
{
"type": "object",
"properties": {
"shareId": {
"$ref": "#/$defs/AnalyticsShareId"
},
"revokedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"shareId",
"revokedAt"
],
"patternProperties": {
"^(?!(?:shareId|revokedAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"shareId",
"revokedAt"
]
}
}
]
},
{
"not": {
"type": "object"
}
}
]
}
},
"required": [
"data"
],
"additionalProperties": false
}
]
}
```
### Underlying API operations
- `campaignAnalytics.createShare`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/analytics-shares`
- `campaignAnalytics.listShares`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/analytics-shares`
- `campaignAnalytics.revokeShare`: `DELETE /v1/workspaces/:workspaceId/campaigns/analytics-shares/:shareId`
Scheduler Zero