NUDG3 Admin - Citation Backfill API
The Admin - Citation Backfill API from NUDG3 — 3 operation(s) for admin - citation backfill.
The Admin - Citation Backfill API from NUDG3 — 3 operation(s) for admin - citation backfill.
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-citation-backfill-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 - Citation Backfill 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 - Citation Backfill
paths:
/admin/citation-backfill/stats:
get:
tags:
- Admin - Citation Backfill
summary: Get citation backfill statistics
description: Returns statistics about citation backfill progress.
operationId: get_backfill_stats_admin_citation_backfill_stats_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BackfillStatsResponse'
security:
- HTTPBearer: []
/admin/citation-backfill/run-window:
post:
tags:
- Admin - Citation Backfill
summary: Run time-windowed backfill (manual)
description: Manually trigger a time-windowed citation backfill. Use for testing or ad-hoc runs.
operationId: run_backfill_window_admin_citation_backfill_run_window_post
security:
- HTTPBearer: []
parameters:
- name: max_duration_seconds
in: query
required: false
schema:
type: integer
maximum: 14400
minimum: 60
description: 'Maximum duration in seconds (default: 2.5 hours)'
default: 9000
title: Max Duration Seconds
description: 'Maximum duration in seconds (default: 2.5 hours)'
- name: batch_size
in: query
required: false
schema:
type: integer
maximum: 5000
minimum: 100
description: 'Citations per batch (default: 1000)'
default: 1000
title: Batch Size
description: 'Citations per batch (default: 1000)'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BackfillWindowResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/admin/citation-backfill/scheduler/run:
post:
tags:
- Admin - Citation Backfill
summary: Scheduler endpoint for nightly backfill
description: 'Scheduler endpoint for nightly citation backfill.
Called by Cloud Scheduler at 22:00 UTC.
Authentication: X-Scheduler-Secret header required.
Schedule: 22:00-00:45 UTC (2.75 hours before orchestration starts at 01:00 UTC)'
operationId: scheduler_run_backfill_admin_citation_backfill_scheduler_run_post
parameters:
- name: max_duration_seconds
in: query
required: false
schema:
type: integer
description: 'Maximum duration in seconds (default: 2.5 hours)'
default: 9000
title: Max Duration Seconds
description: 'Maximum duration in seconds (default: 2.5 hours)'
- name: batch_size
in: query
required: false
schema:
type: integer
description: 'Citations per batch (default: 1000)'
default: 1000
title: Batch Size
description: 'Citations per batch (default: 1000)'
- 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/BackfillWindowResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
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
BackfillStatsResponse:
properties:
total_citations:
type: integer
title: Total Citations
description: Total citations in database
processed:
type: integer
title: Processed
description: Citations with citation_context populated
remaining:
type: integer
title: Remaining
description: Citations still needing backfill
estimated_hours:
type: number
title: Estimated Hours
description: Estimated hours to complete at current rate
is_complete:
type: boolean
title: Is Complete
description: Whether backfill is complete
type: object
required:
- total_citations
- processed
- remaining
- estimated_hours
- is_complete
title: BackfillStatsResponse
description: Citation backfill statistics response.
BackfillWindowResponse:
properties:
status:
type: string
title: Status
description: 'Job status: completed, running, failed, skipped'
started_at:
type: string
title: Started At
description: Job start time (ISO format)
duration_seconds:
type: number
title: Duration Seconds
description: Job duration in seconds
total_processed:
type: integer
title: Total Processed
description: Total citations processed
urls_normalized:
type: integer
title: Urls Normalized
description: URLs that were normalized
contexts_extracted:
type: integer
title: Contexts Extracted
description: Text fragments extracted
batches_completed:
type: integer
title: Batches Completed
description: Number of batches completed
remaining:
type: integer
title: Remaining
description: Citations still needing backfill
is_complete:
type: boolean
title: Is Complete
description: Whether backfill is complete
error:
anyOf:
- type: string
- type: 'null'
title: Error
description: Error message if failed
type: object
required:
- status
- started_at
- duration_seconds
- total_processed
- urls_normalized
- contexts_extracted
- batches_completed
- remaining
- is_complete
title: BackfillWindowResponse
description: Backfill window execution response.
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