NUDG3 Analytics - Valuation API
The Analytics - Valuation API from NUDG3 — 3 operation(s) for analytics - valuation.
The Analytics - Valuation API from NUDG3 — 3 operation(s) for analytics - valuation.
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-analytics-valuation-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 Analytics - Valuation 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: Analytics - Valuation
paths:
/analytics/valuation:
get:
tags:
- Analytics - Valuation
summary: Get Workspace Valuation
description: 'Compute the AI Visibility Value for a workspace.
Query params:
workspace_id (required, via require_analytics_access)
brand_name (optional) -- restrict to a single brand''s contribution
Response (SuccessResponse envelope):
data: WorkspaceValuation dict with total_value_usd/zar, range,
by_provider, by_brand, confidence, methodology metadata,
keyword_hit_rate, missing_data_count, status, computed_at.
Status field values:
"ready" -- non-zero value, cache populated
"pending" -- responses exist but most lack cached keyword/volume
"insufficient_data" -- no active prompts or no collected responses
The frontend (NUD-196 card) surfaces `status` so users see
"preparing..." rather than a confusing R0 during backfill.'
operationId: get_workspace_valuation_analytics_valuation_get
security:
- HTTPBearer: []
parameters:
- name: brand_name
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Brand Name
- name: workspace_id
in: query
required: true
schema:
type: string
format: uuid
description: Workspace ID (mandatory for all analytics endpoints)
title: Workspace Id
description: Workspace ID (mandatory for all analytics endpoints)
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/analytics/valuation/prompts:
get:
tags:
- Analytics - Valuation
summary: Get Prompt Contributions
description: 'Top prompts by valuation contribution.
One row per active prompt with >=1 mention, sorted desc by total_value_usd.
Each row exposes per-provider contribution + top-performing brand on that
prompt. Powers the "Top prompts" table on the /valuation page.
Cached 24h via the same analytics-cache singleflight as /analytics/valuation.'
operationId: get_prompt_contributions_analytics_valuation_prompts_get
security:
- HTTPBearer: []
parameters:
- name: limit
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
description: Max prompts to return
default: 20
title: Limit
description: Max prompts to return
- name: min_value_usd
in: query
required: false
schema:
type: number
minimum: 0.0
description: Skip prompts contributing less than this USD amount
default: 0.0
title: Min Value Usd
description: Skip prompts contributing less than this USD amount
- name: workspace_id
in: query
required: true
schema:
type: string
format: uuid
description: Workspace ID (mandatory for all analytics endpoints)
title: Workspace Id
description: Workspace ID (mandatory for all analytics endpoints)
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/analytics/valuation/opportunities:
get:
tags:
- Analytics - Valuation
summary: Get Opportunity Gaps
description: 'Top prompts where the workspace''s primary brand is absent but the
keyword carries material volume × CPC. Surfaces "where are we invisible
but the market is paying attention?" -- the actionable drill-down.
Estimated opportunity assumes a hypothetical cited_high capture across
Google AIO + ChatGPT + Perplexity. Ceiling, not projection.
Cached 24h.'
operationId: get_opportunity_gaps_analytics_valuation_opportunities_get
security:
- HTTPBearer: []
parameters:
- name: limit
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
default: 20
title: Limit
- name: min_volume
in: query
required: false
schema:
type: integer
minimum: 0
description: Skip prompts whose cached search_volume is below this floor
default: 10
title: Min Volume
description: Skip prompts whose cached search_volume is below this floor
- name: workspace_id
in: query
required: true
schema:
type: string
format: uuid
description: Workspace ID (mandatory for all analytics endpoints)
title: Workspace Id
description: Workspace ID (mandatory for all analytics endpoints)
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
SuccessResponse:
properties:
status:
type: string
title: Status
description: Response status
default: success
message:
type: string
title: Message
data:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Data
type: object
required:
- message
title: SuccessResponse
description: Generic success response.
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