Create Config
curl --request POST \
--url http://localhost:8000/api/v1/analysis-customer-configs/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"google_ads_customer_id": 123,
"is_enabled": true,
"should_run_daily": true,
"run_max_once_in_n_hours": 123,
"constraint": 123,
"is_deleted": false,
"time_to_run__at_customer_timezone": "<string>",
"do_auto_apply_recommendations": true,
"should_send_analysis_ready_emails": true,
"z_index": 123
}
'import requests
url = "http://localhost:8000/api/v1/analysis-customer-configs/"
payload = {
"google_ads_customer_id": 123,
"is_enabled": True,
"should_run_daily": True,
"run_max_once_in_n_hours": 123,
"constraint": 123,
"is_deleted": False,
"time_to_run__at_customer_timezone": "<string>",
"do_auto_apply_recommendations": True,
"should_send_analysis_ready_emails": True,
"z_index": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
google_ads_customer_id: 123,
is_enabled: true,
should_run_daily: true,
run_max_once_in_n_hours: 123,
constraint: 123,
is_deleted: false,
time_to_run__at_customer_timezone: '<string>',
do_auto_apply_recommendations: true,
should_send_analysis_ready_emails: true,
z_index: 123
})
};
fetch('http://localhost:8000/api/v1/analysis-customer-configs/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/api/v1/analysis-customer-configs/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'google_ads_customer_id' => 123,
'is_enabled' => true,
'should_run_daily' => true,
'run_max_once_in_n_hours' => 123,
'constraint' => 123,
'is_deleted' => false,
'time_to_run__at_customer_timezone' => '<string>',
'do_auto_apply_recommendations' => true,
'should_send_analysis_ready_emails' => true,
'z_index' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8000/api/v1/analysis-customer-configs/"
payload := strings.NewReader("{\n \"google_ads_customer_id\": 123,\n \"is_enabled\": true,\n \"should_run_daily\": true,\n \"run_max_once_in_n_hours\": 123,\n \"constraint\": 123,\n \"is_deleted\": false,\n \"time_to_run__at_customer_timezone\": \"<string>\",\n \"do_auto_apply_recommendations\": true,\n \"should_send_analysis_ready_emails\": true,\n \"z_index\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8000/api/v1/analysis-customer-configs/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"google_ads_customer_id\": 123,\n \"is_enabled\": true,\n \"should_run_daily\": true,\n \"run_max_once_in_n_hours\": 123,\n \"constraint\": 123,\n \"is_deleted\": false,\n \"time_to_run__at_customer_timezone\": \"<string>\",\n \"do_auto_apply_recommendations\": true,\n \"should_send_analysis_ready_emails\": true,\n \"z_index\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/api/v1/analysis-customer-configs/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"google_ads_customer_id\": 123,\n \"is_enabled\": true,\n \"should_run_daily\": true,\n \"run_max_once_in_n_hours\": 123,\n \"constraint\": 123,\n \"is_deleted\": false,\n \"time_to_run__at_customer_timezone\": \"<string>\",\n \"do_auto_apply_recommendations\": true,\n \"should_send_analysis_ready_emails\": true,\n \"z_index\": 123\n}"
response = http.request(request)
puts response.read_body{
"google_ads_customer_id": 123,
"is_enabled": true,
"should_run_daily": true,
"run_max_once_in_n_hours": 123,
"constraint": 123,
"id": 123,
"date_added": "2023-11-07T05:31:56Z",
"date_updated": "2023-11-07T05:31:56Z",
"is_active": true,
"is_deleted": false,
"time_to_run__at_customer_timezone": "<string>",
"do_auto_apply_recommendations": true,
"should_send_analysis_ready_emails": true,
"z_index": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Analysis Customer Configs
Create Config
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 '
{
"google_ads_customer_id": 123,
"is_enabled": true,
"should_run_daily": true,
"run_max_once_in_n_hours": 123,
"constraint": 123,
"is_deleted": false,
"time_to_run__at_customer_timezone": "<string>",
"do_auto_apply_recommendations": true,
"should_send_analysis_ready_emails": true,
"z_index": 123
}
'import requests
url = "http://localhost:8000/api/v1/analysis-customer-configs/"
payload = {
"google_ads_customer_id": 123,
"is_enabled": True,
"should_run_daily": True,
"run_max_once_in_n_hours": 123,
"constraint": 123,
"is_deleted": False,
"time_to_run__at_customer_timezone": "<string>",
"do_auto_apply_recommendations": True,
"should_send_analysis_ready_emails": True,
"z_index": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
google_ads_customer_id: 123,
is_enabled: true,
should_run_daily: true,
run_max_once_in_n_hours: 123,
constraint: 123,
is_deleted: false,
time_to_run__at_customer_timezone: '<string>',
do_auto_apply_recommendations: true,
should_send_analysis_ready_emails: true,
z_index: 123
})
};
fetch('http://localhost:8000/api/v1/analysis-customer-configs/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/api/v1/analysis-customer-configs/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'google_ads_customer_id' => 123,
'is_enabled' => true,
'should_run_daily' => true,
'run_max_once_in_n_hours' => 123,
'constraint' => 123,
'is_deleted' => false,
'time_to_run__at_customer_timezone' => '<string>',
'do_auto_apply_recommendations' => true,
'should_send_analysis_ready_emails' => true,
'z_index' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8000/api/v1/analysis-customer-configs/"
payload := strings.NewReader("{\n \"google_ads_customer_id\": 123,\n \"is_enabled\": true,\n \"should_run_daily\": true,\n \"run_max_once_in_n_hours\": 123,\n \"constraint\": 123,\n \"is_deleted\": false,\n \"time_to_run__at_customer_timezone\": \"<string>\",\n \"do_auto_apply_recommendations\": true,\n \"should_send_analysis_ready_emails\": true,\n \"z_index\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8000/api/v1/analysis-customer-configs/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"google_ads_customer_id\": 123,\n \"is_enabled\": true,\n \"should_run_daily\": true,\n \"run_max_once_in_n_hours\": 123,\n \"constraint\": 123,\n \"is_deleted\": false,\n \"time_to_run__at_customer_timezone\": \"<string>\",\n \"do_auto_apply_recommendations\": true,\n \"should_send_analysis_ready_emails\": true,\n \"z_index\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/api/v1/analysis-customer-configs/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"google_ads_customer_id\": 123,\n \"is_enabled\": true,\n \"should_run_daily\": true,\n \"run_max_once_in_n_hours\": 123,\n \"constraint\": 123,\n \"is_deleted\": false,\n \"time_to_run__at_customer_timezone\": \"<string>\",\n \"do_auto_apply_recommendations\": true,\n \"should_send_analysis_ready_emails\": true,\n \"z_index\": 123\n}"
response = http.request(request)
puts response.read_body{
"google_ads_customer_id": 123,
"is_enabled": true,
"should_run_daily": true,
"run_max_once_in_n_hours": 123,
"constraint": 123,
"id": 123,
"date_added": "2023-11-07T05:31:56Z",
"date_updated": "2023-11-07T05:31:56Z",
"is_active": true,
"is_deleted": false,
"time_to_run__at_customer_timezone": "<string>",
"do_auto_apply_recommendations": true,
"should_send_analysis_ready_emails": true,
"z_index": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
Allow admin to override subscription constraints
Body
application/json
Schema for creating Analysis Customer Config (admin only).
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 Response
Successful Response
Schema for reading Analysis Customer Config (admin only).
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 ⌘I