API Reference
Users
Google Auth
Google Ads
- GETGet Google Ads Campaigns
- GETGet Google Ads Campaigns Csv
- GETGet Campaign Metrics
- GETGet Campaign Metrics Csv
- POSTApply Migration
- GETCompare Campaignsdeprecated
- GETGet Google Ads Customers
- GETGet Google Ads Customers Csv
- GETGet Account Overview
- GETGet Account Overview Csv
- GETGet Ad Groups
- GETGet Ad Groups Csv
- GETGet Ads Data
- GETGet Ads Data Csv
- GETGet Ads Keywords
- GETGet Ads Keywords Csv
- GETGet Positive Keywords
- POSTAdd Positive Keyword
- PUTUpdate Positive Keyword
- DELDelete Positive Keyword
- POSTPause Keywords Batch
- POSTUnpause Keywords Batch
- GETGet Auction Insights
- GETGet Assets
- GETGet Search Terms
- GETGet Search Terms Csv
- GETGet Pmax Search Terms
- GETGet Ad Schedule
- GETGet Ad Schedule Csv
- GETGet Locations
- GETGet User Locations
- GETGet User Locations Csv
- GETGet Geographic Performance Report
- GETGet Geographic Performance Report Csv
- GETGet Device Performance
- GETGet Demographic Performance
- GETGet Quality Scores
- POSTTrigger Data Refresh
Google Ads Management
Google Ads - Locations & Languages
Google Ads Database
- GETGet Customers
- GETGet Customers Access
- GETGet All Customers Access
- GETGet Customer Company Members
- DELRemove Customer From Company
- PATCHAssign Customer To Company
- GETGet Customers Ownershipsdeprecated
- GETGet All Customers Ownershipsdeprecated
- GETGet Customer Owners Admindeprecated
- GETGet Campaigns
- GETGet Ad Groups
- GETGet Ads
Local SEO
Location Analytics
Chat
- GETGet Chat Threads
- POSTCreate Chat Thread
- GETGet Chat Thread Messages
- POSTCreate Chat Thread Message
- POSTCreate Chat Thread Message Streaming
- DELDelete Chat Thread
- POSTAnalyze Negative Keywords
- GETGet Gemini Prompts
- POSTCreate Gemini Prompt
- GETGet Gemini Prompt
- PUTUpdate Gemini Prompt
- DELDelete Gemini Prompt
- GETGet Prompt Variables
- POSTGet Formatted Gemini Prompt
- POSTExecute Gemini Prompt
Knowledge Items
Companies
Analysis
- GETGet Analyses
- GETGet Negative Keyword Recommendations
- GETGet Keyword Pause Recommendations
- GETGet Headline Recommendations
- GETGet Description Recommendations
- GETGet Recommendation Stats
- GETGet Negative Keyword Recommendation Stats
- GETGet Keyword Pause Recommendation Stats
- GETGet Headline Recommendation Stats
- GETGet Description Recommendation Stats
- GETGet Analyses Stats
- POSTApply Recommendation
- POSTReject Recommendation
- PUTUpdate Recommendation
- POSTUndo Recommendation
- POSTTrigger Analysis By Type
Analysis Customer Configs
Market Analysis
- GETList all market analyses
- POSTCreate a new market analysis
- GETGet a specific market analysis
- DELSoft-delete a market analysis
- PATCHUpdate a market analysis
- GETGet the latest forecast for a market analysis
- GETExport market analysis keywords to CSV
- POST(Re-)trigger keyword analysis for an existing analysis
- POSTUpdate keyword selection status
Campaigns
- GETGet available conversion actions
- GETGet available bidding strategies
- POSTCreate pre-populated campaign draft from market analysis
- GETList campaign drafts
- GETGet active campaign draft for a market analysis
- GETGet a campaign draft
- DELDelete a campaign draft
- PATCHUpdate campaign settings (step 1)
- POSTAdd an ad group to a draft
- PATCHBulk-patch ad groups and keywords (step 2)
- PATCHBulk-patch RSAs (step 3)
- PATCHUpdate extensions (step 4)
- POSTValidate draft for campaign creation
- POSTCreate campaign from draft
- PUTUpdate an ad group
- DELDelete an ad group
- POSTAdd a keyword to an ad group
- PUTUpdate a keyword
- DELDelete a keyword
- GETGet generation status for a draft
- GETList all RSAs in a draft
- POSTStart RSA generation for an ad group (creates 3 RSAs)
- POSTStart RSA generation for all ad groups (3 RSAs each)
- POSTStart extension generation for a draft (sitelinks, callouts, snippets)
- GETList RSAs for an ad group
- GETGet a specific RSA
- PUTUpdate an RSA
- DELDelete an RSA
- POSTRegenerate ad groups from keywords
- GETGet Live Campaign Settings
- DELRemove a live Google Ads campaign
- PATCHPatch Live Campaign Settings
Media
Bug Reports
Debug
- GETGet Enabled Functions
- POSTDebug Get Campaign Performance
- POSTDebug Get Bidding Strategy Data
- POSTDebug Get Ad Group Metrics
- POSTDebug Get Keyword Performance
- POSTDebug Get Ads Keywords
- POSTDebug Get Ad Group Ads
- POSTDebug Get Ads Descriptions
- POSTDebug Get Ads Headlines
- POSTDebug Get Search Terms
- POSTDebug Scrape Website Content
- POSTDebug Save Knowledge Item
- POSTDebug Get Frontend Actions
- POSTDebug Submit Frontend Action
- POSTDebug Get Negative Keyword Recommendations
- POSTDebug Get Keyword Pause Recommendations
- POSTDebug Get Headline Recommendations
- POSTDebug Get Description Recommendations
- POSTDebug Get Knowledge Item
- POSTDebug Get Campaign Metrics
- POSTDebug Get Campaigns
- POSTDebug Get Positive Keywords
- POSTDebug Get Negative Keywords
- POSTDebug Get Search Terms Data
- POSTDebug Get User Locations
Subscriptions
- GETGet All Subscriptions
- GETGet All Subscription Plans
- POSTCreate Subscription Plan
- GETGet Subscription Plan
- PUTUpdate Subscription Plan
- DELDelete Subscription Plan
- GETGet Plan Modules
- GETGet All Plan Modules
- POSTCreate Plan Module
- GETGet Plan Module
- PUTUpdate Plan Module
- DELDelete Plan Module
- POSTAssign Subscription To Customer
- GETGet Customer Subscriptions
- POSTGet Customers Subscriptions Bulk
- GETGet Subscription
- PUTUpdate Subscription
- DELDelete Subscription
- POSTCancel Subscription
- POSTReactivate Subscription
Tasks
Event Subscriptions
Get Auction Insights
curl --request GET \
--url http://localhost:8000/api/v1/google-ads/auction-insights \
--header 'Authorization: Bearer <token>'[
{
"display_name": "<string>",
"domain_url": "<string>",
"impression_share": 123,
"overlap_rate": 123,
"position_above_rate": 123,
"top_of_page_rate": 123,
"outranking_share": 123
}
]Google Ads
Get Auction Insights
Retrieve auction insights for campaigns or ad groups for a specified date range.
Args: customer_id: The Google Ads customer ID
campaign_id: Optional campaign ID filter ad_group_id: Optional ad group ID filter (takes precedence over campaign_id if both provided) start_date (str): Start date for the data range (YYYY-MM-DD). Defaults to 30 days ago. end_date (str): End date for the data range (YYYY-MM-DD). Defaults to today. oauth2_token: OAuth2 token for authentication
Returns: List of auction insights with competitor metrics
GET
/
api
/
v1
/
google-ads
/
auction-insights
Get Auction Insights
curl --request GET \
--url http://localhost:8000/api/v1/google-ads/auction-insights \
--header 'Authorization: Bearer <token>'[
{
"display_name": "<string>",
"domain_url": "<string>",
"impression_share": 123,
"overlap_rate": 123,
"position_above_rate": 123,
"top_of_page_rate": 123,
"outranking_share": 123
}
]Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
Optional specific Token ID
⌘I