Campaign Optimizations

Extend suggestions for a campaign optimization

Triggers a new pipeline run that generates additional keywords and merges them with the existing suggestions for a campaign optimization. Only supported for TikTok optimizations. Required permission: write:analysis.

Optional request body:

{"params": {"themes": ["fitness tracking apps", "healthy lifestyle"]}}

If the body is absent or params is null/empty, new keywords are generated across all themes (default behaviour).
params.themes (optional string array): restricts keyword generation to those search theme strings. The values must match the theme field on existing keyword suggestions.
Keywords already present in the current suggestions are always excluded from new results to prevent duplicates.
Keywords under themes that were not requested are preserved untouched in the merged result.

POST

organizations

{organization_id}

workspaces

{workspace_id}

campaign_optimizations

{id}

extend_suggestions

curl --request POST \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/extend_suggestions \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{}'

Authorizations

Authorization

string

header

required

Path Parameters

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

params

object | null

Optional platform-specific parameters. Example: {"themes": ["fitness tracking apps", "healthy lifestyle"]}

Show child attributes

Response

Extend suggestions pipeline triggered successfully.

curl --request POST \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/extend_suggestions \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{}'

Overview

Core API

Search API

Extend suggestions for a campaign optimization

Authorizations

Path Parameters

Query Parameters

Body

Response