Skip to main content
GET
/
api
/
v1
/
analysis
/
recommendations
/
keyword-pauses
Get Keyword Pause Recommendations
curl --request GET \
  --url http://localhost:8000/api/v1/analysis/recommendations/keyword-pauses \
  --header 'Authorization: Bearer <token>'
[
  {
    "status": "pending",
    "is_manually_generated": true,
    "keyword_id": 123,
    "keyword_text": "<string>",
    "reason": "<string>",
    "campaign": {
      "id": 123,
      "name": "<string>",
      "status": "<string>",
      "channel_type": "SEARCH"
    },
    "is_rejected_by_gemini": true,
    "is_rejected_by_user": true,
    "date_regenerated": "2023-11-07T05:31:56Z",
    "date_added": "2023-11-07T05:31:56Z",
    "date_updated": "2023-11-07T05:31:56Z",
    "id": 123,
    "budget_saving": 123,
    "metrics_snapshot": {},
    "gemini_rejected_reason": "<string>",
    "user_rejected_reason": "<string>"
  }
]

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
​
gemini_rejected_reason
string | null
​
user_rejected_reason
string | null