NUDG3 Admin - Classification API
The Admin - Classification API from NUDG3 — 6 operation(s) for admin - classification.
The Admin - Classification API from NUDG3 — 6 operation(s) for admin - classification.
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-admin-classification-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 Admin - Classification 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: Admin - Classification
paths:
/admin/classification/status:
get:
tags:
- Admin - Classification
summary: Get classification service status
description: Returns the current status of the source classification service including health checks.
operationId: get_classification_status_admin_classification_status_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationStatusResponse'
security:
- HTTPBearer: []
/admin/classification/stats:
get:
tags:
- Admin - Classification
summary: Get classification statistics
description: Returns classification statistics from the database.
operationId: get_classification_stats_admin_classification_stats_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationStatsResponse'
security:
- HTTPBearer: []
/admin/classification/run:
post:
tags:
- Admin - Classification
summary: Run daily classification job
description: Triggers the daily source classification job. Can be called by scheduler or manually by super user.
operationId: run_classification_job_admin_classification_run_post
parameters:
- name: max_sources
in: query
required: false
schema:
type: integer
maximum: 50000
minimum: 1
description: Maximum sources to process
default: 5000
title: Max Sources
description: Maximum sources to process
- name: x-scheduler-secret
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Scheduler-Secret
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationJobResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/admin/classification/backfill:
post:
tags:
- Admin - Classification
summary: Run historical backfill
description: Runs one-time historical backfill of source classifications. Use with caution.
operationId: run_backfill_admin_classification_backfill_post
security:
- HTTPBearer: []
parameters:
- name: max_sources
in: query
required: false
schema:
type: integer
maximum: 500000
minimum: 1
description: Maximum sources to process
default: 100000
title: Max Sources
description: Maximum sources to process
- name: batch_size
in: query
required: false
schema:
type: integer
maximum: 5000
minimum: 100
description: Batch size for processing
default: 1000
title: Batch Size
description: Batch size for processing
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BackfillResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/admin/classification/reset-circuit-breaker:
post:
tags:
- Admin - Classification
summary: Reset circuit breaker
description: Manually reset the Gemini API circuit breaker.
operationId: reset_circuit_breaker_admin_classification_reset_circuit_breaker_post
responses:
'200':
description: Successful Response
content:
application/json:
schema:
additionalProperties: true
type: object
title: Response Reset Circuit Breaker Admin Classification Reset Circuit Breaker Post
security:
- HTTPBearer: []
/admin/classification/classify-domain:
post:
tags:
- Admin - Classification
summary: Classify a single domain
description: Test classification of a single domain (for debugging).
operationId: classify_single_domain_admin_classification_classify_domain_post
security:
- HTTPBearer: []
parameters:
- name: domain
in: query
required: true
schema:
type: string
description: Domain to classify
title: Domain
description: Domain to classify
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Classify Single Domain Admin Classification Classify Domain Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
ClassificationStatsResponse:
properties:
total_sources:
type: integer
title: Total Sources
description: Total sources in database
classified_sources:
type: integer
title: Classified Sources
description: Sources with classification
unclassified_sources:
type: integer
title: Unclassified Sources
description: Sources pending classification
classification_rate:
type: number
title: Classification Rate
description: Percentage of sources classified
by_method:
additionalProperties:
type: integer
type: object
title: By Method
description: Breakdown by classification method
by_category:
additionalProperties:
type: integer
type: object
title: By Category
description: Breakdown by category
service_metrics:
additionalProperties:
type: integer
type: object
title: Service Metrics
description: Service metrics
circuit_breaker:
additionalProperties: true
type: object
title: Circuit Breaker
description: Circuit breaker status
type: object
required:
- total_sources
- classified_sources
- unclassified_sources
- classification_rate
- by_method
- by_category
- service_metrics
- circuit_breaker
title: ClassificationStatsResponse
description: Classification statistics response.
ClassificationJobResponse:
properties:
status:
type: string
title: Status
description: 'Job status: completed, running, failed, skipped'
started_at:
anyOf:
- type: string
- type: 'null'
title: Started At
description: Job start time
sources_processed:
type: integer
title: Sources Processed
description: Total sources processed
default: 0
pattern_classified:
type: integer
title: Pattern Classified
description: Classified by pattern matching
default: 0
cache_classified:
type: integer
title: Cache Classified
description: Classified from cache
default: 0
gemini_classified:
type: integer
title: Gemini Classified
description: Classified by Gemini API
default: 0
errors:
type: integer
title: Errors
description: Errors encountered
default: 0
category_breakdown:
additionalProperties:
type: integer
type: object
title: Category Breakdown
description: Results by category
duration_seconds:
anyOf:
- type: number
- type: 'null'
title: Duration Seconds
description: Job duration
message:
anyOf:
- type: string
- type: 'null'
title: Message
description: Additional message
type: object
required:
- status
title: ClassificationJobResponse
description: Classification job response.
BackfillResponse:
properties:
status:
type: string
title: Status
description: Backfill status
started_at:
anyOf:
- type: string
- type: 'null'
title: Started At
description: Start time
total_processed:
type: integer
title: Total Processed
description: Total sources processed
default: 0
batches_completed:
type: integer
title: Batches Completed
description: Number of batches completed
default: 0
category_breakdown:
additionalProperties:
type: integer
type: object
title: Category Breakdown
description: Results by category
duration_seconds:
anyOf:
- type: number
- type: 'null'
title: Duration Seconds
description: Total duration
error:
anyOf:
- type: string
- type: 'null'
title: Error
description: Error message if failed
type: object
required:
- status
title: BackfillResponse
description: Backfill job response.
ClassificationStatusResponse:
properties:
google_client_available:
type: boolean
title: Google Client Available
description: Whether Gemini client is initialized
redis_available:
type: boolean
title: Redis Available
description: Whether Redis cache is available
model:
type: string
title: Model
description: Gemini model being used
circuit_breaker:
additionalProperties: true
type: object
title: Circuit Breaker
description: Circuit breaker status
metrics:
additionalProperties:
type: integer
type: object
title: Metrics
description: Service metrics
is_healthy:
type: boolean
title: Is Healthy
description: Overall service health
warnings:
items:
type: string
type: array
title: Warnings
description: Health warnings
type: object
required:
- google_client_available
- redis_available
- model
- circuit_breaker
- metrics
- is_healthy
title: ClassificationStatusResponse
description: Classification service status 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