Export Endpoints

The Export endpoints allow you to download analytics data in various formats for use in BI tools like Power BI, Looker, and Excel.

Required Scopes: read:analytics + export:data Tier: Premium (Tier 2)

Export endpoints require a Premium subscription with the export:data scope.

Export Formats

All export endpoints support the following formats:

Format	Content-Type	Description
CSV	`text/csv`	Comma-separated values
TSV	`text/tab-separated-values`	Tab-separated values (Excel compatible)

Common Parameters

All export endpoints support these common parameters:

Parameter	Type	Required	Description
`date_from`	date	Yes	Start date (YYYY-MM-DD)
`date_to`	date	Yes	End date (YYYY-MM-DD)
`models`	array	No	Filter by AI provider names (openai, anthropic, google, perplexity)
`tags`	array	No	Filter by prompt template tags

Format Options

The following parameters control output format (supported by chat-responses, dashboard-graph, and prompts-mentions exports):

Parameter	Type	Default	Description
`excel_compatible`	boolean	false	Use tab-delimited TSV format for Excel compatibility
`include_type_hints`	boolean	false	Include type hint row for BI tools

The sources-citations endpoint outputs CSV format only and does not support format options.

Workspace Isolation: The workspace is automatically determined from your API key. You don't need to pass a workspace_id parameter.

Rate Limits

Export endpoints have specific rate limits:

10 exports per hour (strict, fail-closed)
Large exports may be queued for processing
Rate limit headers included in response

Chat Responses Export

Export full LLM response data including complete response text.

Request

GET /api/v1/exports/chat-responses

Parameters

See Common Parameters and Format Options above, plus:

Parameter	Type	Required	Description
`has_content`	boolean	No	Filter by content availability

Example Request

curl -X GET "https://api.nudg3.ai/api/v1/exports/chat-responses?date_from=2026-01-01&date_to=2026-01-31&excel_compatible=true" \
  -H "Authorization: Bearer nudg3_live_ak_your_key" \
  -o chat-responses.csv

Response

Returns a CSV/TSV file with the following columns:

Column	Type	Description
`id`	UUID	Response ID
`provider`	string	AI provider (openai, anthropic, etc.)
`model`	string	Model ID
`prompt_id`	UUID	Associated prompt template ID
`prompt_text`	string	The prompt that generated this response
`response_text`	string	Full AI response content
`mentions`	JSON	Brand mentions extracted
`sentiment`	float	Sentiment score (-1 to 1)
`created_at`	datetime	Response timestamp

Sample Output

id,provider,model,prompt_id,prompt_text,response_text,mentions,sentiment,created_at
550e8400...,openai,gpt-4o,660e8400...,What CRM is best?,Based on my analysis...,["HubSpot","Salesforce"],0.75,2026-01-12T10:30:00Z

Source Citations Export

Export complete citation records showing which sources are cited in AI responses.

Request

GET /api/v1/exports/sources-citations

Parameters

See Common Parameters above. This endpoint does not support format options.

Example Request

curl -X GET "https://api.nudg3.ai/api/v1/exports/sources-citations?date_from=2026-01-01&date_to=2026-01-31" \
  -H "Authorization: Bearer nudg3_live_ak_your_key" \
  -o source-citations.csv

Response Columns

Column	Type	Description
`url`	string	Full citation URL
`domain`	string	Domain name
`title`	string	Page title (if available)
`response_id`	UUID	Associated response ID
`provider`	string	AI provider that cited this source
`citation_date`	datetime	When source was cited

Dashboard Graph Export

Export time-series visibility data for charting and trend analysis.

Request

GET /api/v1/exports/dashboard-graph

Parameters

See Common Parameters and Format Options above.

Example Request

curl -X GET "https://api.nudg3.ai/api/v1/exports/dashboard-graph?date_from=2026-01-01&date_to=2026-01-31&include_type_hints=true" \
  -H "Authorization: Bearer nudg3_live_ak_your_key" \
  -o dashboard-data.csv

Response Columns

Column	Type	Description
`date`	date	Data point date
`brand_name`	string	Brand name
`visibility_score`	float	Visibility score (0-100)
`mention_count`	integer	Number of mentions
`sentiment_avg`	float	Average sentiment
`position_avg`	float	Average position

Sample Output

date,brand_name,visibility_score,mention_count,sentiment_avg,position_avg
2026-01-01,YourBrand,78.5,45,0.72,2.3
2026-01-01,Competitor1,65.2,32,0.58,3.1
2026-01-02,YourBrand,79.1,48,0.74,2.2

Prompts Mentions Export

Export prompt-mention pairs with sentiment data for detailed analysis.

Request

GET /api/v1/exports/prompts-mentions

Parameters

See Common Parameters and Format Options above.

Example Request

curl -X GET "https://api.nudg3.ai/api/v1/exports/prompts-mentions?date_from=2026-01-01&date_to=2026-01-31&models=openai&tags=product" \
  -H "Authorization: Bearer nudg3_live_ak_your_key" \
  -o prompts-mentions.csv

Response Columns

Column	Type	Description
`prompt_id`	UUID	Prompt template ID
`prompt_text`	string	Prompt text
`brand_name`	string	Mentioned brand
`mention_count`	integer	Times brand was mentioned
`avg_sentiment`	float	Average sentiment for this prompt/brand pair
`avg_position`	float	Average position for this prompt/brand pair

BI Tool Integration

Power BI

Use Web connector
Enter export endpoint URL
Add Authorization header with your API key
Set refresh schedule (recommended: daily)

https://api.nudg3.ai/api/v1/exports/dashboard-graph?date_from={start_date}&date_to={end_date}

Looker Studio

Create a Community Connector
Use the export endpoints as data source
Include include_type_hints=true for automatic type detection

Excel / Google Sheets

# Download and open in Excel
curl -o data.csv "https://api.nudg3.ai/api/v1/exports/dashboard-graph" \
  -H "Authorization: Bearer nudg3_live_ak_your_key"

Export Metadata Endpoints

Each export type has three supporting metadata endpoints for BI tool integration and pre-download estimation.

Available Metadata Endpoints

Export Type	Statistics	Manifest	Schema
Chat Responses	`/exports/chat-responses/statistics`	`/exports/chat-responses/manifest`	`/exports/chat-responses/schema`
Source Citations	`/exports/sources-citations/statistics`	`/exports/sources-citations/manifest`	`/exports/sources-citations/schema`
Dashboard Graph	`/exports/dashboard-graph/statistics`	`/exports/dashboard-graph/manifest`	`/exports/dashboard-graph/schema`
Prompts Mentions	`/exports/prompts-mentions/statistics`	`/exports/prompts-mentions/manifest`	`/exports/prompts-mentions/schema`

Statistics Endpoint

Get row counts and size estimates before downloading. Use this to warn users about large downloads.

GET /api/v1/exports/{type}/statistics

Parameters

Parameter	Type	Required	Description
`date_from`	date	Yes	Start date (YYYY-MM-DD)
`date_to`	date	Yes	End date (YYYY-MM-DD)
`models`	array	No	Filter by AI provider names
`tags`	array	No	Filter by prompt template tags

The chat-responses/statistics endpoint also supports a has_content boolean filter.

Example Request

curl -X GET "https://api.nudg3.ai/api/v1/exports/chat-responses/statistics?date_from=2026-01-01&date_to=2026-01-31" \
  -H "Authorization: Bearer nudg3_live_ak_your_key"

Response

{
  "success": true,
  "data": {
    "total_rows": 15000,
    "estimated_size_mb": 45.2,
    "date_range": {
      "start": "2026-01-01",
      "end": "2026-01-31"
    },
    "last_updated": "2026-01-12T10:30:00Z"
  }
}

Manifest Endpoint

Get BI tool metadata and refresh hints for automated data pipelines.

GET /api/v1/exports/{type}/manifest

Parameters

Parameter	Type	Required	Description
`date_from`	date	Yes	Start date (YYYY-MM-DD)
`date_to`	date	Yes	End date (YYYY-MM-DD)
`models`	array	No	Filter by model names
`tags`	array	No	Filter by tags

Example Request

curl -X GET "https://api.nudg3.ai/api/v1/exports/chat-responses/manifest?date_from=2026-01-01&date_to=2026-01-31" \
  -H "Authorization: Bearer nudg3_live_ak_your_key"

Response

{
  "success": true,
  "data": {
    "manifest_version": "1.0",
    "export_type": "chat-responses",
    "statistics": {
      "total_rows": 15000,
      "estimated_size_mb": 45.2
    },
    "refresh_hints": {
      "recommended_interval_hours": 24,
      "supports_incremental": true,
      "incremental_key": "created_at"
    },
    "columns": [
      {"name": "id", "type": "uuid", "nullable": false},
      {"name": "provider", "type": "string", "nullable": false},
      {"name": "response_text", "type": "string", "nullable": false}
    ]
  }
}

Schema Endpoint

Get column documentation in Markdown format. Useful for generating documentation or data dictionaries.

GET /api/v1/exports/{type}/schema

Parameters

Parameter	Type	Required	Description
`date_from`	date	Yes	Start date (YYYY-MM-DD)
`date_to`	date	Yes	End date (YYYY-MM-DD)

The chat-responses/schema endpoint also supports models and tags filters.

Example Request

curl -X GET "https://api.nudg3.ai/api/v1/exports/chat-responses/schema?date_from=2026-01-01&date_to=2026-01-31" \
  -H "Authorization: Bearer nudg3_live_ak_your_key"

Response

Returns Markdown-formatted column documentation:

# Chat Responses Export Schema
 
## Columns
 
| Column | Type | Nullable | Description |
|--------|------|----------|-------------|
| id | uuid | No | Unique response identifier |
| provider | string | No | AI provider name |
| model | string | No | Model ID used |
| response_text | string | No | Full AI response content |
| sentiment | float | Yes | Sentiment score (-1 to 1) |
| created_at | datetime | No | Response timestamp (UTC) |

Error Responses

Code	Error	Description
403	Forbidden	Missing `export:data` scope
429	Rate Limit	Export rate limit exceeded (10/hour)
503	Service Unavailable	Export service temporarily unavailable

Large exports may take several minutes to generate. For datasets over 100,000 rows, consider using date filters to break into smaller chunks.

Export Endpoints

On this page