NUDG3 AI Traffic API
The AI Traffic API from NUDG3 — 3 operation(s) for ai traffic.
The AI Traffic API from NUDG3 — 3 operation(s) for ai traffic.
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-ai-traffic-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 AI Traffic 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: AI Traffic
paths:
/workspace/{workspace_id}/ai-traffic/status:
get:
tags:
- AI Traffic
summary: Get Ai Traffic Status
description: Check if GA4/GSC are connected and configured for this workspace.
operationId: get_ai_traffic_status_workspace__workspace_id__ai_traffic_status_get
security:
- HTTPBearer: []
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AiTrafficStatusResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/workspace/{workspace_id}/ai-traffic/ga4:
get:
tags:
- AI Traffic
summary: Get Ga4 Traffic
description: 'Query GA4 Data API for traffic data.
traffic_type=ai filters to known AI answer engine sources (default).
traffic_type=referral filters to sessionMedium=referral (legacy).
traffic_type=all returns all traffic GA4 reports.'
operationId: get_ga4_traffic_workspace__workspace_id__ai_traffic_ga4_get
security:
- HTTPBearer: []
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: start_date
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Start date YYYY-MM-DD
title: Start Date
description: Start date YYYY-MM-DD
- name: end_date
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: End date YYYY-MM-DD
title: End Date
description: End date YYYY-MM-DD
- name: traffic_type
in: query
required: false
schema:
type: string
pattern: ^(ai|referral|all)$
description: '''ai'' (AI answer engines only), ''referral'' (all referral), or ''all'''
default: ai
title: Traffic Type
description: '''ai'' (AI answer engines only), ''referral'' (all referral), or ''all'''
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Ga4TrafficResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/workspace/{workspace_id}/ai-traffic/gsc:
get:
tags:
- AI Traffic
summary: Get Gsc Traffic
description: Query GSC searchAnalytics API for search queries, pages, clicks, impressions.
operationId: get_gsc_traffic_workspace__workspace_id__ai_traffic_gsc_get
security:
- HTTPBearer: []
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: start_date
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Start date YYYY-MM-DD
title: Start Date
description: Start date YYYY-MM-DD
- name: end_date
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: End date YYYY-MM-DD
title: End Date
description: End date YYYY-MM-DD
- name: row_limit
in: query
required: false
schema:
type: integer
maximum: 25000
minimum: 1
description: Max top queries to return. Default 100 (dashboard-safe). Max 25000 (single-call GSC API cap). Long-tail callers (valuation preprocessing, exports) pass higher values.
default: 100
title: Row Limit
description: Max top queries to return. Default 100 (dashboard-safe). Max 25000 (single-call GSC API cap). Long-tail callers (valuation preprocessing, exports) pass higher values.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/GscTrafficResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
Ga4TrafficSummary:
properties:
total_sessions:
type: integer
title: Total Sessions
default: 0
total_users:
type: integer
title: Total Users
default: 0
unique_sources:
type: integer
title: Unique Sources
default: 0
ai_sessions:
anyOf:
- type: integer
- type: 'null'
title: Ai Sessions
ai_platforms:
anyOf:
- type: integer
- type: 'null'
title: Ai Platforms
date_range:
$ref: '#/components/schemas/DateRange'
type: object
required:
- date_range
title: Ga4TrafficSummary
TopPage:
properties:
page_path:
type: string
title: Page Path
total_sessions:
type: integer
title: Total Sessions
default: 0
top_sources:
items:
type: string
type: array
title: Top Sources
default: []
type: object
required:
- page_path
title: TopPage
DateRange:
properties:
start_date:
type: string
title: Start Date
end_date:
type: string
title: End Date
type: object
required:
- start_date
- end_date
title: DateRange
AiTrafficStatusResponse:
properties:
ga4_connected:
type: boolean
title: Ga4 Connected
default: false
gsc_connected:
type: boolean
title: Gsc Connected
default: false
ga4_property_id:
anyOf:
- type: string
- type: 'null'
title: Ga4 Property Id
gsc_site_url:
anyOf:
- type: string
- type: 'null'
title: Gsc Site Url
type: object
title: AiTrafficStatusResponse
GscQueryData:
properties:
query:
type: string
title: Query
clicks:
type: integer
title: Clicks
default: 0
impressions:
type: integer
title: Impressions
default: 0
ctr:
type: number
title: Ctr
default: 0.0
position:
type: number
title: Position
default: 0.0
type: object
required:
- query
title: GscQueryData
GscTrafficResponse:
properties:
daily_data:
items:
$ref: '#/components/schemas/TrafficDailyData'
type: array
title: Daily Data
default: []
top_queries:
items:
$ref: '#/components/schemas/GscQueryData'
type: array
title: Top Queries
default: []
top_pages:
items:
$ref: '#/components/schemas/TopPage'
type: array
title: Top Pages
default: []
summary:
$ref: '#/components/schemas/GscTrafficSummary'
type: object
required:
- summary
title: GscTrafficResponse
description: GSC search analytics data.
Ga4TrafficResponse:
properties:
daily_data:
items:
$ref: '#/components/schemas/TrafficDailyData'
type: array
title: Daily Data
default: []
top_sources:
items:
$ref: '#/components/schemas/TrafficSourceSummary'
type: array
title: Top Sources
default: []
top_pages:
items:
$ref: '#/components/schemas/TopPage'
type: array
title: Top Pages
default: []
summary:
$ref: '#/components/schemas/Ga4TrafficSummary'
type: object
required:
- summary
title: Ga4TrafficResponse
description: GA4 traffic data for crawler or referral endpoints.
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
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
TrafficSourceSummary:
properties:
source:
type: string
title: Source
total_sessions:
type: integer
title: Total Sessions
default: 0
total_users:
type: integer
title: Total Users
default: 0
total_page_views:
type: integer
title: Total Page Views
default: 0
ai_provider:
anyOf:
- type: string
- type: 'null'
title: Ai Provider
is_ai_source:
type: boolean
title: Is Ai Source
default: false
type: object
required:
- source
title: TrafficSourceSummary
TrafficDailyData:
properties:
date:
type: string
title: Date
source:
type: string
title: Source
medium:
anyOf:
- type: string
- type: 'null'
title: Medium
sessions:
type: integer
title: Sessions
default: 0
users:
type: integer
title: Users
default: 0
page_views:
type: integer
title: Page Views
default: 0
bounce_rate:
anyOf:
- type: number
- type: 'null'
title: Bounce Rate
avg_session_duration:
anyOf:
- type: number
- type: 'null'
title: Avg Session Duration
clicks:
type: integer
title: Clicks
default: 0
impressions:
type: integer
title: Impressions
default: 0
ai_provider:
anyOf:
- type: string
- type: 'null'
title: Ai Provider
is_ai_source:
type: boolean
title: Is Ai Source
default: false
type: object
required:
- date
- source
title: TrafficDailyData
GscTrafficSummary:
properties:
total_clicks:
type: integer
title: Total Clicks
default: 0
total_impressions:
type: integer
title: Total Impressions
default: 0
average_ctr:
type: number
title: Average Ctr
default: 0.0
date_range:
$ref: '#/components/schemas/DateRange'
type: object
required:
- date_range
title: GscTrafficSummary
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