Skip to main content
This page is also available in Ukrainian.

Overview

All Google Ads data table endpoints now support an optional search query parameter. When provided, the API filters results server-side using case-insensitive substring matching across designated text fields for each table. This is designed for the search bar in each data table on the frontend.

How to use

Add ?search=<term> to any data table GET endpoint:
GET /api/v1/google-ads/{customer_id}/campaigns?search=brand
GET /api/v1/google-ads/{customer_id}/ad-groups?search=shoes
GET /api/v1/google-ads/{customer_id}/keywords?search=buy+shoes
The same parameter works on CSV export endpoints:
GET /api/v1/google-ads/{customer_id}/campaigns/csv?search=brand

Parameter rules

PropertyValue
Namesearch
Typestring (optional)
Min length1
Max length200
DefaultNone (no filtering)
Omitting search (or sending an empty value) returns the full dataset — fully backward compatible.

Search behavior

  • Case-insensitive: "brand" matches "Brand Campaign", "BRAND", etc.
  • Substring match: "shoe" matches "buy shoes online"
  • OR logic across fields: a row matches if any of its searchable fields contains the search term
  • Post-fetch filtering: search is applied after data is fetched from Google Ads, so it works on all fields including resolved names and RSA headlines

Searchable fields per table

EndpointSearchable fields
/campaignsname
/ad-groupsname, campaign_name
/adsheadline texts, description texts, final_url, campaign_name, ad_group_name
/keywordstext, campaign name, ad group name
/search-termssearch_term, matched_keyword, campaign_name, ad_group_name
/ad-schedulecampaign_name, day_of_week
/locationscampaign_name, location_name
/user-locationscampaign_name, most_specific_location, city, region
/geographic-performancelocation_name, campaign_name

Examples

Filter campaigns by name

curl "https://api.cattix.com/api/v1/google-ads/1234567890/campaigns?search=brand" \
  -H "Authorization: Bearer $TOKEN"

Search ads by headline text

GET /api/v1/google-ads/1234567890/ads?search=free+shipping
Returns only ads where any headline or description contains “free shipping”.

Search keywords across campaign and ad group

GET /api/v1/google-ads/1234567890/keywords?search=shoes
Returns keywords where the keyword text, campaign name, or ad group name contains “shoes”.