Skip to main content
GET
/
api
/
v1
/
analysis
/
recommendations
/
headlines
Get Headline Recommendations
curl --request GET \
  --url http://localhost:8000/api/v1/analysis/recommendations/headlines \
  --header 'Authorization: Bearer <token>'
[
  {
    "is_manually_generated": true,
    "ad": {
      "id": 123,
      "google_ads_ad_group": {
        "id": 123,
        "google_ads_campaign": {
          "id": 123,
          "google_ads_customer_id": 123,
          "name": "<string>",
          "status": "<string>",
          "start_date": "2023-11-07T05:31:56Z",
          "channel_type": "<string>",
          "end_date": "2023-11-07T05:31:56Z"
        },
        "name": "<string>",
        "status": "<string>",
        "type": "<string>"
      },
      "type": "<string>",
      "final_url": "<string>"
    },
    "text": "<string>",
    "reason": "<string>",
    "date_regenerated": "2023-11-07T05:31:56Z",
    "date_added": "2023-11-07T05:31:56Z",
    "date_updated": "2023-11-07T05:31:56Z",
    "id": 123,
    "user_updated_text": "<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
​
ad
AdSchema · object
required

Schema for Ad data

​
text
string
required
​
reason
string
required
​
date_regenerated
string<date-time> | null
​
date_added
string<date-time> | null
​
date_updated
string<date-time> | null
​
id
integer | null
​
user_updated_text
string | null