Skip to main content
GET
/
v1
/
organizations
/
{organization_id}
/
workspaces
/
{workspace_id}
/
campaign_optimizations
/
{campaign_optimization_id}
/
suggestions
Get the latest suggestion for a campaign optimization
curl --request GET \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{campaign_optimization_id}/suggestions \
  --header 'Authorization: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "suggestion": "<unknown>",
    "created_at": "2023-11-07T05:31:56Z",
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "platform_integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "platform": "google_ads",
    "campaign": "<unknown>",
    "name": "<string>",
    "analysis": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "language": "ar"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.shareofmodel.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Headers

​
Accept
string

Content type for the response. Possible values: 'application/json' (default, returns JSON with suggestion data), 'text/csv' (returns CSV file, Google Ads only), 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' (returns XLSX file, TikTok only).

Path Parameters

​
campaign_optimization_id
string
required
​
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,
xlsx
​
translate_to_en
boolean
default:false

If true and campaign language is not English, translates keywords to English and adds keyword_en field. Only applies to JSON responses.

Response

Details of the latest suggestion. Content type depends on Accept header: JSON (application/json), CSV (text/csv, Google Ads only), or XLSX (application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, TikTok only).

​
id
string<uuid>
required
read-only
​
suggestion
any
required
​
created_at
string<date-time>
required
read-only
​
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
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,