NUDG3 Preview Funnel API
The Preview Funnel API from NUDG3 — 2 operation(s) for preview funnel.
The Preview Funnel API from NUDG3 — 2 operation(s) for preview funnel.
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-preview-funnel-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 Preview Funnel 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: Preview Funnel
paths:
/public/preview/research:
post:
tags:
- Preview Funnel
summary: Brand Research Preview
description: 'Step 1: Research brand using AI to generate preview data.
User enters brand name and domain, system returns:
- AI-generated industry classification
- Brand description
- Target market analysis
- Relevant keywords
- Brand aliases
- Preview token for next step
**Rate Limits**: 10 requests per minute, 30 per hour (per IP)
**No authentication required** - This is a public preview endpoint.'
operationId: brand_research_preview_public_preview_research_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/schemas__api__preview__BrandResearchRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/schemas__api__preview__BrandResearchResponse'
'429':
description: Rate limit exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/PreviewErrorResponse'
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/PreviewErrorResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/PreviewErrorResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/public/preview/request-report:
post:
tags:
- Preview Funnel
summary: Request Free Visibility Report
description: 'Step 2: Request free visibility report via email.
Requires a valid preview token from Step 1. Creates:
- Unclaimed workspace under Free Visibility Audit agency
- FreeReportDeliveryLog for email delivery tracking
Returns immediately after creating workspace. Background task handles:
- Brand research via Perplexity
- Competitor generation
- Prompt generation
- Collection workflow trigger
User will receive email with executive summary + teaser + claim CTA.
No account is created until user clicks claim link.
**Rate Limits**: 3 attempts per minute, 10 per hour (per email)
**No authentication required** - Uses preview token + email.'
operationId: request_report_public_preview_request_report_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestReportRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RequestReportResponse'
'401':
description: Invalid or expired token
content:
application/json:
schema:
$ref: '#/components/schemas/PreviewErrorResponse'
'409':
description: Email already exists
content:
application/json:
schema:
$ref: '#/components/schemas/PreviewErrorResponse'
'429':
description: Rate limit exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/PreviewErrorResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/PreviewErrorResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
BrandResearchData:
properties:
industry:
type: string
title: Industry
description: Brand's industry/category
description:
type: string
title: Description
description: Concise brand description
target_market:
type: string
title: Target Market
description: Target audience/market segment
keywords:
items:
type: string
type: array
title: Keywords
description: Relevant brand keywords (3-10 items)
aliases:
items:
type: string
type: array
title: Aliases
description: Alternative names/variations (2-5 items)
confidence_score:
type: number
maximum: 1.0
minimum: 0.0
title: Confidence Score
description: Research confidence (0-1)
type: object
required:
- industry
- description
- target_market
- confidence_score
title: BrandResearchData
description: Brand research results from Perplexity.
schemas__api__preview__BrandResearchResponse:
properties:
preview_token:
type: string
title: Preview Token
description: JWT token for subsequent steps (valid 30 mins)
brand_research:
$ref: '#/components/schemas/BrandResearchData'
description: AI-generated brand research
detected_region:
$ref: '#/components/schemas/DetectedRegion'
description: Region information
logo_url:
anyOf:
- type: string
- type: 'null'
title: Logo Url
description: Brand logo URL from logo.dev
type: object
required:
- preview_token
- brand_research
- detected_region
title: BrandResearchResponse
description: Step 1 response with brand research and preview token.
schemas__api__preview__BrandResearchRequest:
properties:
brand_name:
type: string
maxLength: 100
minLength: 2
title: Brand Name
description: Company/brand name
examples:
- Acme Corp
- TechStartup
domain:
type: string
title: Domain
description: Company website domain (without protocol)
examples:
- acme.com
- techstartup.io
region:
anyOf:
- type: string
pattern: ^[A-Z]{2}$
- type: 'null'
title: Region
description: ISO 3166-1 alpha-2 country code
examples:
- US
- ZA
- GB
type: object
required:
- brand_name
- domain
title: BrandResearchRequest
description: 'Step 1: Initial brand input for research preview.'
RequestReportRequest:
properties:
preview_token:
type: string
title: Preview Token
description: JWT token from Step 1
email:
type: string
format: email
title: Email
description: Email to send report to
phone:
anyOf:
- type: string
maxLength: 20
minLength: 7
pattern: ^\+?[\d\s\-()]+$
- type: 'null'
title: Phone
description: Phone number (optional, for sales follow-up)
examples:
- +27 82 123 4567
- +1 555-123-4567
type: object
required:
- preview_token
- email
title: RequestReportRequest
description: 'Step 2: Request for free visibility report (email delivery).'
DetectedRegion:
properties:
country:
type: string
title: Country
description: ISO country code
country_name:
type: string
title: Country Name
description: Full country name
auto_detected:
type: boolean
title: Auto Detected
description: Whether region was auto-detected
type: object
required:
- country
- country_name
- auto_detected
title: DetectedRegion
description: Auto-detected or user-selected region.
PreviewErrorResponse:
properties:
success:
type: boolean
title: Success
description: Always False for errors
default: false
error:
type: string
title: Error
description: Error code (e.g., 'invalid_token', 'rate_limit')
message:
type: string
title: Message
description: User-friendly error message
retry_after:
anyOf:
- type: integer
- type: 'null'
title: Retry After
description: Seconds to wait before retry (rate limit)
type: object
required:
- error
- message
title: PreviewErrorResponse
description: Error response for preview endpoints.
RequestReportResponse:
properties:
success:
type: boolean
title: Success
description: Whether request was successful
default: true
message:
type: string
title: Message
description: User-friendly message
workspace_id:
anyOf:
- type: string
- type: 'null'
title: Workspace Id
description: Created workspace UUID (for tracking)
type: object
required:
- message
title: RequestReportResponse
description: Response for report request.
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
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