curl --request GET \
--url http://localhost:8000/api/v1/market-analysis/analyses/{analysis_id} \
--header 'Authorization: Bearer <token>'{
"title": "<string>",
"google_ads_customer_id": 123,
"id": 123,
"status": "draft",
"date_added": "2023-11-07T05:31:56Z",
"date_updated": "2023-11-07T05:31:56Z",
"summary": "<string>",
"do_include_assistant_knowledge_item": false,
"config": {
"services": [
"<string>"
],
"location_ids": [
123
],
"language_id": 1000,
"website_url": "<string>"
},
"created_campaign_id": 123,
"keywords": [
{
"id": 123,
"keyword_text": "<string>",
"is_selected": true,
"avg_monthly_searches": 123,
"competition": "<string>",
"competition_index": 123,
"low_bid": "<string>",
"high_bid": "<string>"
}
]
}Get a specific market analysis with all keywords.
curl --request GET \
--url http://localhost:8000/api/v1/market-analysis/analyses/{analysis_id} \
--header 'Authorization: Bearer <token>'{
"title": "<string>",
"google_ads_customer_id": 123,
"id": 123,
"status": "draft",
"date_added": "2023-11-07T05:31:56Z",
"date_updated": "2023-11-07T05:31:56Z",
"summary": "<string>",
"do_include_assistant_knowledge_item": false,
"config": {
"services": [
"<string>"
],
"location_ids": [
123
],
"language_id": 1000,
"website_url": "<string>"
},
"created_campaign_id": 123,
"keywords": [
{
"id": 123,
"keyword_text": "<string>",
"is_selected": true,
"avg_monthly_searches": 123,
"competition": "<string>",
"competition_index": 123,
"low_bid": "<string>",
"high_bid": "<string>"
}
]
}The access token received from the authorization server in the OAuth 2.0 flow.
Successful Response
Schema for a market analysis.
Analysis title
Google Ads customer ID
Analysis ID
Analysis status (draft, completed, campaign_created)
draft, completed, campaign_created Creation timestamp
Last update timestamp
Summary/description of the market analysis
Whether to include assistant knowledge items for this analysis
Analysis configuration (can be empty on Market Analysis creation)
Show child attributes
ID of created campaign if any
Associated keywords
Show child attributes