Skip to main content
POST
/
api
/
v1
/
analysis-customer-configs
Create Config
curl --request POST \
  --url http://localhost:8000/api/v1/analysis-customer-configs/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "analysis_type": "keyword_pause",
  "google_ads_customer_id": 123,
  "is_enabled": true,
  "should_run_daily": true,
  "run_max_once_in_n_days": 123,
  "is_deleted": false,
  "n_of_manual_analyses_left_in_period": 123,
  "time_to_run__at_customer_timezone": "<string>",
  "do_auto_apply_recommendations": true,
  "should_send_analysis_ready_emails": true,
  "max_search_terms": 123,
  "z_index": 123
}
'
{
  "analysis_type": "keyword_pause",
  "google_ads_customer_id": 123,
  "is_enabled": true,
  "should_run_daily": true,
  "run_max_once_in_n_days": 123,
  "id": 123,
  "date_added": "2023-11-07T05:31:56Z",
  "date_updated": "2023-11-07T05:31:56Z",
  "is_active": true,
  "is_deleted": false,
  "n_of_manual_analyses_left_in_period": 123,
  "time_to_run__at_customer_timezone": "<string>",
  "do_auto_apply_recommendations": true,
  "should_send_analysis_ready_emails": true,
  "max_search_terms": 123,
  "z_index": 123
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
override_license_constraints
boolean
default:false

Allow admin to override license constraints

Body

application/json

Schema for creating Analysis Customer Config (admin only).

​
analysis_type
enum<string>
required

The types of analyses.

Available options:
keyword_pause,
negative_keyword,
double_check_keywords_to_pause,
headline,
description,
budget_migration,
pause_hours,
pause_locations,
search_terms
​
google_ads_customer_id
integer
required
​
is_enabled
boolean
required
​
should_run_daily
boolean
required
​
run_max_once_in_n_days
integer
required
​
is_deleted
boolean
default:false
​
n_of_manual_analyses_left_in_period
integer | null
​
time_to_run__at_customer_timezone
string<time> | null
​
do_auto_apply_recommendations
boolean
default:true
​
should_send_analysis_ready_emails
boolean
default:true
​
max_search_terms
integer | null
​
z_index
number | null

Response

Successful Response

Schema for reading Analysis Customer Config (admin only).

​
analysis_type
enum<string>
required

The types of analyses.

Available options:
keyword_pause,
negative_keyword,
double_check_keywords_to_pause,
headline,
description,
budget_migration,
pause_hours,
pause_locations,
search_terms
​
google_ads_customer_id
integer
required
​
is_enabled
boolean
required
​
should_run_daily
boolean
required
​
run_max_once_in_n_days
integer
required
​
id
integer
required
​
date_added
string<date-time>
required
​
date_updated
string<date-time>
required
​
is_active
boolean
required
​
is_deleted
boolean
default:false
​
n_of_manual_analyses_left_in_period
integer | null
​
time_to_run__at_customer_timezone
string<time> | null
​
do_auto_apply_recommendations
boolean
default:true
​
should_send_analysis_ready_emails
boolean
default:true
​
max_search_terms
integer | null
​
z_index
number | null