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:
- Log in to your AdMaven advertiser account
- Navigate to Profile → API Key
- 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.
/
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
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
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
Best Practices
- Efficient Field Selection - Only request the campaign fields you need to reduce response times
- Batch Operations - When managing multiple campaigns, use comma-separated IDs to minimize API calls
- Error Handling - Implement proper error handling for 400 and 404 responses
- Rate Limiting - Monitor your API usage to avoid exceeding rate limits
- API Key Security - Never share your API key or include it in client-side code; always use server-side requests
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
Updated on: 11/06/2026
Thank you!
