Core API
- GETList campaign optimizations
- POSTCreate campaign optimization
- GETGet the latest suggestion for a campaign optimization
- POSTCreate optimization results for a campaign optimization
- GETRetrieve campaign optimization
- DELDelete campaign optimization
- POSTExtend suggestions for a campaign optimization
- POSTImplement suggestions for a campaign optimization
- POSTRefresh asset group info from Google Ads
- POSTRestart campaign optimization pipeline
Search API
curl --request POST \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/implement_suggestions \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{}'{
"updated_count": 123,
"total_asset_groups": 123,
"results": [
{
"asset_group_id": "<string>",
"status": "success",
"error": "<string>"
}
]
}Campaign Optimizations
Implement suggestions for a campaign optimization
Implements the latest optimization suggestions for a campaign optimization.
Required permission: write:analysis.
Platform-Specific Behavior:
Google Ads:
- The
detailsfield is optional and can contain anasset_groupsarray to filter which asset groups to process. - If
details.asset_groupsis provided, only suggestions for the specified asset groups will be implemented. - If
detailsis omitted orasset_groupsis not specified, all suggestions will be implemented. - Partial failures are handled gracefully: if one asset group fails, the others still proceed.
TikTok:
- The
detailsfield is not used and can be omitted. - All ad groups specified in
campaign_optimization.campaign.ad_group_idswill be updated.
Response Body (Google Ads):
{
"updated_count": 2,
"total_asset_groups": 3,
"results": [
{ "asset_group_id": "6476435676", "status": "success" },
{ "asset_group_id": "6481074503", "status": "success" },
{ "asset_group_id": "6477355033", "status": "failed", "error": "Failed to add search theme 'xyz'" }
]
}
Response fields:
updated_count(int): Number of asset groups where all suggestions were applied successfully.total_asset_groups(int): Total number of asset groups in the suggestion (not just those requested viadetails).results(array): Per-asset-group outcome.asset_group_id(string): The asset group ID.status(string):successorfailed.error(string, optional): Error message, only present whenstatusisfailed.
POST
/
v1
/
organizations
/
{organization_id}
/
workspaces
/
{workspace_id}
/
campaign_optimizations
/
{id}
/
implement_suggestions
curl --request POST \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/implement_suggestions \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{}'{
"updated_count": 123,
"total_asset_groups": 123,
"results": [
{
"asset_group_id": "<string>",
"status": "success",
"error": "<string>"
}
]
}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
Path Parameters
A UUID string identifying the campaign optimization.
A UUID string identifying this campaign optimization.
Query Parameters
Available options:
csv, json Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data*/*
Platform-specific details for implementing suggestions.
⌘I