Getting Started

This guide will help you get up and running with the Nudg3 API in under 5 minutes.

Prerequisites

Before you begin, you'll need:

A Nudg3 account with an active workspace
An API key (we'll create one in this guide)
A tool to make HTTP requests (curl, Postman, or your preferred language)

Step 1: Create an API Key

Log in to your Nudg3 Dashboard
Navigate to Settings > API Keys
Click Create New Key
Give your key a descriptive name (e.g., "Development", "Production")
Select the appropriate scopes:
- read:analytics - Access to analytics endpoints
- export:data - Access to export endpoints
Copy your API key immediately - it won't be shown again!

Keep your API key secure. Never commit it to version control or expose it in client-side code.

Step 2: Make Your First Request

Let's verify your API key works by fetching your dashboard analytics.

Using cURL

curl https://api.nudg3.ai/api/v1/dashboard \
  -H "Authorization: Bearer nudg3_live_ak_your_key" \
  -H "Content-Type: application/json"

Using JavaScript

const response = await fetch('https://api.nudg3.ai/api/v1/dashboard', {
  headers: {
    'Authorization': 'Bearer nudg3_live_ak_your_key',
    'Content-Type': 'application/json'
  }
});
 
const data = await response.json();
console.log(data);

Using Python

import requests
 
response = requests.get(
    'https://api.nudg3.ai/api/v1/dashboard',
    headers={
        'Authorization': 'Bearer nudg3_live_ak_your_key',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()
print(data)

Step 3: Explore the Response

A successful response will look like this:

{
  "success": true,
  "data": {
    "brands": [
      {
        "brand_id": "uuid",
        "name": "YourBrand",
        "visibility_score": 85.5,
        "avg_sentiment": 0.72,
        "avg_position": 2.1,
        "mention_count": 150
      }
    ],
    "aggregates": {
      "total_mentions": 1250,
      "unique_chats": 500,
      "avg_visibility": 82.3
    },
    "top_sources": [...]
  },
  "message": "Dashboard analytics retrieved for 5 brands"
}

Understanding the Data

Field	Description
`success`	Boolean indicating if the request succeeded
`data.brands`	Array of brand visibility metrics
`data.aggregates`	Overall totals and averages
`data.top_sources`	Most frequently cited sources
`message`	Human-readable status message

Next Steps

Now that you've made your first API call, explore these guides:

Authentication Deep Dive

Learn about API keys, scopes, and security

Analytics Endpoints

Explore all analytics endpoints

How-To Guides

Practical guides for common tasks

Getting Started

Authentication Deep Dive

Analytics Endpoints

How-To Guides

On this page