Skip to main content
GET
/
api
/
v1
/
google-ads
/
keywords
Get Ads Keywords
curl --request GET \
  --url http://localhost:8000/api/v1/google-ads/keywords \
  --header 'Authorization: Bearer <token>'
[
  {
    "text": "<string>",
    "match_type": "EXACT",
    "keyword_id": "<string>",
    "added_to": "<string>",
    "level": "<string>",
    "status": "<string>",
    "negative": false,
    "quality_score": 123,
    "ad_group": {
      "id": 123,
      "name": "<string>",
      "status": "<string>"
    },
    "campaign": {
      "id": 123,
      "name": "<string>",
      "status": "<string>",
      "channel_type": "SEARCH"
    },
    "metrics": {}
  }
]

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
customer_id
string
required
​
login_customer_id
integer | null
​
start_date
string
​
end_date
string
​
limit
integer
default:5000
​
negative
boolean
default:false
​
include_campaign_negatives
boolean
default:false
​
token_id
integer | null

Response

Successful Response

​
text
string
required

The keyword text

​
match_type
enum<string>
required

The match type of the keyword

Available options:
EXACT,
PHRASE,
BROAD,
BROAD_MODIFIER,
NEGATIVE
​
keyword_id
string
required
​
added_to
string
required

The name of the ad group or campaign the keyword is added to

​
level
string
required

The level at which the keyword is applied (Ad Group or Campaign)

​
status
string | null
​
negative
boolean | null
default:false
​
quality_score
integer | null
​
ad_group
KeywordAdGroupSchema · object

Schema for ad group information related to a keyword

​
campaign
KeywordCampaignSchema · object

Schema for campaign information related to a keyword

​
metrics
Metrics · object