# Docs @ CATTIX

## Docs

- [Claude Code setup](https://docs.cattix.com/ai-tools/claude-code.md): Configure Claude Code for your documentation workflow
- [Cursor setup](https://docs.cattix.com/ai-tools/cursor.md): Configure Cursor for your documentation workflow
- [Windsurf setup](https://docs.cattix.com/ai-tools/windsurf.md): Configure Windsurf for your documentation workflow
- [Convert Time To Utc](https://docs.cattix.com/api-reference/analysis-customer-configs/convert-time-to-utc.md): Convert customer timezone time to UTC for tooltip display.
- [Create Config](https://docs.cattix.com/api-reference/analysis-customer-configs/create-config.md)
- [Delete Config](https://docs.cattix.com/api-reference/analysis-customer-configs/delete-config.md): Delete specific analysis config (admin only).
- [Edit My Config](https://docs.cattix.com/api-reference/analysis-customer-configs/edit-my-config.md): Edit or create analysis config for a specific customer and analysis type.
- [Get All Configs](https://docs.cattix.com/api-reference/analysis-customer-configs/get-all-configs.md): Get all analysis configs (admin only).
- [Get Config](https://docs.cattix.com/api-reference/analysis-customer-configs/get-config.md): Get specific analysis config (admin only).
- [Get My Configs](https://docs.cattix.com/api-reference/analysis-customer-configs/get-my-configs.md): Get analysis config for a specific customer and analysis type (user must own the customer).
- [Update Config](https://docs.cattix.com/api-reference/analysis-customer-configs/update-config.md): Update specific analysis config (admin only).
- [Apply Recommendation](https://docs.cattix.com/api-reference/analysis/apply-recommendation.md): Approve a recommendation.
- [Get Analyses](https://docs.cattix.com/api-reference/analysis/get-analyses.md): Get all analyses with pagination. Only superusers can access this endpoint.
- [Get Analyses Stats](https://docs.cattix.com/api-reference/analysis/get-analyses-stats.md): Get successful analysis statistics for a specific analysis type.
- [Get Description Recommendation Stats](https://docs.cattix.com/api-reference/analysis/get-description-recommendation-stats.md): Get description recommendation statistics.
- [Get Description Recommendations](https://docs.cattix.com/api-reference/analysis/get-description-recommendations.md): Get description recommendations.
- [Get Headline Recommendation Stats](https://docs.cattix.com/api-reference/analysis/get-headline-recommendation-stats.md): Get headline recommendation statistics.
- [Get Headline Recommendations](https://docs.cattix.com/api-reference/analysis/get-headline-recommendations.md): Get headline recommendations.
- [Get Keyword Pause Recommendation Stats](https://docs.cattix.com/api-reference/analysis/get-keyword-pause-recommendation-stats.md): Get keyword pause recommendation statistics.
- [Get Keyword Pause Recommendations](https://docs.cattix.com/api-reference/analysis/get-keyword-pause-recommendations.md): Get keyword pause recommendations.
- [Get Negative Keyword Recommendation Stats](https://docs.cattix.com/api-reference/analysis/get-negative-keyword-recommendation-stats.md): Get negative keyword recommendation statistics.
- [Get Negative Keyword Recommendations](https://docs.cattix.com/api-reference/analysis/get-negative-keyword-recommendations.md): Get negative keyword recommendations.
- [Get Recommendation Stats](https://docs.cattix.com/api-reference/analysis/get-recommendation-stats.md): Get recommendation statistics for a specific analysis type.
- [Reject Recommendation](https://docs.cattix.com/api-reference/analysis/reject-recommendation.md): Reject a recommendation.
- [Trigger Analysis By Type](https://docs.cattix.com/api-reference/analysis/trigger-analysis-by-type.md): Trigger the analysis of the `{analysis_type}`.
- [Undo Recommendation](https://docs.cattix.com/api-reference/analysis/undo-recommendation.md): Undo a recommendation by reversing the appropriate action based on current status.
- [Update Recommendation](https://docs.cattix.com/api-reference/analysis/update-recommendation.md): Update a recommendation's text (only for Headlines and Descriptions).
- [Create Bug Report](https://docs.cattix.com/api-reference/bug-reports/create-bug-report.md): Create a new bug report. Requires approved user privileges. The user submitting the request will be assigned as the reporter.
- [Delete Bug Report](https://docs.cattix.com/api-reference/bug-reports/delete-bug-report.md): Delete a bug report by its ID. Requires superuser privileges.
- [Get Bug Report](https://docs.cattix.com/api-reference/bug-reports/get-bug-report.md): Get a specific bug report by its ID. Requires superuser privileges.
- [Get Bug Reports](https://docs.cattix.com/api-reference/bug-reports/get-bug-reports.md): Get the list of all bug reports. Requires superuser privileges.
- [Send Message](https://docs.cattix.com/api-reference/bug-reports/send-message.md): Send us a message. This endpoint allows users to send messages without authentication.
- [Update Bug Report](https://docs.cattix.com/api-reference/bug-reports/update-bug-report.md): Update an existing bug report by its ID. Requires superuser privileges.
- [Add a keyword to an ad group](https://docs.cattix.com/api-reference/campaigns/add-a-keyword-to-an-ad-group.md): Create a new keyword within an ad group.
- [Add an ad group to a draft](https://docs.cattix.com/api-reference/campaigns/add-an-ad-group-to-a-draft.md): Create a new ad group within a campaign draft.
- [Bulk-patch ad groups and keywords (step 2)](https://docs.cattix.com/api-reference/campaigns/bulk-patch-ad-groups-and-keywords-step-2.md): Bulk partial update of ad groups (and nested keywords) on a draft.
- [Bulk-patch RSAs (step 3)](https://docs.cattix.com/api-reference/campaigns/bulk-patch-rsas-step-3.md): Bulk partial update of Responsive Search Ads on a draft.
- [Create campaign from draft](https://docs.cattix.com/api-reference/campaigns/create-campaign-from-draft.md): Create a Google Ads campaign from a saved draft.
- [Create pre-populated campaign draft from market analysis](https://docs.cattix.com/api-reference/campaigns/create-pre-populated-campaign-draft-from-market-analysis.md): Get pre-populated campaign configuration based on a market analysis.
- [Delete a campaign draft](https://docs.cattix.com/api-reference/campaigns/delete-a-campaign-draft.md): Delete a campaign draft (soft delete).
- [Delete a keyword](https://docs.cattix.com/api-reference/campaigns/delete-a-keyword.md): Delete a keyword (soft delete).
- [Delete an ad group](https://docs.cattix.com/api-reference/campaigns/delete-an-ad-group.md): Delete an ad group and all its keywords (soft delete).
- [Delete an RSA](https://docs.cattix.com/api-reference/campaigns/delete-an-rsa.md): Delete an RSA (soft delete).
- [Get a campaign draft](https://docs.cattix.com/api-reference/campaigns/get-a-campaign-draft.md): Get a specific campaign draft by ID with all ad groups, keywords, and RSAs.
- [Get a specific RSA](https://docs.cattix.com/api-reference/campaigns/get-a-specific-rsa.md): Get a specific RSA with full content.
- [Get active campaign draft for a market analysis](https://docs.cattix.com/api-reference/campaigns/get-active-campaign-draft-for-a-market-analysis.md): Get the most recent active draft for a market analysis.
- [Get available bidding strategies](https://docs.cattix.com/api-reference/campaigns/get-available-bidding-strategies.md): Get available bidding strategies for campaign creation.
- [Get available conversion actions](https://docs.cattix.com/api-reference/campaigns/get-available-conversion-actions.md): Get conversion actions available for the specified Google Ads account.
- [Get generation status for a draft](https://docs.cattix.com/api-reference/campaigns/get-generation-status-for-a-draft.md): Get the generation status for ad groups and RSAs in a draft. Useful for polling during async operations.
- [Get Live Campaign Settings](https://docs.cattix.com/api-reference/campaigns/get-live-campaign-settings.md): Fetch current settings for a live Google Ads campaign (for the edit UI).
- [List all RSAs in a draft](https://docs.cattix.com/api-reference/campaigns/list-all-rsas-in-a-draft.md): List all RSAs across all ad groups in a draft.
- [List campaign drafts](https://docs.cattix.com/api-reference/campaigns/list-campaign-drafts.md): List all campaign drafts for a Google Ads customer.
- [List RSAs for an ad group](https://docs.cattix.com/api-reference/campaigns/list-rsas-for-an-ad-group.md): List all RSAs for a specific ad group.
- [Patch Live Campaign Settings](https://docs.cattix.com/api-reference/campaigns/patch-live-campaign-settings.md): Update settings on a live Google Ads campaign.
- [Regenerate ad groups from keywords](https://docs.cattix.com/api-reference/campaigns/regenerate-ad-groups-from-keywords.md): Re-split keywords into ad groups using Gemini AI.
- [Remove a live Google Ads campaign](https://docs.cattix.com/api-reference/campaigns/remove-a-live-google-ads-campaign.md): Permanently remove a live Google Ads campaign.
- [Start extension generation for a draft (sitelinks, callouts, snippets)](https://docs.cattix.com/api-reference/campaigns/start-extension-generation-for-a-draft-sitelinks-callouts-snippets.md): Start extension generation for a draft using LLM.
- [Start RSA generation for all ad groups (3 RSAs each)](https://docs.cattix.com/api-reference/campaigns/start-rsa-generation-for-all-ad-groups-3-rsas-each.md): Start RSA generation for all ad groups in a draft.
- [Start RSA generation for an ad group (creates 3 RSAs)](https://docs.cattix.com/api-reference/campaigns/start-rsa-generation-for-an-ad-group-creates-3-rsas.md): Start RSA generation for a specific ad group using Gemini AI.
- [Update a keyword](https://docs.cattix.com/api-reference/campaigns/update-a-keyword.md): Update a keyword's text, match type, bid, or URL.
- [Update an ad group](https://docs.cattix.com/api-reference/campaigns/update-an-ad-group.md): Update an ad group's name or bid.
- [Update an RSA](https://docs.cattix.com/api-reference/campaigns/update-an-rsa.md): Update an RSA's headlines, descriptions, or URL configuration.
- [Update campaign settings (step 1)](https://docs.cattix.com/api-reference/campaigns/update-campaign-settings-step-1.md): Partial update of campaign-level settings on a draft.
- [Update extensions (step 4)](https://docs.cattix.com/api-reference/campaigns/update-extensions-step-4.md): Partial update of extensions on a draft.
- [Validate draft for campaign creation](https://docs.cattix.com/api-reference/campaigns/validate-draft-for-campaign-creation.md): Validate a campaign draft before creation.
- [Analyze Negative Keywords](https://docs.cattix.com/api-reference/chat/analyze-negative-keywords.md): Analyze the negative keywords for the Google Ads customer with the given ID.
- [Create Chat Thread](https://docs.cattix.com/api-reference/chat/create-chat-thread.md): Create a chat thread.
- [Create Chat Thread Message](https://docs.cattix.com/api-reference/chat/create-chat-thread-message.md): Create a message in the chat thread with the given ID.
- [Create Chat Thread Message Streaming](https://docs.cattix.com/api-reference/chat/create-chat-thread-message-streaming.md): Create a message in the chat thread with the given ID.
- [Create Gemini Prompt](https://docs.cattix.com/api-reference/chat/create-gemini-prompt.md): Create a Gemini prompt.
- [Delete Chat Thread](https://docs.cattix.com/api-reference/chat/delete-chat-thread.md): Delete a chat thread by its thread_id.
- [Delete Gemini Prompt](https://docs.cattix.com/api-reference/chat/delete-gemini-prompt.md): Delete the Gemini prompt for the given ID.
- [Execute Gemini Prompt](https://docs.cattix.com/api-reference/chat/execute-gemini-prompt.md): Execute the Gemini prompt via OpenRouter.
- [Get Chat Thread Messages](https://docs.cattix.com/api-reference/chat/get-chat-thread-messages.md): Get the messages of the chat thread with the given ID.
- [Get Chat Threads](https://docs.cattix.com/api-reference/chat/get-chat-threads.md): Get the list of chat threads.
- [Get  Formatted Gemini Prompt](https://docs.cattix.com/api-reference/chat/get-formatted-gemini-prompt.md): Get the formatted Gemini prompt for the given prompt type. Args:     prompt_id (int): The ID of the Gemini prompt     campaign_id (int): The ID of the campaign     customer_id (int): The ID of the Google Ads customer     login_customer_id (int | None): The ID of the Google Ads login customer     pro…
- [Get Gemini Prompt](https://docs.cattix.com/api-reference/chat/get-gemini-prompt.md): Get the Gemini prompt for the given ID.
- [Get Gemini Prompts](https://docs.cattix.com/api-reference/chat/get-gemini-prompts.md): Get the Gemini prompt for the given prompt type.
- [Get  Prompt Variables](https://docs.cattix.com/api-reference/chat/get-prompt-variables.md): Get the list of prompt variables.
- [Update Gemini Prompt](https://docs.cattix.com/api-reference/chat/update-gemini-prompt.md): Update the Gemini prompt for the given ID.
- [Add Company Member](https://docs.cattix.com/api-reference/companies/add-company-member.md): Add a User to a Company given User's `.id` (admin only).
- [Add Company Member By Email](https://docs.cattix.com/api-reference/companies/add-company-member-by-email.md): Add a User to a Company given User's email (admin only).
- [Create My Company](https://docs.cattix.com/api-reference/companies/create-my-company.md): Create a new company and add the current user as a member.
- [Delete Company](https://docs.cattix.com/api-reference/companies/delete-company.md): Delete a company (admin only, soft delete).
- [Delete My Company](https://docs.cattix.com/api-reference/companies/delete-my-company.md): Delete a company that the user belongs to (soft delete).
- [Get All Companies](https://docs.cattix.com/api-reference/companies/get-all-companies.md): Get all companies (admin only).
- [Get All My Connections](https://docs.cattix.com/api-reference/companies/get-all-my-connections.md): Get all connections across all the current user's companies.
- [Get Company](https://docs.cattix.com/api-reference/companies/get-company.md): Get a specific company (admin only).
- [Get My Companies](https://docs.cattix.com/api-reference/companies/get-my-companies.md): Get all companies that the current user belongs to.
- [Get My Company](https://docs.cattix.com/api-reference/companies/get-my-company.md): Get a specific company that the user belongs to.
- [Get My Company Connections](https://docs.cattix.com/api-reference/companies/get-my-company-connections.md): Get company information along with all connections for that company.
- [Remove Company Member](https://docs.cattix.com/api-reference/companies/remove-company-member.md): Remove a user from a company (admin only).
- [Update My Company](https://docs.cattix.com/api-reference/companies/update-my-company.md): Update a company that the user belongs to.
- [Debug Get Ad Group Ads](https://docs.cattix.com/api-reference/debug/debug-get-ad-group-ads.md): Debug the get_ad_group_ads function.
- [Debug Get Ad Group Metrics](https://docs.cattix.com/api-reference/debug/debug-get-ad-group-metrics.md): Debug the get_ad_group_metrics function.
- [Debug Get Ads Descriptions](https://docs.cattix.com/api-reference/debug/debug-get-ads-descriptions.md): Debug the get_ads_descriptions function.
- [Debug Get Ads Headlines](https://docs.cattix.com/api-reference/debug/debug-get-ads-headlines.md): Debug the get_ads_headlines function.
- [Debug Get Ads Keywords](https://docs.cattix.com/api-reference/debug/debug-get-ads-keywords.md): Debug the get_ads_keywords function.
- [Debug Get Bidding Strategy Data](https://docs.cattix.com/api-reference/debug/debug-get-bidding-strategy-data.md): Debug the get_bidding_strategy_data function.
- [Debug Get Campaign Metrics](https://docs.cattix.com/api-reference/debug/debug-get-campaign-metrics.md): Debug the get_campaign_metrics function.
- [Debug Get Campaign Performance](https://docs.cattix.com/api-reference/debug/debug-get-campaign-performance.md): Debug the get_campaign_performance function.
- [Debug Get Campaigns](https://docs.cattix.com/api-reference/debug/debug-get-campaigns.md): Debug the get_campaigns function.
- [Debug Get Description Recommendations](https://docs.cattix.com/api-reference/debug/debug-get-description-recommendations.md): Debug the get_description_recommendations function.
- [Debug Get Frontend Actions](https://docs.cattix.com/api-reference/debug/debug-get-frontend-actions.md): Debug the get_frontend_actions function.
- [Debug Get Headline Recommendations](https://docs.cattix.com/api-reference/debug/debug-get-headline-recommendations.md): Debug the get_headline_recommendations function.
- [Debug Get Keyword Pause Recommendations](https://docs.cattix.com/api-reference/debug/debug-get-keyword-pause-recommendations.md): Debug the get_keyword_pause_recommendations function.
- [Debug Get Keyword Performance](https://docs.cattix.com/api-reference/debug/debug-get-keyword-performance.md): Debug the get_keyword_performance function.
- [Debug Get Knowledge Item](https://docs.cattix.com/api-reference/debug/debug-get-knowledge-item.md): Debug the `get_knowledge_item` function.
- [Debug Get Negative Keyword Recommendations](https://docs.cattix.com/api-reference/debug/debug-get-negative-keyword-recommendations.md): Debug the get_negative_keyword_recommendations function.
- [Debug Get Negative Keywords](https://docs.cattix.com/api-reference/debug/debug-get-negative-keywords.md): Debug the get_negative_keywords function.
- [Debug Get Positive Keywords](https://docs.cattix.com/api-reference/debug/debug-get-positive-keywords.md): Debug the get_positive_keywords function.
- [Debug Get Search Terms](https://docs.cattix.com/api-reference/debug/debug-get-search-terms.md): Debug the get_search_terms function.
- [Debug Get Search Terms Data](https://docs.cattix.com/api-reference/debug/debug-get-search-terms-data.md): Debug the get_search_terms_data function.
- [Debug Get User Locations](https://docs.cattix.com/api-reference/debug/debug-get-user-locations.md): Debug the get_user_locations function.
- [Debug Save Knowledge Item](https://docs.cattix.com/api-reference/debug/debug-save-knowledge-item.md): Debug the save_knowledge_item function.
- [Debug Scrape Website Content](https://docs.cattix.com/api-reference/debug/debug-scrape-website-content.md): Debug the scrape_website_content function.
- [Debug Submit Frontend Action](https://docs.cattix.com/api-reference/debug/debug-submit-frontend-action.md): Debug the submit_frontend_action function.
- [Get Enabled Functions](https://docs.cattix.com/api-reference/debug/get-enabled-functions.md): Get all enabled functions and their parameters from inspection.
- [Create Plant](https://docs.cattix.com/api-reference/endpoint/create.md): Creates a new plant in the store
- [Delete Plant](https://docs.cattix.com/api-reference/endpoint/delete.md): Deletes a single plant based on the ID supplied
- [Get Plants](https://docs.cattix.com/api-reference/endpoint/get.md): Returns all plants from the system that the user has access to
- [New Plant](https://docs.cattix.com/api-reference/endpoint/webhook.md): Information about a new plant added to the store
- [Get User Subscriptions](https://docs.cattix.com/api-reference/event-subscriptions/get-user-subscriptions.md)
- [Subscribe To Event](https://docs.cattix.com/api-reference/event-subscriptions/subscribe-to-event.md)
- [Unsubscribe From Event](https://docs.cattix.com/api-reference/event-subscriptions/unsubscribe-from-event.md)
- [Look up language details by ID](https://docs.cattix.com/api-reference/google-ads--locations-&-languages/look-up-language-details-by-id.md): Get language details for a specific language ID with caching.
- [Look up location details by IDs](https://docs.cattix.com/api-reference/google-ads--locations-&-languages/look-up-location-details-by-ids.md): Get location details for specific location IDs with caching.
- [Search for language suggestions](https://docs.cattix.com/api-reference/google-ads--locations-&-languages/search-for-language-suggestions.md): Search for language suggestions using LanguageConstant with caching.
- [Search for location suggestions](https://docs.cattix.com/api-reference/google-ads--locations-&-languages/search-for-location-suggestions.md): Search for location suggestions using GeoTargetConstantService with caching.
- [Assign Customer To Company](https://docs.cattix.com/api-reference/google-ads-database/assign-customer-to-company.md): Assign a Google Ads customer to a company.
- [Get Ad Groups](https://docs.cattix.com/api-reference/google-ads-database/get-ad-groups.md): Get Google Ads ad groups for a specific customer from the database.
- [Get Ads](https://docs.cattix.com/api-reference/google-ads-database/get-ads.md): Get Google Ads ads for a specific customer from the database.
- [Get All Customers Access](https://docs.cattix.com/api-reference/google-ads-database/get-all-customers-access.md): Get all Google Ads customer access records from the database (admin only).
- [Get All Customers Ownerships](https://docs.cattix.com/api-reference/google-ads-database/get-all-customers-ownerships.md): Get all Google Ads customer ownerships from the database (admin only).
- [Get Campaigns](https://docs.cattix.com/api-reference/google-ads-database/get-campaigns.md): Get Google Ads campaigns for a specific customer from the database.
- [Get Customer Company Members](https://docs.cattix.com/api-reference/google-ads-database/get-customer-company-members.md): Get all users who are members of the company that owns a specific Google Ads customer (admin only).
- [Get Customer Owners Admin](https://docs.cattix.com/api-reference/google-ads-database/get-customer-owners-admin.md): Get all users who have ownership of a specific Google Ads customer (admin only).
- [Get Customers](https://docs.cattix.com/api-reference/google-ads-database/get-customers.md): Get Google Ads customers for the current user from the database.
- [Get Customers Access](https://docs.cattix.com/api-reference/google-ads-database/get-customers-access.md): Get Google Ads customers accessible to the current user through company memberships.
- [Get Customers Ownerships](https://docs.cattix.com/api-reference/google-ads-database/get-customers-ownerships.md): Get Google Ads customer ownerships for the current user from the database.
- [Remove Customer From Company](https://docs.cattix.com/api-reference/google-ads-database/remove-customer-from-company.md): Remove a Google Ads customer from its current company.
- [Add Locations](https://docs.cattix.com/api-reference/google-ads-management/add-locations.md): Add location targeting to a campaign.
- [Create Ad Group](https://docs.cattix.com/api-reference/google-ads-management/create-ad-group.md): Create a new ad group in a campaign.
- [Create Ad Schedule](https://docs.cattix.com/api-reference/google-ads-management/create-ad-schedule.md): Add ad schedule entries to a campaign.
- [Create Keywords](https://docs.cattix.com/api-reference/google-ads-management/create-keywords.md): Create keywords in an ad group.
- [Create Rsa](https://docs.cattix.com/api-reference/google-ads-management/create-rsa.md): Create a Responsive Search Ad.
- [Delete Ad](https://docs.cattix.com/api-reference/google-ads-management/delete-ad.md): Remove (delete) an ad from an ad group.
- [Delete Ad Group](https://docs.cattix.com/api-reference/google-ads-management/delete-ad-group.md): Remove (delete) an ad group.
- [Delete Ad Schedule](https://docs.cattix.com/api-reference/google-ads-management/delete-ad-schedule.md): Delete ad schedule criteria by resource names.
- [Delete Location Targeting](https://docs.cattix.com/api-reference/google-ads-management/delete-location-targeting.md): Delete location targeting criteria by resource names.
- [Remove Keywords](https://docs.cattix.com/api-reference/google-ads-management/remove-keywords.md): Remove keywords from ad groups.
- [Replace Ad Schedule](https://docs.cattix.com/api-reference/google-ads-management/replace-ad-schedule.md): Replace all ad schedule entries on a campaign.
- [Replace Locations](https://docs.cattix.com/api-reference/google-ads-management/replace-locations.md): Replace all location targeting on a campaign.
- [Update Ad Group Status](https://docs.cattix.com/api-reference/google-ads-management/update-ad-group-status.md): Update an ad group's status (ENABLED/PAUSED).
- [Update Keyword](https://docs.cattix.com/api-reference/google-ads-management/update-keyword.md): Update a keyword's status and/or CPC bid.
- [Update Rsa](https://docs.cattix.com/api-reference/google-ads-management/update-rsa.md): Update a Responsive Search Ad.
- [Add Positive Keyword](https://docs.cattix.com/api-reference/google-ads/add-positive-keyword.md): Add a Positive Keyword to the database.
- [Apply Migration](https://docs.cattix.com/api-reference/google-ads/apply-migration.md): Apply a recommended budget migration between campaigns.
- [Compare Campaigns](https://docs.cattix.com/api-reference/google-ads/compare-campaigns.md): Compare campaign performance between two specified periods. If previous dates are not provided, they are calculated based on the current period's duration.
- [Delete Positive Keyword](https://docs.cattix.com/api-reference/google-ads/delete-positive-keyword.md): Delete a Positive Keyword from the database.
- [Get Account Overview](https://docs.cattix.com/api-reference/google-ads/get-account-overview.md): Get overview metrics for Google Ads account for a specified date range.
- [Get Account Overview Csv](https://docs.cattix.com/api-reference/google-ads/get-account-overview-csv.md): Get overview metrics for Google Ads account as CSV format.
- [Get Ad Groups](https://docs.cattix.com/api-reference/google-ads/get-ad-groups.md): Retrieve ad groups and their performance metrics for a specified date range.
- [Get Ad Groups Csv](https://docs.cattix.com/api-reference/google-ads/get-ad-groups-csv.md): Retrieve ad groups and their performance metrics as CSV format.
- [Get Ad Schedule](https://docs.cattix.com/api-reference/google-ads/get-ad-schedule.md): Retrieve ad schedule targeting criteria.
- [Get Ad Schedule Csv](https://docs.cattix.com/api-reference/google-ads/get-ad-schedule-csv.md): Retrieve ad schedule targeting criteria as CSV format.
- [Get Ads Data](https://docs.cattix.com/api-reference/google-ads/get-ads-data.md): Retrieve detailed ad data including performance metrics for the specified customer and date range.
- [Get Ads Data Csv](https://docs.cattix.com/api-reference/google-ads/get-ads-data-csv.md): Retrieve detailed ad data including performance metrics as CSV format.
- [Get Ads Keywords](https://docs.cattix.com/api-reference/google-ads/get-ads-keywords.md): Retrieve keywords (positive or negative) with performance for a specified date range.
- [Get Ads Keywords Csv](https://docs.cattix.com/api-reference/google-ads/get-ads-keywords-csv.md): Retrieve keywords (positive or negative) with performance as CSV format.
- [Get Assets](https://docs.cattix.com/api-reference/google-ads/get-assets.md): Retrieve assets used in ads, linked via campaigns.
- [Get Auction Insights](https://docs.cattix.com/api-reference/google-ads/get-auction-insights.md): Retrieve auction insights for campaigns or ad groups for a specified date range.
- [Get Campaign Metrics](https://docs.cattix.com/api-reference/google-ads/get-campaign-metrics.md): Retrieve metrics for a specific campaign. (Currently retrieves lifetime/overall metrics).
- [Get Campaign Metrics Csv](https://docs.cattix.com/api-reference/google-ads/get-campaign-metrics-csv.md): Retrieve metrics for a specific campaign as CSV format.
- [Get Demographic Performance](https://docs.cattix.com/api-reference/google-ads/get-demographic-performance.md): Retrieve performance metrics segmented by demographics for a specified date range.
- [Get Device Performance](https://docs.cattix.com/api-reference/google-ads/get-device-performance.md): Retrieve performance metrics segmented by device type for a specified date range.
- [Get Geographic Performance Report](https://docs.cattix.com/api-reference/google-ads/get-geographic-performance-report.md): Retrieve Geographic Performance Report for a specified date range.
- [Get Geographic Performance Report Csv](https://docs.cattix.com/api-reference/google-ads/get-geographic-performance-report-csv.md): Retrieve Geographic Performance Report for a specified date range as CSV format.
- [Get Google Ads Campaigns](https://docs.cattix.com/api-reference/google-ads/get-google-ads-campaigns.md): Retrieve Google Ads campaigns, storing in and retrieving from MongoDB.
- [Get Google Ads Campaigns Csv](https://docs.cattix.com/api-reference/google-ads/get-google-ads-campaigns-csv.md): Retrieve Google Ads campaigns as CSV format.
- [Get Google Ads Customers](https://docs.cattix.com/api-reference/google-ads/get-google-ads-customers.md): Retrieve all available Google Ads customer IDs organized hierarchically by manager accounts.
- [Get Google Ads Customers Csv](https://docs.cattix.com/api-reference/google-ads/get-google-ads-customers-csv.md): Retrieve all available Google Ads customer IDs as CSV format.
- [Get Locations](https://docs.cattix.com/api-reference/google-ads/get-locations.md): Retrieve location targeting settings for campaigns.
- [Get Pmax Search Terms](https://docs.cattix.com/api-reference/google-ads/get-pmax-search-terms.md): Retrieve PMAX search terms that triggered ads for a specified campaign.
- [Get Positive Keywords](https://docs.cattix.com/api-reference/google-ads/get-positive-keywords.md): Get Positive Keywords from the database.
- [Get Quality Scores](https://docs.cattix.com/api-reference/google-ads/get-quality-scores.md): Retrieve quality score data for keywords.
- [Get Search Terms](https://docs.cattix.com/api-reference/google-ads/get-search-terms.md): Retrieve search terms that triggered ads for a specified date range.
- [Get Search Terms Csv](https://docs.cattix.com/api-reference/google-ads/get-search-terms-csv.md): Retrieve search terms as CSV format.
- [Get User Locations](https://docs.cattix.com/api-reference/google-ads/get-user-locations.md): Retrieve Google Ads targeted campaign locations using user_location_view.
- [Get User Locations Csv](https://docs.cattix.com/api-reference/google-ads/get-user-locations-csv.md): Retrieve Google Ads targeted campaign locations as CSV format.
- [Pause Keywords Batch](https://docs.cattix.com/api-reference/google-ads/pause-keywords-batch.md): Pause multiple keywords in batch.
- [Trigger Data Refresh](https://docs.cattix.com/api-reference/google-ads/trigger-data-refresh.md): Trigger a data refresh for the specified customer ID.
- [Unpause Keywords Batch](https://docs.cattix.com/api-reference/google-ads/unpause-keywords-batch.md): Unpause (enable) multiple keywords in batch.
- [Update Positive Keyword](https://docs.cattix.com/api-reference/google-ads/update-positive-keyword.md): Update a Positive Keyword in the database.
- [Delete Google Token](https://docs.cattix.com/api-reference/google-auth/delete-google-token.md): Delete a Google OAuth2 token.
- [Get Google Tokens](https://docs.cattix.com/api-reference/google-auth/get-google-tokens.md): Get Google OAuth2 tokens from the database.
- [Google Oauth Callback](https://docs.cattix.com/api-reference/google-auth/google-oauth-callback.md): Enhanced Google OAuth callback with multiple error checks.
- [Initiate Google Oauth](https://docs.cattix.com/api-reference/google-auth/initiate-google-oauth.md): Initiate Google OAuth2 authorization flow.
- [Signin With Google](https://docs.cattix.com/api-reference/google-auth/signin-with-google.md): Sign in with Google using ID token.
- [Introduction](https://docs.cattix.com/api-reference/introduction.md): Example section for showcasing API endpoints
- [Create Knowledge Item](https://docs.cattix.com/api-reference/knowledge-items/create-knowledge-item.md): Create a knowledge item.
- [Create My Knowledge Item](https://docs.cattix.com/api-reference/knowledge-items/create-my-knowledge-item.md): Create a knowledge item for user's company.
- [Delete Knowledge Item](https://docs.cattix.com/api-reference/knowledge-items/delete-knowledge-item.md): Delete the knowledge item for the given ID.
- [Delete My Knowledge Item](https://docs.cattix.com/api-reference/knowledge-items/delete-my-knowledge-item.md): Delete a knowledge item (user must belong to the knowledge item's company).
- [Get Knowledge Item](https://docs.cattix.com/api-reference/knowledge-items/get-knowledge-item.md): Get the knowledge item for the given ID.
- [Get Knowledge Items](https://docs.cattix.com/api-reference/knowledge-items/get-knowledge-items.md): Get the knowledge items for the company with the given ID.
- [Get My Knowledge Item](https://docs.cattix.com/api-reference/knowledge-items/get-my-knowledge-item.md): Get a specific knowledge item (user must belong to the knowledge item's company).
- [Get My Latest Knowledge Item](https://docs.cattix.com/api-reference/knowledge-items/get-my-latest-knowledge-item.md): Get the latest knowledge item for a specific company (user must belong to the company).
- [Update Knowledge Item](https://docs.cattix.com/api-reference/knowledge-items/update-knowledge-item.md): Update the knowledge item for the given ID.
- [Update My Knowledge Item](https://docs.cattix.com/api-reference/knowledge-items/update-my-knowledge-item.md): Update a knowledge item (user must belong to the knowledge item's company).
- [Assign Location To Company](https://docs.cattix.com/api-reference/local-seo/assign-location-to-company.md)
- [Get Google Business Profiles](https://docs.cattix.com/api-reference/local-seo/get-google-business-profiles.md)
- [Get Location Details](https://docs.cattix.com/api-reference/local-seo/get-location-details.md)
- [Remove Location From Company](https://docs.cattix.com/api-reference/local-seo/remove-location-from-company.md)
- [Trigger Reviews Sync](https://docs.cattix.com/api-reference/local-seo/trigger-reviews-sync.md)
- [Export Location Report](https://docs.cattix.com/api-reference/location-analytics/export-location-report.md)
- [Get Location Detailed Performance Metrics](https://docs.cattix.com/api-reference/location-analytics/get-location-detailed-performance-metrics.md)
- [Get Location Performance Metrics](https://docs.cattix.com/api-reference/location-analytics/get-location-performance-metrics.md)
- [Get Location Reviews Metrics](https://docs.cattix.com/api-reference/location-analytics/get-location-reviews-metrics.md)
- [Create a new market analysis](https://docs.cattix.com/api-reference/market-analysis/create-a-new-market-analysis.md): Create a new market analysis session.
- [Export market analysis keywords to CSV](https://docs.cattix.com/api-reference/market-analysis/export-market-analysis-keywords-to-csv.md): Export keywords for a market analysis to CSV format.
- [Get a specific market analysis](https://docs.cattix.com/api-reference/market-analysis/get-a-specific-market-analysis.md): Get a specific market analysis with all keywords.
- [Get the latest forecast for a market analysis](https://docs.cattix.com/api-reference/market-analysis/get-the-latest-forecast-for-a-market-analysis.md): Get the most recent forecast for a specific market analysis.
- [List all market analyses](https://docs.cattix.com/api-reference/market-analysis/list-all-market-analyses.md): List all market analyses for a given Google Ads customer.
- [(Re-)trigger keyword analysis for an existing analysis](https://docs.cattix.com/api-reference/market-analysis/re-trigger-keyword-analysis-for-an-existing-analysis.md): Re-trigger keyword analysis for an existing market analysis.
- [Soft-delete a market analysis](https://docs.cattix.com/api-reference/market-analysis/soft-delete-a-market-analysis.md): Soft-delete a market analysis.
- [Update a market analysis](https://docs.cattix.com/api-reference/market-analysis/update-a-market-analysis.md): Update a market analysis.
- [Update keyword selection status](https://docs.cattix.com/api-reference/market-analysis/update-keyword-selection-status.md): Select or unselect specific keywords from a market analysis.
- [Bulk Delete Media Assets](https://docs.cattix.com/api-reference/media/bulk-delete-media-assets.md)
- [Bulk Import Freepik Assets](https://docs.cattix.com/api-reference/media/bulk-import-freepik-assets.md)
- [Create Ai Generated Image](https://docs.cattix.com/api-reference/media/create-ai-generated-image.md)
- [Create Media Archive](https://docs.cattix.com/api-reference/media/create-media-archive.md)
- [Create Media Assets](https://docs.cattix.com/api-reference/media/create-media-assets.md)
- [List Media Assets](https://docs.cattix.com/api-reference/media/list-media-assets.md)
- [Search Freepik Assets](https://docs.cattix.com/api-reference/media/search-freepik-assets.md)
- [Update Media Asset](https://docs.cattix.com/api-reference/media/update-media-asset.md)
- [Root](https://docs.cattix.com/api-reference/root.md): Return a hello world message.
- [Assign Subscription To Customer](https://docs.cattix.com/api-reference/subscriptions/assign-subscription-to-customer.md)
- [Cancel Subscription](https://docs.cattix.com/api-reference/subscriptions/cancel-subscription.md)
- [Create Plan Module](https://docs.cattix.com/api-reference/subscriptions/create-plan-module.md): Create a new plan module. Superuser only.
- [Create Subscription Plan](https://docs.cattix.com/api-reference/subscriptions/create-subscription-plan.md)
- [Delete Plan Module](https://docs.cattix.com/api-reference/subscriptions/delete-plan-module.md): Delete a plan module (soft delete). Superuser only.
- [Delete Subscription](https://docs.cattix.com/api-reference/subscriptions/delete-subscription.md): Hard delete a subscription. Superuser only. This action is irreversible.
- [Delete Subscription Plan](https://docs.cattix.com/api-reference/subscriptions/delete-subscription-plan.md)
- [Get All Plan Modules](https://docs.cattix.com/api-reference/subscriptions/get-all-plan-modules.md): List all plan modules. Superuser only.
- [Get All Subscription Plans](https://docs.cattix.com/api-reference/subscriptions/get-all-subscription-plans.md)
- [Get All Subscriptions](https://docs.cattix.com/api-reference/subscriptions/get-all-subscriptions.md): List all subscriptions with optional filtering and pagination. Superuser only.
- [Get Customer Subscriptions](https://docs.cattix.com/api-reference/subscriptions/get-customer-subscriptions.md)
- [Get Customers Subscriptions Bulk](https://docs.cattix.com/api-reference/subscriptions/get-customers-subscriptions-bulk.md)
- [Get Plan Module](https://docs.cattix.com/api-reference/subscriptions/get-plan-module.md): Get a specific plan module. Superuser only.
- [Get Plan Modules](https://docs.cattix.com/api-reference/subscriptions/get-plan-modules.md): List all modules linked to a subscription plan. Superuser only.
- [Get Subscription](https://docs.cattix.com/api-reference/subscriptions/get-subscription.md)
- [Get Subscription Plan](https://docs.cattix.com/api-reference/subscriptions/get-subscription-plan.md)
- [Reactivate Subscription](https://docs.cattix.com/api-reference/subscriptions/reactivate-subscription.md): Reactivate a cancelled subscription. Superuser only.
- [Update Plan Module](https://docs.cattix.com/api-reference/subscriptions/update-plan-module.md): Update a plan module. Superuser only.
- [Update Subscription](https://docs.cattix.com/api-reference/subscriptions/update-subscription.md): Update a subscription. Superuser only.
- [Update Subscription Plan](https://docs.cattix.com/api-reference/subscriptions/update-subscription-plan.md)
- [Get Task Status](https://docs.cattix.com/api-reference/tasks/get-task-status.md): Get the status of a task by its ID.
- [Trigger Auto Apply Recommendations](https://docs.cattix.com/api-reference/tasks/trigger-auto-apply-recommendations.md): Manually trigger the auto-apply recommendations execution.
- [Trigger Daily Tasks](https://docs.cattix.com/api-reference/tasks/trigger-daily-tasks.md): Manually trigger the daily tasks execution.
- [Trigger Update All Customers Data](https://docs.cattix.com/api-reference/tasks/trigger-update-all-customers-data.md): Manually trigger updating all customers data.
- [Confirm Email Change](https://docs.cattix.com/api-reference/users/confirm-email-change.md): Confirm email change with the provided token.
- [Delete User](https://docs.cattix.com/api-reference/users/delete-user.md): Delete a user by ID.
- [Get All Users](https://docs.cattix.com/api-reference/users/get-all-users.md): Get all users.
- [Get Me](https://docs.cattix.com/api-reference/users/get-me.md): Get the current user.
- [Get User](https://docs.cattix.com/api-reference/users/get-user.md): Get a user by ID.
- [Login As](https://docs.cattix.com/api-reference/users/login-as.md): Log in as a user by ID.
- [Login For Access Token](https://docs.cattix.com/api-reference/users/login-for-access-token.md): Login for an access token using the data from the `OAuth2PasswordRequestForm`.
- [Register](https://docs.cattix.com/api-reference/users/register.md): Register a new user using the data from the `UserCreateSchema`.
- [Request Password Reset](https://docs.cattix.com/api-reference/users/request-password-reset.md): Request a password reset.
- [Reset Password](https://docs.cattix.com/api-reference/users/reset-password.md): Reset the password using the reset token.
- [Update User Email](https://docs.cattix.com/api-reference/users/update-user-email.md): Initiate an email change for a user.
- [Update User Password](https://docs.cattix.com/api-reference/users/update-user-password.md): Update a user's password.
- [Update User Profile](https://docs.cattix.com/api-reference/users/update-user-profile.md): Update a user's profile information.
- [Development](https://docs.cattix.com/development.md): Preview changes locally to update your docs
- [Code blocks](https://docs.cattix.com/essentials/code.md): Display inline code and code blocks
- [Images and embeds](https://docs.cattix.com/essentials/images.md): Add image, video, and other HTML elements
- [Markdown syntax](https://docs.cattix.com/essentials/markdown.md): Text, title, and styling in standard markdown
- [Navigation](https://docs.cattix.com/essentials/navigation.md): The navigation field in docs.json defines the pages that go in the navigation menu
- [Reusable snippets](https://docs.cattix.com/essentials/reusable-snippets.md): Reusable, custom snippets to keep content in sync
- [Global Settings](https://docs.cattix.com/essentials/settings.md): Mintlify gives you complete control over the look and feel of your documentation using the docs.json file
- [Ad Groups Pagination](https://docs.cattix.com/guides/ad-groups-pagination.md): Offset-based pagination for the GET /ad-groups endpoint
- [Пагінація груп оголошень](https://docs.cattix.com/guides/ad-groups-pagination-uk.md): Offset-пагінація для ендпоінта GET /ad-groups
- [Campaign Draft Steps](https://docs.cattix.com/guides/campaign-draft-steps.md): Use the 4 step-scoped PATCH endpoints to build and edit campaign drafts in the wizard
- [Connections Endpoint](https://docs.cattix.com/guides/connections-endpoint.md): A single endpoint to fetch all user connections (Google Ads accounts and Google Business Profile locations) grouped by company
- [Connections Endpoint](https://docs.cattix.com/guides/connections-endpoint-uk.md): Єдиний ендпоінт для отримання всіх підключень користувача (Google Ads акаунти та Google Business Profile локації), згрупованих по компаніях
- [Exclude Removed Entities](https://docs.cattix.com/guides/exclude-removed.md): Opt-out filter to hide REMOVED Google Ads entities from listing endpoints
- [Виключення видалених сутностей](https://docs.cattix.com/guides/exclude-removed-uk.md): Opt-out фільтр для приховування REMOVED сутностей Google Ads з ендпоінтів списків
- [Frontend Actions](https://docs.cattix.com/guides/frontend-actions.md): All FrontendAction values the backend sends via chat responses and how to handle them
- [Frontend Actions](https://docs.cattix.com/guides/frontend-actions-uk.md): Усі значення FrontendAction, які бекенд надсилає у відповідях чату, та як їх обробляти
- [Google Ads CRUD & Live Campaign Editing](https://docs.cattix.com/guides/google-ads-crud.md): New endpoints for managing Google Ads resources (ad groups, ads, keywords, targeting) and editing live campaigns
- [Google Ads CRUD та редагування кампаній](https://docs.cattix.com/guides/google-ads-crud-uk.md): Нові ендпоінти для управління ресурсами Google Ads (групи оголошень, оголошення, ключові слова, таргетинг) та редагування активних кампаній
- [RSA Auto-Regeneration](https://docs.cattix.com/guides/rsa-auto-regeneration.md): How Responsive Search Ads are automatically regenerated when ad groups or keywords change
- [Авто-регенерація RSA](https://docs.cattix.com/guides/rsa-auto-regeneration-uk.md): Як Responsive Search Ads автоматично перегенеровуються при зміні груп оголошень або ключових слів
- [Table Search](https://docs.cattix.com/guides/table-search.md): Server-side search filtering for all Google Ads data table endpoints
- [Пошук по таблицях](https://docs.cattix.com/guides/table-search-uk.md): Серверна фільтрація пошуком для всіх ендпоінтів таблиць Google Ads
- [Introduction](https://docs.cattix.com/index.md): Welcome to the new home for your documentation
- [Quickstart](https://docs.cattix.com/quickstart.md): Start building awesome documentation in minutes

## OpenAPI Specs

- [openapi](https://docs.cattix.com/api-reference/openapi.json)

## Optional

- [Documentation](https://docs.cattix.com)
- [Blog](https://blog.cattix.com)