Restart campaign optimization pipeline - Share Of Model

Restart campaign optimization pipeline

curl --request POST \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/restart \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "platform_integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaign": "<unknown>",
  "name": "<string>",
  "analysis": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/restart"

payload = {
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "platform_integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "campaign": "<unknown>",
    "name": "<string>",
    "analysis": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workspace_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    platform_integration_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    campaign: '<unknown>',
    name: '<string>',
    analysis: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/restart', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/restart",
  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([
    'workspace_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'platform_integration_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'campaign' => '<unknown>',
    'name' => '<string>',
    'analysis' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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 := "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/restart"

	payload := strings.NewReader("{\n  \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"platform_integration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"campaign\": \"<unknown>\",\n  \"name\": \"<string>\",\n  \"analysis\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	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("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/restart")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"platform_integration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"campaign\": \"<unknown>\",\n  \"name\": \"<string>\",\n  \"analysis\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/restart")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"platform_integration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"campaign\": \"<unknown>\",\n  \"name\": \"<string>\",\n  \"analysis\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

POST

/

v1

/

organizations

/

{organization_id}

/

workspaces

/

{workspace_id}

/

campaign_optimizations

/

{id}

/

restart

Restart campaign optimization pipeline

curl --request POST \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/restart \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "platform_integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaign": "<unknown>",
  "name": "<string>",
  "analysis": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/restart"

payload = {
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "platform_integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "campaign": "<unknown>",
    "name": "<string>",
    "analysis": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workspace_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    platform_integration_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    campaign: '<unknown>',
    name: '<string>',
    analysis: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/restart', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/restart",
  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([
    'workspace_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'platform_integration_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'campaign' => '<unknown>',
    'name' => '<string>',
    'analysis' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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 := "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/restart"

	payload := strings.NewReader("{\n  \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"platform_integration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"campaign\": \"<unknown>\",\n  \"name\": \"<string>\",\n  \"analysis\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	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("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/restart")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"platform_integration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"campaign\": \"<unknown>\",\n  \"name\": \"<string>\",\n  \"analysis\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/restart")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"platform_integration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"campaign\": \"<unknown>\",\n  \"name\": \"<string>\",\n  \"analysis\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

Authorizations

Authorization

string

header

required

Path Parameters

id

string<uuid>

required

A UUID string identifying the campaign optimization.

organization_id

string

required

workspace_id

string<uuid>

required

Query Parameters

format

enum<string>

Available options:

csv,

json

Body

workspace_id

string<uuid>

required

platform_integration_id

string<uuid>

required

platform

enum<string>

required

google_ads - google ads
tiktok - tiktok

Available options:

google_ads,

tiktok

campaign

any

required

name

string

required

Maximum string length: 255

analysis

string<uuid>

required

status

enum<string>

pending - pending
in_progress - in progress
completed - completed
failed - failed
suggestions_applied - suggestions applied

Available options:

pending,

in_progress,

completed,

failed,

suggestions_applied

language

enum<string>

ar - ar
da - da
de - de
en - en
es - es
eu - eu
fi - fi
fil - fil
fr - fr
he - he
hi - hi
hu - hu
id - id
it - it
ja - ja
ko - ko
nl - nl
pl - pl
pt - pt
ro - ro
sv - sv
th - th
tr - tr
ur - ur
vi - vi
zh - zh
zh-TW - zh TW
zh-HK - zh HK

Available options:

ar,

da,

de,

en,

es,

eu,

fi,

fil,

fr,

he,

hi,

hu,

id,

it,

ja,

ko,

nl,

pl,

pt,

ro,

sv,

th,

tr,

ur,

vi,

zh,

zh-TW,

zh-HK,

Response

Pipeline restart triggered successfully.