> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://advertisers-help.ad-maven.com/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# API Guide

# [API Guide: ](https://advertisers.ad-maven.com/api/docs)

All API requests require authentication using an API key
**To generate your API key:**
1. Log in to your AdMaven advertiser account
2. Navigate to **Profile → API Key**
3. Copy your API key and include it in your request headers
The API uses a base URL of https://advertisers.ad-maven.com for all endpoints.


| [API documentation for the Advertisers API](https://advertisers.ad-maven.com/api/docs)
### 

![](https://storage.crisp.chat/users/helpdesk/website/-/f/3/5/2/f352dd782f6b280/screenshot-2026-06-18-at-19263_1nrbek3.png =701xauto)



# ${color}[#8b3eff](Core Features:)
### **Campaign Management**
The Campaign API allows you to create, retrieve, and update your advertising campaigns.

**Available Operations:**
* **GET /api/public/campaign** - Retrieve campaign details by ID
* **POST /api/public/campaign** - Create a new campaign
* **PUT /api/public/campaign** - Update an existing campaign

**Retrieving Campaigns:** You can retrieve single or multiple campaigns using their IDs. For example:
* Single campaign: Use the campaign ID directly
* Multiple campaigns: Separate IDs with commas
* All campaigns: Use the value "all"

You can also specify which fields to retrieve to optimize your response. Available fields include: targeting, name, enable, pricing_model, ad_format, destination_url, campaign_category, conversion_flow, rates, caps, frequency_cap, and schedule.
**Important Note:** When requesting all campaigns, fields are limited to 5 per request.


### **Reports**
Access detailed performance data about your campaigns:
* **GET /api/public/reports** - Retrieve campaign performance reports
* **POST /api/public/reports** - Generate custom reports with specific parameters


### **Account Management**
**User Data Endpoints:**
* **GET /api/public/available_balance** - Check your current account balance


### **Rates Management**
Manage pricing and rates for your campaigns:
* **GET /api/public/rates** - Retrieve current rates
* **PUT /api/public/rates** - Update or add new rates
* **DELETE /api/public/rates** - Remove rates


### **Advanced Targeting**
Configure granular targeting options for your campaigns:
**Source ID Management:**
* **GET /api/public/targeting/source_id** - Retrieve configured source IDs
* **PUT /api/public/targeting/source_id** - Add or replace source IDs
* **DELETE /api/public/targeting/source_id** - Remove source IDs
**Sub Source ID Management:**
* **GET /api/public/targeting/sub_source_id** - Retrieve sub source IDs
* **PUT /api/public/targeting/sub_source_id** - Add or replace sub source IDs
* **DELETE /api/public/targeting/sub_source_id** - Remove sub source IDs


## ${color}[#000000](Configuration Options )
The API provides endpoints to fetch available options for campaign configuration:
**Campaign Settings:**
* Ad formats available for your campaigns
* Pricing models (CPC, CPM, CPA, etc.)
* Campaign categories and products
* Conversion flow options
**Targeting Parameters:**
* Geographic targeting (states)
* Internet Service Providers (ISPs)
* Device types (desktop, mobile, tablet)
* Browser types and operating systems
* Traffic types
* Connection types
**Content Filtering:**
* Adult content filtering options
* Proxy filtering options
* Frequency capping types, behaviors, and periods


## ${color}[#000000](API Response Codes)
**Success Responses:**
* **200 OK** - Campaign retrieved or operation completed successfully
* Response includes request time in milliseconds
**Error Responses:**
* **400 Bad Request** - Invalid request parameters
* **404 Not Found** - Campaign ID does not exist


## ${color}[#000000](Best Practices)
1. **Efficient Field Selection** - Only request the campaign fields you need to reduce response times
2. **Batch Operations** - When managing multiple campaigns, use comma-separated IDs to minimize API calls
3. **Error Handling** - Implement proper error handling for 400 and 404 responses
4. **Rate Limiting** - Monitor your API usage to avoid exceeding rate limits
5. **API Key Security** - Never share your API key or include it in client-side code; always use server-side requests

## ${color}[#000000](Integration Examples)
**Common use cases for the AdMaven API:**
* Build a dashboard that syncs campaign data in real-time
* Automate campaign creation and optimization workflows
* Export campaign performance data for analysis
* Integrate AdMaven with your existing marketing technology stack
* Create alerts based on campaign performance thresholds
##