Skip to main content
GET
/
api
/
v1
/
analysis
/
recommendations
Collect All Recommendations
curl --request GET \
  --url http://localhost:8000/api/v1/analysis/recommendations \
  --header 'Authorization: Bearer <token>'
{
  "recommended_negative_keywords": [
    {
      "status": "pending",
      "is_manually_generated": true,
      "keyword": "<string>",
      "match_type": "<string>",
      "reason": "<string>",
      "campaign": {
        "id": 123,
        "name": "<string>",
        "status": "<string>",
        "channel_type": "SEARCH"
      },
      "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
    }
  ],
  "recommended_keyword_pauses": [
    {
      "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>"
    }
  ],
  "recommended_headlines": [],
  "recommended_descriptions": [],
  "recommended_budget_migrations": [],
  "recommended_pause_hours": [],
  "recommended_pause_locations": [],
  "recommended_search_terms": []
}

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

The schema for an analysis result.