NUDG3 Share Reports API
The Share Reports API from NUDG3 — 1 operation(s) for share reports.
The Share Reports API from NUDG3 — 1 operation(s) for share reports.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/nudg3-ai:nudg3-ai-share-reports-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Nudg3 Share Reports API
description: '# Nudg3 Brand Intelligence API
The Nudg3 API provides programmatic access to brand visibility analytics across AI providers.
## Public API v1
The Public API (`/api/v1/`) is designed for third-party integrations and provides:
### Analytics Endpoints (Tier 1 - Basic)
- Brand visibility scores and trends
- Sentiment analysis across AI responses
- Source citation tracking
- Prompt performance metrics
- Google AI Overview (AIO) coverage
### Export Endpoints (Tier 2 - Premium)
- Full response data exports (CSV/TSV)
- Source citations bulk download
- Dashboard time-series data
- Prompt-mention pair exports
## Authentication
### API Key (Public API v1)
```bash
curl -H "Authorization: Bearer nudg3_live_ak_xxx..." \
https://api.nudg3.com/api/v1/dashboard
```
### JWT (Dashboard API)
```bash
curl -H "Authorization: Bearer eyJ..." \
https://api.nudg3.com/analytics/dashboard
```
## Rate Limits
| Tier | Per Minute | Per Hour | Monthly Quota |
|------|------------|----------|---------------|
| Basic | 60 | 600 | 5,000 |
| Premium | 300 | 3,000 | 50,000 |
## Response Format
All responses follow a standard envelope:
```json
{
"success": true,
"data": { ... },
"message": "Success"
}
```
## Support
- Documentation: https://docs.nudg3.com
- API Status: https://status.nudg3.com
- Support: support@nudg3.com'
version: 1.1.0
termsOfService: https://nudg3.com/terms
contact:
name: Nudg3 API Support
url: https://nudg3.com/support
email: support@nudg3.com
license:
name: Proprietary
url: https://nudg3.com/license
servers:
- url: https://api.nudg3.com
description: Production API
- url: https://api-staging.nudg3.com
description: Staging API (for testing)
- url: http://localhost:8000
description: Local Development
tags:
- name: Share Reports
paths:
/workspace/{workspace_id}/share-report:
post:
tags:
- Share Reports
summary: Share Report Via Email
description: 'Share a visibility report with external recipients via email.
Recipients receive an email summary including:
- Key metrics (visibility score, competitive position, mentions)
- Executive summary
- Optional personal message from sender
- CTA to sign up for their own account
Recipients do NOT receive dashboard access - this is summary-only sharing.
Args:
workspace_id: Workspace to share report from
request: Share request with recipient emails and optional message
Returns:
ShareReportResponse with success status and counts'
operationId: share_report_via_email_workspace__workspace_id__share_report_post
security:
- HTTPBearer: []
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ShareReportRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ShareReportResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ShareReportResponse:
properties:
success:
type: boolean
title: Success
description: Whether all emails were sent successfully
sent_count:
type: integer
title: Sent Count
description: Number of emails sent successfully
failed_count:
type: integer
title: Failed Count
description: Number of emails that failed to send
failed_emails:
items:
type: string
type: array
title: Failed Emails
description: List of email addresses that failed
message:
type: string
title: Message
description: Human-readable result message
type: object
required:
- success
- sent_count
- failed_count
- message
title: ShareReportResponse
description: Response schema for share report request.
example:
failed_count: 0
failed_emails: []
message: Report shared with 2 recipients.
sent_count: 2
success: true
ShareReportRequest:
properties:
recipient_emails:
items:
type: string
format: email
type: array
maxItems: 10
minItems: 1
title: Recipient Emails
description: List of email addresses to share the report with (1-10)
message:
anyOf:
- type: string
maxLength: 500
- type: 'null'
title: Message
description: Optional personal message to include in the email
report_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Report Id
description: Optional specific report ID. If not provided, uses latest report.
include_pdf:
type: boolean
title: Include Pdf
description: Whether to attach the full PDF report to the email
default: false
pdf_base64:
anyOf:
- type: string
maxLength: 14000000
- type: 'null'
title: Pdf Base64
description: Base64-encoded PDF content (max ~10MB, generated by frontend)
pdf_filename:
anyOf:
- type: string
maxLength: 255
- type: 'null'
title: Pdf Filename
description: Filename for the PDF attachment (alphanumeric, dash, underscore only)
include_audit_score:
type: boolean
title: Include Audit Score
description: Include visibility score, competitive position, and mentions
default: true
include_executive_summary:
type: boolean
title: Include Executive Summary
description: Include AI-generated executive summary
default: true
include_key_metrics:
type: boolean
title: Include Key Metrics
description: Include key metrics breakdown
default: true
include_opportunities:
type: boolean
title: Include Opportunities
description: Include top 3 opportunities from the report
default: true
include_threats:
type: boolean
title: Include Threats
description: Include top 3 threats from the report
default: true
include_quick_wins:
type: boolean
title: Include Quick Wins
description: Include quick wins recommendations
default: false
include_provider_summary:
type: boolean
title: Include Provider Summary
description: Include provider-level visibility summary
default: false
type: object
required:
- recipient_emails
title: ShareReportRequest
description: Request schema to share a visibility report via email.
example:
include_opportunities: true
include_pdf: true
include_quick_wins: false
include_threats: true
message: Check out our brand visibility report - would love your feedback!
pdf_base64: JVBERi0xLjQKMSAwIG9iago...
pdf_filename: visibility-report-mybrand-2025-01-15.pdf
recipient_emails:
- colleague@company.com
- partner@agency.com
securitySchemes:
ApiKeyAuth:
type: http
scheme: bearer
bearerFormat: API Key
description: '
API Key authentication for Public API v1 endpoints.
**Format:** `nudg3_live_ak_xxx...` or `nudg3_test_ak_xxx...`
**Usage:**
```
Authorization: Bearer nudg3_live_ak_your_key_here
```
Or use the header:
```
X-API-Key: nudg3_live_ak_your_key_here
```
**Obtain API Keys:**
Generate API keys from your Nudg3 dashboard under Settings > API Keys.
**Tiers:**
- **Basic:** `read:analytics` scope - Analytics endpoints only
- **Premium:** `read:analytics` + `export:data` scopes - Analytics + Exports
'
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: '
JWT authentication for internal dashboard endpoints.
Obtain tokens via `/auth/login` endpoint.
'
externalDocs:
description: Nudg3 API Documentation
url: https://docs.nudg3.com/api