Skip to main content
GET
/
api
/
v1
/
market-analysis
/
analyses
/
{analysis_id}
/
forecast
Get the latest forecast for a market analysis
curl --request GET \
  --url http://localhost:8000/api/v1/market-analysis/analyses/{analysis_id}/forecast \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "monthly_search_volume": 123,
  "average_top_of_page_bid__low_range": "<string>",
  "average_top_of_page_bid__high_range": "<string>",
  "estimated_cost_per_lead": "<string>",
  "date_added": "2023-11-07T05:31:56Z",
  "date_updated": "2023-11-07T05:31:56Z",
  "is_active": true
}

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

Response

MarketAnalysisForecastSchema · object | null

Successful Response

Schema for a market analysis forecast.

​
id
integer
required

Forecast ID

​
monthly_search_volume
integer
required

Total monthly search volume

​
average_top_of_page_bid__low_range
string
required

Average low-range bid estimate

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
average_top_of_page_bid__high_range
string
required

Average high-range bid estimate

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
estimated_cost_per_lead
string
required

Estimated cost per lead/conversion

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
date_added
string<date-time>
required

Creation timestamp

​
date_updated
string<date-time>
required

Last update timestamp

​
is_active
boolean
required

Whether the forecast is active (False if config/keywords changed)