Skip to main content
GET
Get Keyword Pause Recommendations

Authorizations

Authorization
string
header
required

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

Query Parameters

customer_id
integer
required
return_only_pending
boolean
default:false
return_only_auto_applied
boolean
default:false
limit__last_days
integer | null
limit__max
integer | null

Response

Successful Response

status
enum<string>
required

The status of a recommendation.

Available options:
pending,
applied,
auto_applied,
rejected
is_manually_generated
boolean
required
keyword_id
integer
required
keyword_text
string
required
reason
string
required
campaign
The campaign · object
required

Schema for campaign information related to a keyword

is_rejected_by_gemini
boolean
required
is_rejected_by_user
boolean
required
date_regenerated
string<date-time> | null
date_added
string<date-time> | null
date_updated
string<date-time> | null
id
integer | null
budget_saving
number | null
metrics_snapshot
The metrics snapshot · object | null
gemini_rejected_reason
string | null
user_rejected_reason
string | null