{"openapi":"3.1.0","info":{"title":"SerpWatch API","version":"0.1.0"},"paths":{"/token":{"post":{"summary":"Login","operationId":"login_token_post","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Body_login_token_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/users":{"post":{"tags":["Auth"],"summary":"Create Api Key","operationId":"create_api_key_api_v1_users_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApiKey"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/api/v1/users/me":{"get":{"tags":["Auth"],"summary":"Users Me","operationId":"users_me_api_v1_users_me_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/api/v1/serp/{system_name}/crawl":{"post":{"tags":["SERP"],"summary":"Crawl","operationId":"crawl_api_v1_serp__system_name__crawl_post","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"system_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/EngineName"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrawlRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerpTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/serp/{system_name}/crawl/live":{"post":{"tags":["SERP"],"summary":"Live Crawl","operationId":"live_crawl_api_v1_serp__system_name__crawl_live_post","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"system_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/EngineName"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrawlRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerpTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/serp/crawl/{system_name}/batch":{"post":{"tags":["SERP"],"summary":"Batch Crawl","operationId":"batch_crawl_api_v1_serp_crawl__system_name__batch_post","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"system_name","in":"path","required":true,"schema":{"$ref":"#/components/schemas/EngineName"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CrawlRequest"},"title":"Requests"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SerpTask"},"title":"Response Batch Crawl Api V1 Serp Crawl  System Name  Batch Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/serp/crawl/{task_id}":{"get":{"tags":["SERP"],"summary":"Get Crawl","operationId":"get_crawl_api_v1_serp_crawl__task_id__get","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"integer","title":"Task Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerpTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/serp/crawl/{task_id}/html":{"get":{"tags":["SERP"],"summary":"Get Crawl Html","operationId":"get_crawl_html_api_v1_serp_crawl__task_id__html_get","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"integer","title":"Task Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrawlHTML"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/serp/crawl":{"get":{"tags":["SERP"],"summary":"List Crawl","operationId":"list_crawl_api_v1_serp_crawl_get","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/TaskStatus","default":"success"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","default":"","title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSerpTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/keyword-sv":{"post":{"tags":["Keyword data"],"summary":"Keyword Data","operationId":"keyword_data_api_v1_keyword_sv_post","security":[{"OAuth2PasswordBearer":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/KeywordDataTaskRequest"},"title":"Requests"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/KeywordDataTask"},"title":"Response Keyword Data Api V1 Keyword Sv Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Keyword data"],"summary":"List Keyword Data","operationId":"list_keyword_data_api_v1_keyword_sv_get","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/KeywordStatus","default":"success"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","default":"","title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListKeywordDataTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/keyword-sv/{task_id}":{"get":{"tags":["Keyword data"],"summary":"Keyword Data Detail","operationId":"keyword_data_detail_api_v1_keyword_sv__task_id__get","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"integer","title":"Task Id"}},{"name":"created_on","in":"query","required":false,"schema":{"type":"string","default":"","title":"Created On"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordDataTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/keyword-sv/live":{"post":{"tags":["Keyword data"],"summary":"Keyword Data Live","operationId":"keyword_data_live_api_v1_keyword_sv_live_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordDataLiveRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordDataSVResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/api/v1/common/engines/{system}":{"get":{"tags":["Common"],"summary":"List Engines","operationId":"list_engines_api_v1_common_engines__system__get","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"system","in":"path","required":true,"schema":{"type":"string","title":"System"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSearchEngine"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/keyword-research/ideas":{"post":{"tags":["Keyword research"],"summary":"Keyword Research Ideas","operationId":"keyword_research_ideas_api_v1_keyword_research_ideas_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordSuggestionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordSuggestionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/api/v1/keyword-research/suggest/live":{"post":{"tags":["Keyword research"],"summary":"Keyword Suggest Live","operationId":"keyword_suggest_live_api_v1_keyword_research_suggest_live_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/api/v1/keyword-research/trends/live":{"post":{"tags":["Keyword research"],"summary":"Google Trends Live","operationId":"google_trends_live_api_v1_keyword_research_trends_live_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleTrendRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleTrendResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/api/v2/serp/crawl":{"post":{"tags":["Google SERP"],"summary":"Create Google Serp Crawl","operationId":"create_google_serp_crawl_api_v2_serp_crawl_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleCrawlRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleSerpTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/api/v2/serp/crawl/google/batch":{"post":{"tags":["Google SERP"],"summary":"Create Google Serp Crawl Batch","operationId":"create_google_serp_crawl_batch_api_v2_serp_crawl_google_batch_post","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/GoogleCrawlRequest"},"type":"array","title":"Crawls"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/GoogleSerpTask"},"type":"array","title":"Response Create Google Serp Crawl Batch Api V2 Serp Crawl Google Batch Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/api/v2/serp/crawl/{task_id}":{"get":{"tags":["Google SERP"],"summary":"Get Google Serp Task Detail","operationId":"get_google_serp_task_detail_api_v2_serp_crawl__task_id__get","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"integer","title":"Task Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleSerpTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/":{"get":{"summary":"Index","operationId":"index__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"AggregateMetricResults":{"properties":{"device":{"type":"string","title":"Device"},"search_count":{"type":"integer","title":"Search Count"}},"type":"object","required":["device","search_count"],"title":"AggregateMetricResults"},"Body_login_token_post":{"properties":{"grant_type":{"type":"string","pattern":"password","title":"Grant Type"},"username":{"type":"string","title":"Username"},"password":{"type":"string","title":"Password"},"scope":{"type":"string","title":"Scope","default":""},"client_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"},"client_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Secret"}},"type":"object","required":["grant_type","username","password"],"title":"Body_login_token_post"},"Competitor":{"properties":{"keyword_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Keyword Id"},"competitor":{"type":"string","title":"Competitor"},"type":{"type":"string","title":"Type"}},"type":"object","required":["keyword_id","competitor","type"],"title":"Competitor"},"CrawlHTML":{"properties":{"html":{"type":"string","title":"Html"}},"type":"object","required":["html"],"title":"CrawlHTML"},"CrawlRequest":{"properties":{"keyword":{"type":"string","title":"Keyword"},"domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Domain"},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Name"},"competitors":{"anyOf":[{"items":{"$ref":"#/components/schemas/Competitor"},"type":"array"},{"type":"null"}],"title":"Competitors"},"frequency":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Frequency","default":24},"location_name":{"type":"string","title":"Location Name"},"iso_code":{"type":"string","title":"Iso Code"},"device":{"$ref":"#/components/schemas/Device","default":"desktop"},"se_id":{"type":"integer","title":"Se Id","default":0},"engine_domain":{"type":"string","title":"Engine Domain","default":""},"language_code":{"type":"string","title":"Language Code","default":""},"postback_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postback Url"},"post_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Post Id","default":""},"keyword_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Keyword Id"},"priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Priority","default":1}},"type":"object","required":["keyword","location_name","iso_code"],"title":"CrawlRequest"},"CreateApiKey":{"properties":{"name":{"type":"string","title":"Name","default":""},"email":{"type":"string","title":"Email","default":""}},"type":"object","title":"CreateApiKey"},"Device":{"type":"string","enum":["mobile","desktop"],"title":"Device"},"EngineName":{"type":"string","enum":["google","bing","yahoo","youtube"],"title":"EngineName"},"GoogleCrawlRequest":{"properties":{"keyword":{"type":"string","title":"Keyword"},"domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Domain"},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Name"},"competitors":{"anyOf":[{"items":{"$ref":"#/components/schemas/Competitor"},"type":"array"},{"type":"null"}],"title":"Competitors"},"frequency":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Frequency","default":24},"location_name":{"type":"string","title":"Location Name"},"iso_code":{"type":"string","title":"Iso Code"},"device":{"$ref":"#/components/schemas/Device","default":"desktop"},"se_id":{"type":"integer","title":"Se Id","default":0},"engine_domain":{"type":"string","title":"Engine Domain","default":""},"language_code":{"type":"string","title":"Language Code","default":""},"postback_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postback Url"},"post_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Post Id","default":""},"keyword_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Keyword Id"},"priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Priority","default":1},"depth":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Depth","default":10}},"type":"object","required":["keyword","location_name","iso_code"],"title":"GoogleCrawlRequest"},"GoogleSerpTask":{"properties":{"id":{"type":"integer","title":"Id"},"user_id":{"type":"integer","title":"User Id"},"sharding":{"type":"integer","title":"Sharding","default":0},"status":{"$ref":"#/components/schemas/TaskStatus","default":"awaiting"},"keyword":{"type":"string","title":"Keyword"},"domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Domain"},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Name"},"competitors":{"anyOf":[{"items":{"$ref":"#/components/schemas/Competitor"},"type":"array"},{"type":"null"}],"title":"Competitors"},"engine_domain":{"type":"string","title":"Engine Domain","default":"google.com"},"location_name":{"type":"string","title":"Location Name"},"iso_code":{"type":"string","title":"Iso Code"},"device":{"$ref":"#/components/schemas/Device","default":"desktop"},"language_code":{"type":"string","title":"Language Code"},"postback_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postback Url"},"post_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Post Id"},"keyword_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Keyword Id"},"priority":{"type":"integer","title":"Priority","default":1},"frequency":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Frequency","default":24},"se_id":{"type":"integer","title":"Se Id","default":0},"depth":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Depth","default":10},"pages":{"items":{"$ref":"#/components/schemas/GoogleSerpTaskPage"},"type":"array","title":"Pages"},"result":{"anyOf":[{},{"type":"null"}],"title":"Result"},"top_10":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Top 10"},"postback_retries_count":{"type":"integer","title":"Postback Retries Count","default":0},"retries_count":{"type":"integer","title":"Retries Count","default":0},"created_on":{"type":"string","title":"Created On"},"created_at":{"type":"integer","title":"Created At"},"ttl":{"type":"integer","title":"Ttl"}},"type":"object","required":["id","user_id","keyword","location_name","iso_code","language_code","created_on","created_at","ttl"],"title":"GoogleSerpTask"},"GoogleSerpTaskPage":{"properties":{"page":{"type":"integer","title":"Page"},"url":{"type":"string","title":"Url"},"status":{"$ref":"#/components/schemas/PageStatus","default":"awaiting"},"retry_count":{"type":"integer","title":"Retry Count","default":0},"html":{"type":"string","title":"Html","default":""},"results":{"anyOf":[{},{"type":"null"}],"title":"Results"}},"type":"object","required":["page","url"],"title":"GoogleSerpTaskPage"},"GoogleTrendRequest":{"properties":{"keyword":{"type":"string","title":"Keyword"},"location_name":{"type":"string","title":"Location Name"},"iso_code":{"type":"string","title":"Iso Code"},"language_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language Code","default":"en"},"engine_name":{"$ref":"#/components/schemas/EngineName","default":"google"}},"type":"object","required":["keyword","location_name","iso_code"],"title":"GoogleTrendRequest"},"GoogleTrendResponse":{"properties":{"interest_over_time":{"items":{"$ref":"#/components/schemas/TrendInterestOverTimeItem"},"type":"array","title":"Interest Over Time"},"related_queries":{"additionalProperties":{"items":{"$ref":"#/components/schemas/RelatedQueryItem"},"type":"array"},"type":"object","title":"Related Queries"}},"type":"object","required":["interest_over_time","related_queries"],"title":"GoogleTrendResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"KeywordAnnotation":{"properties":{"name":{"type":"string","title":"Name"},"concept_grop":{"$ref":"#/components/schemas/KeywordAnnotationConceptGroup"}},"type":"object","required":["name","concept_grop"],"title":"KeywordAnnotation"},"KeywordAnnotationConceptGroup":{"properties":{"name":{"type":"string","title":"Name"},"type":{"type":"string","title":"Type"}},"type":"object","required":["name","type"],"title":"KeywordAnnotationConceptGroup"},"KeywordAnnotations":{"properties":{"concepts":{"items":{"$ref":"#/components/schemas/KeywordAnnotation"},"type":"array","title":"Concepts"}},"type":"object","required":["concepts"],"title":"KeywordAnnotations"},"KeywordDataLiveRequest":{"properties":{"keywords":{"items":{"type":"string"},"type":"array","title":"Keywords"},"location_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Location Code"},"language_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language Code"}},"type":"object","required":["keywords"],"title":"KeywordDataLiveRequest"},"KeywordDataSV":{"properties":{"key":{"type":"string","title":"Key"},"cmp":{"type":"number","title":"Cmp"},"cpc":{"type":"number","title":"Cpc"},"ms":{"items":{"$ref":"#/components/schemas/KeywordSVMonthly"},"type":"array","title":"Ms"},"sv":{"type":"integer","title":"Sv"}},"type":"object","required":["key","cmp","cpc","ms","sv"],"title":"KeywordDataSV"},"KeywordDataSVResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/KeywordDataSV"},"type":"array","title":"Results"}},"type":"object","required":["results"],"title":"KeywordDataSVResponse"},"KeywordDataTask":{"properties":{"id":{"type":"integer","title":"Id"},"user_id":{"type":"integer","title":"User Id"},"sharding":{"type":"integer","title":"Sharding","default":0},"postback_retries_count":{"type":"integer","title":"Postback Retries Count","default":0},"status":{"$ref":"#/components/schemas/KeywordStatus","default":"awaiting"},"key":{"type":"string","title":"Key","default":""},"loc_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Loc Id"},"postback_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postback Url"},"result":{"items":{"type":"object"},"type":"array","title":"Result","default":[]},"created_at":{"type":"integer","title":"Created At"},"succeed_at":{"type":"integer","title":"Succeed At","default":0},"ttl":{"type":"integer","title":"Ttl"}},"type":"object","required":["id","user_id","created_at","ttl"],"title":"KeywordDataTask"},"KeywordDataTaskRequest":{"properties":{"key":{"type":"string","minLength":1,"title":"Key"},"loc_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Loc Id"},"postback_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postback Url"}},"type":"object","required":["key"],"title":"KeywordDataTaskRequest"},"KeywordIdeaMetric":{"properties":{"competition":{"type":"string","title":"Competition"},"monthly_search_volumes":{"items":{"$ref":"#/components/schemas/KeywordMonthlySearch"},"type":"array","title":"Monthly Search Volumes"},"avg_monthly_searches":{"type":"integer","title":"Avg Monthly Searches"},"competition_index":{"type":"integer","title":"Competition Index"},"low_top_of_page_bid_micros":{"type":"integer","title":"Low Top Of Page Bid Micros"},"high_top_of_page_bid_micros":{"type":"integer","title":"High Top Of Page Bid Micros"}},"type":"object","required":["competition","monthly_search_volumes","avg_monthly_searches","competition_index","low_top_of_page_bid_micros","high_top_of_page_bid_micros"],"title":"KeywordIdeaMetric"},"KeywordMonthlySearch":{"properties":{"month":{"type":"string","title":"Month"},"year":{"type":"integer","title":"Year"},"monthly_searches":{"type":"integer","title":"Monthly Searches"}},"type":"object","required":["month","year","monthly_searches"],"title":"KeywordMonthlySearch"},"KeywordSVMonthly":{"properties":{"year":{"type":"integer","title":"Year"},"month":{"type":"integer","title":"Month"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["year","month","count"],"title":"KeywordSVMonthly"},"KeywordStatus":{"type":"string","enum":["awaiting","parsing","success","completed","error","dead_letter"],"title":"KeywordStatus"},"KeywordSuggestionItem":{"properties":{"text":{"type":"string","title":"Text"},"keyword_idea_metrics":{"$ref":"#/components/schemas/KeywordIdeaMetric"},"keyword_annotations":{"$ref":"#/components/schemas/KeywordAnnotations"}},"type":"object","required":["text","keyword_idea_metrics","keyword_annotations"],"title":"KeywordSuggestionItem"},"KeywordSuggestionRequest":{"properties":{"keywords":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Keywords"},"location_code":{"type":"integer","title":"Location Code"},"language_code":{"type":"string","title":"Language Code"},"page_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Page Url"}},"type":"object","required":["keywords","location_code","language_code"],"title":"KeywordSuggestionRequest"},"KeywordSuggestionResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/KeywordSuggestionItem"},"type":"array","title":"Results"},"aggregate_metric_results":{"items":{"$ref":"#/components/schemas/AggregateMetricResults"},"type":"array","title":"Aggregate Metric Results"}},"type":"object","required":["results","aggregate_metric_results"],"title":"KeywordSuggestionResponse"},"ListKeywordDataTask":{"properties":{"num_items":{"type":"integer","title":"Num Items"},"items":{"items":{"$ref":"#/components/schemas/KeywordDataTask"},"type":"array","title":"Items"},"cursor":{"title":"Cursor"}},"type":"object","required":["num_items","items","cursor"],"title":"ListKeywordDataTask"},"ListSearchEngine":{"properties":{"num_items":{"type":"integer","title":"Num Items"},"items":{"items":{"$ref":"#/components/schemas/SearchEngine"},"type":"array","title":"Items"},"cursor":{"title":"Cursor"}},"type":"object","required":["num_items","items","cursor"],"title":"ListSearchEngine"},"ListSerpTask":{"properties":{"num_items":{"type":"integer","title":"Num Items"},"items":{"items":{"$ref":"#/components/schemas/SerpTask"},"type":"array","title":"Items"},"cursor":{"title":"Cursor"}},"type":"object","required":["num_items","items","cursor"],"title":"ListSerpTask"},"PageStatus":{"type":"string","enum":["awaiting","queued_http","queued_browser","in_progress_http","in_progress_browser","success","failed","parsed"],"title":"PageStatus"},"RelatedQueryItem":{"properties":{"query":{"type":"string","title":"Query"},"value":{"type":"integer","title":"Value"}},"type":"object","required":["query","value"],"title":"RelatedQueryItem"},"SearchEngine":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"type_name":{"type":"string","title":"Type Name"},"system_name":{"type":"string","title":"System Name"},"country_name":{"type":"string","title":"Country Name"},"iso_code":{"type":"string","title":"Iso Code"},"language":{"type":"string","title":"Language"},"localization":{"type":"string","title":"Localization"}},"type":"object","required":["id","name","type_name","system_name","country_name","iso_code","language","localization"],"title":"SearchEngine"},"SerpTask":{"properties":{"id":{"type":"integer","title":"Id"},"user_id":{"type":"integer","title":"User Id"},"priority":{"type":"integer","title":"Priority","default":1},"dataforseo_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dataforseo Id"},"sharding":{"type":"integer","title":"Sharding","default":0},"retries_count":{"type":"integer","title":"Retries Count","default":0},"postback_retries_count":{"type":"integer","title":"Postback Retries Count","default":0},"keyword":{"type":"string","title":"Keyword"},"domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Domain"},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Name"},"competitors":{"anyOf":[{"items":{"$ref":"#/components/schemas/Competitor"},"type":"array"},{"type":"null"}],"title":"Competitors"},"engine_domain":{"type":"string","title":"Engine Domain"},"location_name":{"type":"string","title":"Location Name"},"iso_code":{"type":"string","title":"Iso Code"},"device":{"$ref":"#/components/schemas/Device","default":"desktop"},"language_code":{"type":"string","title":"Language Code"},"postback_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postback Url"},"engine_check_url":{"type":"string","title":"Engine Check Url"},"snapshot_hash":{"type":"string","title":"Snapshot Hash","default":""},"post_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Post Id"},"keyword_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Keyword Id"},"frequency":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Frequency","default":24},"user_agent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Agent"},"html_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Html Key"},"result":{"type":"object","title":"Result"},"status":{"$ref":"#/components/schemas/TaskStatus","default":"awaiting"},"created_on":{"type":"string","title":"Created On"},"created_at":{"type":"integer","title":"Created At"},"succeed_at":{"type":"integer","title":"Succeed At"},"ttl":{"type":"integer","title":"Ttl"}},"type":"object","required":["id","user_id","keyword","engine_domain","location_name","iso_code","language_code","postback_url","engine_check_url","post_id","result","created_on","created_at","succeed_at","ttl"],"title":"SerpTask"},"SuggestRequest":{"properties":{"keyword":{"type":"string","title":"Keyword"},"location_name":{"type":"string","title":"Location Name"},"iso_code":{"type":"string","title":"Iso Code"},"language_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language Code","default":"en"},"engine_name":{"$ref":"#/components/schemas/EngineName","default":"google"}},"type":"object","required":["keyword","location_name","iso_code"],"title":"SuggestRequest"},"SuggestResponse":{"properties":{"suggestions":{"items":{"type":"string"},"type":"array","title":"Suggestions"}},"type":"object","required":["suggestions"],"title":"SuggestResponse"},"TaskStatus":{"type":"string","enum":["awaiting","crawling","awaiting_webhook","parsing","success","completed","error","dead_letter"],"title":"TaskStatus"},"TrendInterestOverTimeItem":{"properties":{"date":{"type":"string","title":"Date"},"value":{"type":"integer","title":"Value"}},"type":"object","required":["date","value"],"title":"TrendInterestOverTimeItem"},"User":{"properties":{"id":{"type":"integer","title":"Id"},"api_key":{"type":"string","title":"Api Key"},"email":{"type":"string","title":"Email","default":""},"name":{"type":"string","title":"Name","default":""},"ttl":{"type":"integer","title":"Ttl","default":0},"enabled":{"type":"boolean","title":"Enabled","default":true}},"type":"object","required":["id","api_key"],"title":"User"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"OAuth2PasswordBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"token"}}}}}}