Retrieve campaign optimization

Retrieve a specific campaign optimization by its ID.

Campaign Field Structure (campaign JSON)

The campaign field is a free-form JSON object whose structure depends on the platform.

Google Ads (PMax):

{
  "customer_id": "1447066043/8965287694",
  "asset_group_ids": ["6476435676", "6481074503"],
  "intent": "product",
  "asset_group_info": {
    "6476435676": {
      "name": "Animalerie",
      "ad_strength": "POOR",
      "ad_strength_score": 10,
      "ad_strength_max": 25,
      "search_themes_count": 0,
      "campaign_name": "PMax: IKOM - Smart Shopping CSS",
      "status": "ENABLED"
    }
  }
}

Fields:

• customer_id (string): Google Ads customer ID, format "manager_id/account_id" or "account_id".
• asset_group_ids (string[]): Asset group IDs selected for optimization.
• intent (string, optional): Optimization intent (product, service, brand). Set from promotion_type.
• asset_group_info (object): Mapping of asset group ID to metadata. Enriched with live Google Ads data at creation:
  • name (string): Asset group name.
  • ad_strength (string): Google Ads enum — EXCELLENT, GOOD, AVERAGE, POOR, PENDING, UNKNOWN, UNSPECIFIED, NO_ADS.
  • ad_strength_score (int): Numeric score — EXCELLENT=25, GOOD=20, AVERAGE=15, POOR=10, all others=0.
  • ad_strength_max (int): Always 25 (max possible score).
  • search_themes_count (int): Number of search theme signals currently on the asset group in Google Ads.
  • campaign_name (string): Parent PMax campaign name.
  • status (string): Asset group status — ENABLED, PAUSED, REMOVED, etc.

Use POST .../refresh to re-fetch asset_group_info from Google Ads without re-running the optimization pipeline.

TikTok:

{
  "advertiser_id": "7052316759499587586",
  "campaign_id": "1850667377518002",
  "ad_group_ids": ["1850939823278113", "1850667437045906"],
  "ad_group_names": {
    "1850939823278113": "Ad Group Name 1",
    "1850667437045906": "Ad Group Name 2"
  }
}

Fields:

• advertiser_id (string): TikTok advertiser account ID.
• campaign_id (string): TikTok campaign ID.
• ad_group_ids (string[]): Ad group IDs to optimize (non-empty).
• ad_group_names (object, optional): Mapping of ad group ID to ad group name. Supply this at creation time so the activation page can display names without making additional TikTok API calls.

TikTok campaign objects do not include asset_group_info or enrichment fields.

GET /v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}

Retrieve campaign optimization

cURL

curl --request GET \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id} \
  --header 'Authorization: <api-key>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "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"
}

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

Response

200

application/json

Details of the requested campaign optimization.

id · string<uuid> · required · read-only

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,