Skip to main content
PATCH
Update a market analysis

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

analysis_id
integer
required

Query Parameters

include_keywords
boolean
default:false
include_unselected_keywords
boolean
default:false

Body

application/json

Schema for updating a market analysis.

title
string | null

Analysis title

summary
string | null

Summary/description of the market analysis

do_include_assistant_knowledge_item
boolean
default:false

Whether to include assistant knowledge items for this analysis

config
MarketAnalysisConfigUpdateSchema · object | null

Analysis configuration (partial updates supported)

Response

Successful Response

Schema for a market analysis.

title
string
required

Analysis title

google_ads_customer_id
integer
required

Google Ads customer ID

id
integer
required

Analysis ID

status
enum<string>
required

Analysis status (draft, completed, campaign_created)

Available options:
draft,
completed,
campaign_created
date_added
string<date-time>
required

Creation timestamp

date_updated
string<date-time>
required

Last update timestamp

summary
string | null

Summary/description of the market analysis

do_include_assistant_knowledge_item
boolean
default:false

Whether to include assistant knowledge items for this analysis

config
MarketAnalysisConfigSchema · object | null

Analysis configuration (can be empty on Market Analysis creation)

created_campaign_id
integer | null

ID of created campaign if any

keywords
MarketAnalysisKeywordSchema · object[]

Associated keywords