Apply Migration
curl --request POST \
--url http://localhost:8000/api/v1/google-ads/migrations/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"donor_campaign": "<string>",
"recipient_campaign": "<string>",
"donor_cost_per_conv": 123,
"recipient_cost_per_conv": 123,
"cost_per_conv_difference_percent": 123,
"z_score": 123,
"recommended_migration_amount": 123,
"donor_metrics": {
"conversions": 123,
"current_budget": 123,
"impression_share": 123,
"abs_top_page_rate": 123,
"visibility_score": 123
},
"recipient_metrics": {
"conversions": 123,
"current_budget": 123,
"impression_share": 123,
"abs_top_page_rate": 123,
"visibility_score": 123
}
}
'import requests
url = "http://localhost:8000/api/v1/google-ads/migrations/apply"
payload = {
"donor_campaign": "<string>",
"recipient_campaign": "<string>",
"donor_cost_per_conv": 123,
"recipient_cost_per_conv": 123,
"cost_per_conv_difference_percent": 123,
"z_score": 123,
"recommended_migration_amount": 123,
"donor_metrics": {
"conversions": 123,
"current_budget": 123,
"impression_share": 123,
"abs_top_page_rate": 123,
"visibility_score": 123
},
"recipient_metrics": {
"conversions": 123,
"current_budget": 123,
"impression_share": 123,
"abs_top_page_rate": 123,
"visibility_score": 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({
donor_campaign: '<string>',
recipient_campaign: '<string>',
donor_cost_per_conv: 123,
recipient_cost_per_conv: 123,
cost_per_conv_difference_percent: 123,
z_score: 123,
recommended_migration_amount: 123,
donor_metrics: {
conversions: 123,
current_budget: 123,
impression_share: 123,
abs_top_page_rate: 123,
visibility_score: 123
},
recipient_metrics: {
conversions: 123,
current_budget: 123,
impression_share: 123,
abs_top_page_rate: 123,
visibility_score: 123
}
})
};
fetch('http://localhost:8000/api/v1/google-ads/migrations/apply', 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/google-ads/migrations/apply",
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([
'donor_campaign' => '<string>',
'recipient_campaign' => '<string>',
'donor_cost_per_conv' => 123,
'recipient_cost_per_conv' => 123,
'cost_per_conv_difference_percent' => 123,
'z_score' => 123,
'recommended_migration_amount' => 123,
'donor_metrics' => [
'conversions' => 123,
'current_budget' => 123,
'impression_share' => 123,
'abs_top_page_rate' => 123,
'visibility_score' => 123
],
'recipient_metrics' => [
'conversions' => 123,
'current_budget' => 123,
'impression_share' => 123,
'abs_top_page_rate' => 123,
'visibility_score' => 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/google-ads/migrations/apply"
payload := strings.NewReader("{\n \"donor_campaign\": \"<string>\",\n \"recipient_campaign\": \"<string>\",\n \"donor_cost_per_conv\": 123,\n \"recipient_cost_per_conv\": 123,\n \"cost_per_conv_difference_percent\": 123,\n \"z_score\": 123,\n \"recommended_migration_amount\": 123,\n \"donor_metrics\": {\n \"conversions\": 123,\n \"current_budget\": 123,\n \"impression_share\": 123,\n \"abs_top_page_rate\": 123,\n \"visibility_score\": 123\n },\n \"recipient_metrics\": {\n \"conversions\": 123,\n \"current_budget\": 123,\n \"impression_share\": 123,\n \"abs_top_page_rate\": 123,\n \"visibility_score\": 123\n }\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/google-ads/migrations/apply")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"donor_campaign\": \"<string>\",\n \"recipient_campaign\": \"<string>\",\n \"donor_cost_per_conv\": 123,\n \"recipient_cost_per_conv\": 123,\n \"cost_per_conv_difference_percent\": 123,\n \"z_score\": 123,\n \"recommended_migration_amount\": 123,\n \"donor_metrics\": {\n \"conversions\": 123,\n \"current_budget\": 123,\n \"impression_share\": 123,\n \"abs_top_page_rate\": 123,\n \"visibility_score\": 123\n },\n \"recipient_metrics\": {\n \"conversions\": 123,\n \"current_budget\": 123,\n \"impression_share\": 123,\n \"abs_top_page_rate\": 123,\n \"visibility_score\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/api/v1/google-ads/migrations/apply")
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 \"donor_campaign\": \"<string>\",\n \"recipient_campaign\": \"<string>\",\n \"donor_cost_per_conv\": 123,\n \"recipient_cost_per_conv\": 123,\n \"cost_per_conv_difference_percent\": 123,\n \"z_score\": 123,\n \"recommended_migration_amount\": 123,\n \"donor_metrics\": {\n \"conversions\": 123,\n \"current_budget\": 123,\n \"impression_share\": 123,\n \"abs_top_page_rate\": 123,\n \"visibility_score\": 123\n },\n \"recipient_metrics\": {\n \"conversions\": 123,\n \"current_budget\": 123,\n \"impression_share\": 123,\n \"abs_top_page_rate\": 123,\n \"visibility_score\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"donor_campaign": {
"name": "<string>",
"old_budget": 123,
"new_budget": 123
},
"recipient_campaign": {
"name": "<string>",
"old_budget": 123,
"new_budget": 123
},
"migration_amount": 123,
"message": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Google Ads
Apply Migration
Apply a recommended budget migration between campaigns.
Args: customer_id: The Google Ads customer ID migration: Migration details including donor and recipient campaigns oauth2_token: OAuth2 token for authentication current_user: Authenticated user
Returns: MigrationResultSchema: Results of the migration operation
POST
/
api
/
v1
/
google-ads
/
migrations
/
apply
Apply Migration
curl --request POST \
--url http://localhost:8000/api/v1/google-ads/migrations/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"donor_campaign": "<string>",
"recipient_campaign": "<string>",
"donor_cost_per_conv": 123,
"recipient_cost_per_conv": 123,
"cost_per_conv_difference_percent": 123,
"z_score": 123,
"recommended_migration_amount": 123,
"donor_metrics": {
"conversions": 123,
"current_budget": 123,
"impression_share": 123,
"abs_top_page_rate": 123,
"visibility_score": 123
},
"recipient_metrics": {
"conversions": 123,
"current_budget": 123,
"impression_share": 123,
"abs_top_page_rate": 123,
"visibility_score": 123
}
}
'import requests
url = "http://localhost:8000/api/v1/google-ads/migrations/apply"
payload = {
"donor_campaign": "<string>",
"recipient_campaign": "<string>",
"donor_cost_per_conv": 123,
"recipient_cost_per_conv": 123,
"cost_per_conv_difference_percent": 123,
"z_score": 123,
"recommended_migration_amount": 123,
"donor_metrics": {
"conversions": 123,
"current_budget": 123,
"impression_share": 123,
"abs_top_page_rate": 123,
"visibility_score": 123
},
"recipient_metrics": {
"conversions": 123,
"current_budget": 123,
"impression_share": 123,
"abs_top_page_rate": 123,
"visibility_score": 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({
donor_campaign: '<string>',
recipient_campaign: '<string>',
donor_cost_per_conv: 123,
recipient_cost_per_conv: 123,
cost_per_conv_difference_percent: 123,
z_score: 123,
recommended_migration_amount: 123,
donor_metrics: {
conversions: 123,
current_budget: 123,
impression_share: 123,
abs_top_page_rate: 123,
visibility_score: 123
},
recipient_metrics: {
conversions: 123,
current_budget: 123,
impression_share: 123,
abs_top_page_rate: 123,
visibility_score: 123
}
})
};
fetch('http://localhost:8000/api/v1/google-ads/migrations/apply', 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/google-ads/migrations/apply",
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([
'donor_campaign' => '<string>',
'recipient_campaign' => '<string>',
'donor_cost_per_conv' => 123,
'recipient_cost_per_conv' => 123,
'cost_per_conv_difference_percent' => 123,
'z_score' => 123,
'recommended_migration_amount' => 123,
'donor_metrics' => [
'conversions' => 123,
'current_budget' => 123,
'impression_share' => 123,
'abs_top_page_rate' => 123,
'visibility_score' => 123
],
'recipient_metrics' => [
'conversions' => 123,
'current_budget' => 123,
'impression_share' => 123,
'abs_top_page_rate' => 123,
'visibility_score' => 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/google-ads/migrations/apply"
payload := strings.NewReader("{\n \"donor_campaign\": \"<string>\",\n \"recipient_campaign\": \"<string>\",\n \"donor_cost_per_conv\": 123,\n \"recipient_cost_per_conv\": 123,\n \"cost_per_conv_difference_percent\": 123,\n \"z_score\": 123,\n \"recommended_migration_amount\": 123,\n \"donor_metrics\": {\n \"conversions\": 123,\n \"current_budget\": 123,\n \"impression_share\": 123,\n \"abs_top_page_rate\": 123,\n \"visibility_score\": 123\n },\n \"recipient_metrics\": {\n \"conversions\": 123,\n \"current_budget\": 123,\n \"impression_share\": 123,\n \"abs_top_page_rate\": 123,\n \"visibility_score\": 123\n }\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/google-ads/migrations/apply")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"donor_campaign\": \"<string>\",\n \"recipient_campaign\": \"<string>\",\n \"donor_cost_per_conv\": 123,\n \"recipient_cost_per_conv\": 123,\n \"cost_per_conv_difference_percent\": 123,\n \"z_score\": 123,\n \"recommended_migration_amount\": 123,\n \"donor_metrics\": {\n \"conversions\": 123,\n \"current_budget\": 123,\n \"impression_share\": 123,\n \"abs_top_page_rate\": 123,\n \"visibility_score\": 123\n },\n \"recipient_metrics\": {\n \"conversions\": 123,\n \"current_budget\": 123,\n \"impression_share\": 123,\n \"abs_top_page_rate\": 123,\n \"visibility_score\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/api/v1/google-ads/migrations/apply")
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 \"donor_campaign\": \"<string>\",\n \"recipient_campaign\": \"<string>\",\n \"donor_cost_per_conv\": 123,\n \"recipient_cost_per_conv\": 123,\n \"cost_per_conv_difference_percent\": 123,\n \"z_score\": 123,\n \"recommended_migration_amount\": 123,\n \"donor_metrics\": {\n \"conversions\": 123,\n \"current_budget\": 123,\n \"impression_share\": 123,\n \"abs_top_page_rate\": 123,\n \"visibility_score\": 123\n },\n \"recipient_metrics\": {\n \"conversions\": 123,\n \"current_budget\": 123,\n \"impression_share\": 123,\n \"abs_top_page_rate\": 123,\n \"visibility_score\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"donor_campaign": {
"name": "<string>",
"old_budget": 123,
"new_budget": 123
},
"recipient_campaign": {
"name": "<string>",
"old_budget": 123,
"new_budget": 123
},
"migration_amount": 123,
"message": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
The schema for a migration.
The schema for migration metrics.
Show child attributes
Show child attributes
The schema for migration metrics.
Show child attributes
Show child attributes
⌘I