NUDG3 Analytics - Narrative API
The Analytics - Narrative API from NUDG3 — 3 operation(s) for analytics - narrative.
The Analytics - Narrative API from NUDG3 — 3 operation(s) for analytics - narrative.
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-narrative-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 - Narrative 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 - Narrative
paths:
/analytics/narrative-overview:
get:
tags:
- Analytics - Narrative
summary: Get Narrative Overview
description: 'Aggregated narrative intelligence profile for a date range.
Returns mention type distribution, mention strength distribution,
top positive/negative indicator phrases, per-provider breakdown,
and v1.7 data coverage percentage.'
operationId: get_narrative_overview_analytics_narrative_overview_get
security:
- HTTPBearer: []
parameters:
- name: start_date
in: query
required: false
schema:
anyOf:
- type: string
format: date
- type: 'null'
description: Start date (YYYY-MM-DD). Defaults to 30 days ago.
title: Start Date
description: Start date (YYYY-MM-DD). Defaults to 30 days ago.
- name: end_date
in: query
required: false
schema:
anyOf:
- type: string
format: date
- type: 'null'
description: End date (YYYY-MM-DD). Defaults to today.
title: End Date
description: End date (YYYY-MM-DD). Defaults to today.
- name: models
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
description: AI provider display names to filter by (ChatGPT, Gemini, Claude, Perplexity).
title: Models
description: AI provider display names to filter by (ChatGPT, Gemini, Claude, Perplexity).
- name: tags
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
description: Prompt template tags to filter by.
title: Tags
description: Prompt template tags to filter by.
- 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/narrative-trends:
get:
tags:
- Analytics - Narrative
summary: Get Narrative Trends
description: 'Time-series of narrative distributions bucketed by day or week.
Returns daily/weekly mention type and strength distributions,
plus trend lines for top 5 positive and negative indicator phrases.'
operationId: get_narrative_trends_analytics_narrative_trends_get
security:
- HTTPBearer: []
parameters:
- name: start_date
in: query
required: false
schema:
anyOf:
- type: string
format: date
- type: 'null'
description: Start date (YYYY-MM-DD). Defaults to 30 days ago.
title: Start Date
description: Start date (YYYY-MM-DD). Defaults to 30 days ago.
- name: end_date
in: query
required: false
schema:
anyOf:
- type: string
format: date
- type: 'null'
description: End date (YYYY-MM-DD). Defaults to today.
title: End Date
description: End date (YYYY-MM-DD). Defaults to today.
- name: models
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
description: AI provider display names to filter by.
title: Models
description: AI provider display names to filter by.
- name: tags
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
description: Prompt template tags to filter by.
title: Tags
description: Prompt template tags to filter by.
- name: granularity
in: query
required: false
schema:
type: string
description: 'Time bucket granularity: ''day'' or ''week''.'
default: day
title: Granularity
description: 'Time bucket granularity: ''day'' or ''week''.'
- 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/narrative-passages:
get:
tags:
- Analytics - Narrative
summary: Get Narrative Passages
description: 'Paginated key passage browser with rich filters.
Browse actual AI text about the brand, filtered by provider, context type,
mention strength, and sentiment polarity.'
operationId: get_narrative_passages_analytics_narrative_passages_get
security:
- HTTPBearer: []
parameters:
- name: start_date
in: query
required: false
schema:
anyOf:
- type: string
format: date
- type: 'null'
description: Start date (YYYY-MM-DD). Defaults to 30 days ago.
title: Start Date
description: Start date (YYYY-MM-DD). Defaults to 30 days ago.
- name: end_date
in: query
required: false
schema:
anyOf:
- type: string
format: date
- type: 'null'
description: End date (YYYY-MM-DD). Defaults to today.
title: End Date
description: End date (YYYY-MM-DD). Defaults to today.
- name: models
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
description: AI provider display names to filter by.
title: Models
description: AI provider display names to filter by.
- name: tags
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
description: Prompt template tags to filter by.
title: Tags
description: Prompt template tags to filter by.
- name: context_type
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Filter by mention context type (evaluative, comparative, listicle, passing, absent).
title: Context Type
description: Filter by mention context type (evaluative, comparative, listicle, passing, absent).
- name: mention_strength
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Filter by mention strength (strong, moderate, weak, none).
title: Mention Strength
description: Filter by mention strength (strong, moderate, weak, none).
- name: sentiment
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Filter by sentiment polarity (positive, negative, neutral).
title: Sentiment
description: Filter by sentiment polarity (positive, negative, neutral).
- name: page
in: query
required: false
schema:
type: integer
minimum: 1
description: Page number.
default: 1
title: Page
description: Page number.
- name: page_size
in: query
required: false
schema:
type: integer
maximum: 50
minimum: 1
description: Results per page (max 50).
default: 20
title: Page Size
description: Results per page (max 50).
- 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