{"openapi":"3.1.0","info":{"title":"Profilers API","description":"Marketing Miner's public profilers (keywords) REST API in jsend standard.","version":"1.0.0","x-logo":{"url":"/logo.svg"}},"paths":{"/keywords/search-volume-data":{"get":{"tags":["keywords"],"summary":"Keyword Search Volume","description":"Returns monthly search volume, CPC, seasonality, difficulty, and SERP features for a single keyword in the given language. Use this for questions like 'how many people search for X' or 'is keyword Y trending'.","operationId":"keyword_search_volume","security":[{"Login via URL query parameter: `api_token`":[]}],"parameters":[{"description":"Authorization API key (token).","required":true,"schema":{"title":"Api Token","type":"string","description":"Authorization API key (token)."},"name":"api_token","in":"query"},{"name":"lang","in":"query","required":true,"schema":{"$ref":"#/components/schemas/LangEnum","description":"Language code: one of cs, sk, pl, hu, ro, gb, us. Determines target market."},"description":"Language code: one of cs, sk, pl, hu, ro, gb, us. Determines target market."},{"name":"keyword","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":80,"description":"Search keyword (2-80 chars).","title":"Keyword"},"description":"Search keyword (2-80 chars)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordsSuccessResponse"}}}},"401":{"description":"Not Authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden Access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"412":{"description":"Precondition Failed Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["keywords"],"summary":"Keywords Search Volume List","operationId":"Keywords_search_volume_list_keywords_search_volume_data_post","security":[{"Login via URL query parameter: `api_token`":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordsBodyRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordsSuccessResponse"}}}},"401":{"description":"Not Authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden Access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"412":{"description":"Precondition Failed Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"parameters":[{"description":"Authorization API key (token).","required":true,"schema":{"title":"Api Token","type":"string","description":"Authorization API key (token)."},"name":"api_token","in":"query"}]}},"/keywords/suggestions":{"get":{"tags":["keywords"],"summary":"Keyword Suggestions","description":"Returns related keyword suggestions (questions, new, trending) for the given seed keyword. Optionally includes search volume data per suggestion. Useful for keyword research and content ideation.","operationId":"keyword_suggestions","security":[{"Login via URL query parameter: `api_token`":[]}],"parameters":[{"description":"Authorization API key (token).","required":true,"schema":{"title":"Api Token","type":"string","description":"Authorization API key (token)."},"name":"api_token","in":"query"},{"name":"lang","in":"query","required":true,"schema":{"$ref":"#/components/schemas/LangEnum","description":"Language code: one of cs, sk, pl, hu, ro, gb, us. Determines target market."},"description":"Language code: one of cs, sk, pl, hu, ro, gb, us. Determines target market."},{"name":"keyword","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":80,"description":"Seed keyword to expand into suggestions (2-80 chars).","title":"Keyword"},"description":"Seed keyword to expand into suggestions (2-80 chars)."},{"name":"suggestions_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/SuggestionsTypeEnum"},{"type":"null"}],"description":"Filter by suggestion category: one of questions, new, trending.","title":"Suggestions Type"},"description":"Filter by suggestion category: one of questions, new, trending."},{"name":"with_keyword_data","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"If true, includes search volume and difficulty for each suggestion.","title":"With Keyword Data"},"description":"If true, includes search volume and difficulty for each suggestion."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Optional max number of returned rows (default 100, max 100).","default":100,"title":"Limit"},"description":"Optional max number of returned rows (default 100, max 100)."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":9900,"minimum":0,"description":"Optional number of rows to skip, for paging through the first 10000 rows (default 0, max 9900).","default":0,"title":"Offset"},"description":"Optional number of rows to skip, for paging through the first 10000 rows (default 0, max 9900)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordsSuccessResponse"}}}},"401":{"description":"Not Authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden Access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"412":{"description":"Precondition Failed Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["keywords"],"summary":"Keywords Suggestions List","operationId":"Keywords_suggestions_list_keywords_suggestions_post","security":[{"Login via URL query parameter: `api_token`":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordBodyRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordsSuccessResponse"}}}},"401":{"description":"Not Authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden Access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"412":{"description":"Precondition Failed Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"parameters":[{"description":"Authorization API key (token).","required":true,"schema":{"title":"Api Token","type":"string","description":"Authorization API key (token)."},"name":"api_token","in":"query"}]}},"/websites/stats-range":{"get":{"tags":["websites"],"summary":"Website Stats Range","description":"Returns time-series SEO statistics for a website — traffic estimates, ranking keyword counts, ROI metrics across multiple periods. Optionally includes competitor comparison.","operationId":"website_stats_range","security":[{"Login via URL query parameter: `api_token`":[]}],"parameters":[{"description":"Authorization API key (token).","required":true,"schema":{"title":"Api Token","type":"string","description":"Authorization API key (token)."},"name":"api_token","in":"query"},{"name":"lang","in":"query","required":true,"schema":{"$ref":"#/components/schemas/LangEnum","description":"Language code: one of cs, sk, pl, hu, ro, gb, us. Determines target market."},"description":"Language code: one of cs, sk, pl, hu, ro, gb, us. Determines target market."},{"name":"type","in":"query","required":true,"schema":{"$ref":"#/components/schemas/WebsiteTypeEnum","description":"Target type: one of domain, subdomain, exact, or prefix."},"description":"Target type: one of domain, subdomain, exact, or prefix."},{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":3,"maxLength":253,"description":"Target website value (domain, subdomain, or URL depending on type).","title":"Target"},"description":"Target website value (domain, subdomain, or URL depending on type)."},{"name":"scheme","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/WebsiteSchemeEnum"},{"type":"null"}],"description":"Optional URL scheme for exact/prefix types (http or https).","title":"Scheme"},"description":"Optional URL scheme for exact/prefix types (http or https)."},{"name":"period","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/WebsitePeriodEnum"},{"type":"null"}],"description":"Time bucket granularity for the series (e.g. monthly).","title":"Period"},"description":"Time bucket granularity for the series (e.g. monthly)."},{"name":"competitors","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"JSON-encoded array of competitor targets. Each item must be an object with `target` (str) and `type` (one of subdomain, domain, exact, prefix). Example: `[{\"target\":\"akcniceny.cz\",\"type\":\"subdomain\"}]`. Comma-separated lists are NOT supported.","title":"Competitors"},"description":"JSON-encoded array of competitor targets. Each item must be an object with `target` (str) and `type` (one of subdomain, domain, exact, prefix). Example: `[{\"target\":\"akcniceny.cz\",\"type\":\"subdomain\"}]`. Comma-separated lists are NOT supported."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebsitesStatsSuccessResponse"}}}},"401":{"description":"Not Authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden Access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"412":{"description":"Precondition Failed Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["websites"],"summary":"Websites Suggestions Stats Range","operationId":"Websites_suggestions_stats_range_websites_stats_range_post","security":[{"Login via URL query parameter: `api_token`":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatsRangeWebsiteBodyRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebsitesStatsSuccessResponse"}}}},"401":{"description":"Not Authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden Access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"412":{"description":"Precondition Failed Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"parameters":[{"description":"Authorization API key (token).","required":true,"schema":{"title":"Api Token","type":"string","description":"Authorization API key (token)."},"name":"api_token","in":"query"}]}},"/websites/stats":{"get":{"tags":["websites"],"summary":"Website Stats","description":"Returns current (latest period) SEO statistics for a website — visibility, traffic estimate, ranking keyword count.","operationId":"website_stats","security":[{"Login via URL query parameter: `api_token`":[]}],"parameters":[{"description":"Authorization API key (token).","required":true,"schema":{"title":"Api Token","type":"string","description":"Authorization API key (token)."},"name":"api_token","in":"query"},{"name":"lang","in":"query","required":true,"schema":{"$ref":"#/components/schemas/LangEnum","description":"Language code: one of cs, sk, pl, hu, ro, gb, us. Determines target market."},"description":"Language code: one of cs, sk, pl, hu, ro, gb, us. Determines target market."},{"name":"type","in":"query","required":true,"schema":{"$ref":"#/components/schemas/WebsiteTypeEnum","description":"Target type: one of domain, subdomain, exact, or prefix."},"description":"Target type: one of domain, subdomain, exact, or prefix."},{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":3,"maxLength":253,"description":"Target website value (domain, subdomain, or URL depending on type).","title":"Target"},"description":"Target website value (domain, subdomain, or URL depending on type)."},{"name":"scheme","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/WebsiteSchemeEnum"},{"type":"null"}],"description":"Optional URL scheme for exact/prefix types (http or https).","title":"Scheme"},"description":"Optional URL scheme for exact/prefix types (http or https)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebsitesStatsSuccessResponse"}}}},"401":{"description":"Not Authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden Access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"412":{"description":"Precondition Failed Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["websites"],"summary":"Websites Suggestions Stats","operationId":"Websites_suggestions_stats_websites_stats_post","security":[{"Login via URL query parameter: `api_token`":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebsiteBodyRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebsitesStatsSuccessResponse"}}}},"401":{"description":"Not Authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden Access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"412":{"description":"Precondition Failed Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"parameters":[{"description":"Authorization API key (token).","required":true,"schema":{"title":"Api Token","type":"string","description":"Authorization API key (token)."},"name":"api_token","in":"query"}]}}},"components":{"schemas":{"Competitor":{"properties":{"competitor_name":{"type":"string","title":"Competitor Name"},"competitor_type":{"$ref":"#/components/schemas/WebsiteTypeEnum"}},"type":"object","required":["competitor_name","competitor_type"],"title":"Competitor"},"CpcData":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"},"text":{"type":"string","title":"Text","description":"Simple value formatted string"},"currency_code":{"anyOf":[{"$ref":"#/components/schemas/CurrencyEnum"},{"type":"null"}]}},"type":"object","required":["value","currency_code"],"title":"CpcData","description":"CPC data model structure ","example":{"currency_code":"EUR","text":"1.23 €","value":1.23}},"CurrencyEnum":{"type":"string","enum":["USD","EUR","CZK","PLN","HUF","RON","GBP"],"title":"CurrencyEnum","description":"Available currencies enum (codes: `USD`, `EUR`, `CZK`, `PLN`, `HUF`, `RON`, `GBP`) "},"ErrorResponse":{"properties":{"status":{"type":"string","title":"Status","default":"error","example":"error"},"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"ErrorResponse","description":"Error data response structure ","example":{"message":"Some error message","status":"error"}},"ExportData":{"properties":{"csv_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Csv Url"},"rows_count":{"type":"integer","title":"Rows Count"},"credits_cost":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits Cost"}},"type":"object","required":["csv_url","rows_count","credits_cost"],"title":"ExportData","description":"Export(ed) data model structure ","example":{"credits_cost":5000,"rows_count":1000,"url":"https://export.marketingminer.com/some-website-with-unqiue-hash.csv"}},"FilterData":{"properties":{"field":{"$ref":"#/components/schemas/FilterFieldEnum"},"operator":{"$ref":"#/components/schemas/FilterOperatorEnum"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"}]},"type":"array"}],"title":"Value","description":"Strings (with max. 80 chars length + whitespaces will be cropped) or numbers."}},"type":"object","required":["field","operator","value"],"title":"FilterData","description":"Website data model structure ","example":{"field":"keyword","operator":"like","value":"test"}},"FilterFieldEnum":{"type":"string","enum":["cpc","date","difficulty","estimated_traffic","estimated_traffic_change","keyword","peak_month","position","position_change","result_type","search_volume","serp_features","total_position","url","yoy_change","keyword_count","avg_position","avg_position_change","same_keywords","same_percentage","number_of_competitors","number_of_landing_pages","movements"],"title":"FilterFieldEnum","description":"Available filter fields (columns) enum "},"FilterOperatorEnum":{"type":"string","enum":["eq","ne","like","not_like","gt","lt","gte","lte","between","isin","notin","isnull","notnull"],"title":"FilterOperatorEnum","description":"Available filter (SQL query) operators enum "},"KeywordBodyRequest":{"properties":{"lang":{"$ref":"#/components/schemas/LangEnum"},"keyword":{"type":"string","maxLength":80,"minLength":2,"title":"Keyword","description":"Input single keyword as body parameter."},"filters":{"items":{"$ref":"#/components/schemas/FilterData"},"type":"array","title":"Filters","description":"Input filters list (<=10) as list in body parameter."},"suggestions_type":{"anyOf":[{"$ref":"#/components/schemas/SuggestionsTypeEnum"},{"type":"null"}],"description":"Possible specific suggestions type for filter data."},"with_keyword_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"With Keyword Data","description":"Possible extension of the output with keyword data (difficulty & serp_features)."},"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","description":"Max number of returned suggestions rows (default 100, max 100).","default":100},"offset":{"type":"integer","maximum":9900.0,"minimum":0.0,"title":"Offset","description":"Number of suggestions rows to skip, for paging through the first 10000 rows (default 0, max 9900).","default":0}},"type":"object","required":["lang","keyword"],"title":"KeywordBodyRequest","description":"Keyword body request model structure ","example":{"filters":[{"field":"keyword","operator":"contains_not","value":"test"}],"keyword":"test","lang":"cs","limit":100,"offset":0,"suggestions_type":"some-suggestions-type-or-nothing","with_keyword_data":false}},"KeywordSearchVolumeData":{"properties":{"keyword":{"type":"string","title":"Keyword"},"search_volume":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Search Volume"},"cpc":{"$ref":"#/components/schemas/CpcData"},"yoy_change":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Yoy Change"},"peak_month":{"type":"string","format":"date","title":"Peak Month","example":"Y-m-d"},"monthly_sv":{"additionalProperties":{"type":"integer"},"type":"object","title":"Monthly Sv"}},"type":"object","required":["keyword","search_volume","cpc","yoy_change","monthly_sv"],"title":"KeywordSearchVolumeData","description":"Keyword Search Volume data model structure ","example":{"cpc":{"currency_code":"EUR","text":"1.23 €","value":1.23},"keyword":"test","monthly_sv":{"01":101,"02":102,"03":103,"04":104,"05":105,"06":106,"07":107,"08":108,"09":109,"10":110,"11":111,"12":112},"peak_month":"2020-12-01","search_volume":10,"yoy_change":0.1}},"KeywordSuggestionsData":{"properties":{"keyword":{"type":"string","title":"Keyword"},"search_volume":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Search Volume"},"cpc":{"$ref":"#/components/schemas/CpcData"},"difficulty":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Difficulty"},"serp_features":{"items":{"type":"string"},"type":"array","title":"Serp Features"},"yoy_change":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Yoy Change"},"peak_month":{"type":"string","format":"date","title":"Peak Month","example":"Y-m-d"},"monthly_sv":{"additionalProperties":{"type":"integer"},"type":"object","title":"Monthly Sv"}},"type":"object","required":["keyword","search_volume","cpc","difficulty","serp_features","yoy_change","monthly_sv"],"title":"KeywordSuggestionsData","description":"Keyword Suggestions data model structure ","example":{"cpc":{"currency_code":"EUR","text":"1.23 €","value":1.23},"difficulty":99,"keyword":"test","monthly_sv":{"01":101,"02":102,"03":103,"04":104,"05":105,"06":106,"07":107,"08":108,"09":109,"10":110,"11":111,"12":112},"peak_month":"2020-12-01","search_volume":10,"serp_features":["paid","videos","images"],"yoy_change":0.1}},"KeywordsBodyRequest":{"properties":{"lang":{"$ref":"#/components/schemas/LangEnum"},"keywords":{"items":{"anyOf":[{"type":"string","maxLength":80,"minLength":2},{"type":"null"}]},"type":"array","maxItems":1000,"minItems":1,"title":"Keywords","description":"Input keywords list (<=1000) as body parameter."},"filters":{"anyOf":[{"items":{"$ref":"#/components/schemas/FilterData"},"type":"array"},{"type":"null"}],"title":"Filters","description":"Input filters list (<=10) as list in body parameter."}},"type":"object","required":["lang","keywords"],"title":"KeywordsBodyRequest","description":"Keywords body request model structure ","example":{"filters":[{"field":"keyword","operator":"contains_not","value":"test"}],"keywords":["test"],"lang":"cs"}},"KeywordsData":{"properties":{"keywords":{"items":{"$ref":"#/components/schemas/KeywordSuggestionsData"},"type":"array","title":"Keywords"},"rows_count":{"type":"integer","title":"Rows Count"},"export_credits_cost":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Export Credits Cost"}},"type":"object","required":["keywords","rows_count","export_credits_cost"],"title":"KeywordsData","description":"Keywords data model structure ","example":{"credits_cost":5,"keywords":{"cpc":1.0,"keyword":"test","monthly_sv":{"01":101,"02":102,"03":103,"04":104,"05":105,"06":106,"07":107,"08":108,"09":109,"10":110,"11":111,"12":112},"peak_month":"2020-12-01","search_volume":10,"yoy_change":0.1},"rows_count":1}},"KeywordsSuccessResponse":{"properties":{"status":{"type":"string","title":"Status","default":"success","example":"success"},"data":{"anyOf":[{"items":{"$ref":"#/components/schemas/KeywordSearchVolumeData"},"type":"array"},{"$ref":"#/components/schemas/KeywordsData"},{"$ref":"#/components/schemas/ExportData"}],"title":"Data"}},"type":"object","required":["data"],"title":"KeywordsSuccessResponse","description":"Keywords success data response structure ","example":{"data":[],"status":"success"}},"LangEnum":{"type":"string","enum":["cs","sk","pl","hu","ro","gb","us"],"title":"LangEnum","description":"Available languages enum (codes: `cs`, `sk`, `pl`, `hu`, `gb`, `us`, `hu`) "},"ResultTypeEnum":{"type":"string","enum":["organic","paid","knowledge_graph","shopping_ads","images","videos","find_on_website","people_also_ask","featured_snippet","news_box","local_pack","ai_overviews"],"title":"ResultTypeEnum","description":"Available result types enum "},"StatsRangeWebsiteBodyRequest":{"properties":{"lang":{"$ref":"#/components/schemas/LangEnum"},"type":{"$ref":"#/components/schemas/WebsiteTypeEnum"},"target":{"type":"string","maxLength":253,"minLength":3,"title":"Target","description":"Input target website value (depending on type) as body parameter."},"scheme":{"anyOf":[{"$ref":"#/components/schemas/WebsiteSchemeEnum"},{"type":"null"}]},"filters":{"items":{"$ref":"#/components/schemas/FilterData"},"type":"array","title":"Filters","description":"Input filters list (<=10) as list in body parameter."},"period":{"anyOf":[{"$ref":"#/components/schemas/WebsitePeriodEnum"},{"type":"null"}]},"competitors":{"anyOf":[{"items":{"$ref":"#/components/schemas/Competitor"},"type":"array"},{"type":"null"}],"title":"Competitors"}},"type":"object","required":["lang","type","target"],"title":"StatsRangeWebsiteBodyRequest","description":"Website stats range body request model structure ","example":{"competitors":[{"competitor_name":"bar.foo","competitor_type":"subdomain"}],"filters":[{"field":"domain","operator":"contains_not","value":"test"}],"lang":"cs","period":"daily","scheme":"https","target":"foo.bar/test","type":"exact"}},"SuggestionsTypeEnum":{"type":"string","enum":["questions","new","trending"],"title":"SuggestionsTypeEnum","description":"Available (possible specific) suggestions types enum "},"ValidationErrorData":{"properties":{"loc":{"items":{"type":"string"},"type":"array","title":"Loc"},"msg":{"type":"string","title":"Msg"},"type":{"type":"string","title":"Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationErrorData","description":"Validation error data model structure ","example":{"loc":["body","size"],"msg":"value is not a valid integer","type":"type_error.integer"}},"ValidationErrorResponse":{"properties":{"status":{"type":"string","title":"Status","default":"fail","example":"fail"},"data":{"items":{"$ref":"#/components/schemas/ValidationErrorData"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"ValidationErrorResponse","description":"Error data response structure ","example":{"data":{"loc":["body","size"],"msg":"value is not a valid integer","type":"type_error.integer"},"status":"fail"}},"WebsiteBodyRequest":{"properties":{"lang":{"$ref":"#/components/schemas/LangEnum"},"type":{"$ref":"#/components/schemas/WebsiteTypeEnum"},"target":{"type":"string","maxLength":253,"minLength":3,"title":"Target","description":"Input target website value (depending on type) as body parameter."},"scheme":{"anyOf":[{"$ref":"#/components/schemas/WebsiteSchemeEnum"},{"type":"null"}]},"filters":{"items":{"$ref":"#/components/schemas/FilterData"},"type":"array","title":"Filters","description":"Input filters list (<=10) as list in body parameter."},"period":{"anyOf":[{"$ref":"#/components/schemas/WebsitePeriodEnum"},{"type":"null"}]}},"type":"object","required":["lang","type","target"],"title":"WebsiteBodyRequest","description":"Website body request model structure ","example":{"filters":[{"field":"domain","operator":"contains_not","value":"test"}],"lang":"cs","period":"daily","scheme":"https","target":"foo.bar/test","type":"exact"}},"WebsitePeriodEnum":{"type":"string","enum":["daily","weekly","monthly"],"title":"WebsitePeriodEnum","description":"Available website periods"},"WebsiteSchemeEnum":{"type":"string","enum":["https","http"],"title":"WebsiteSchemeEnum","description":"Available websites specific schemes (optional, but depends on URL based website types) enum "},"WebsiteStatsData":{"properties":{"result_type":{"type":"string","title":"Result Type"},"estimated_traffic":{"type":"integer","title":"Estimated Traffic"},"estimated_traffic_change":{"type":"integer","title":"Estimated Traffic Change"},"number_of_keywords":{"type":"integer","title":"Number Of Keywords"}},"type":"object","required":["result_type","estimated_traffic","estimated_traffic_change","number_of_keywords"],"title":"WebsiteStatsData","description":"Website stats data model structure ","example":{"estimated_traffic":1,"estimated_traffic_change":2,"number_of_keywords":3,"result_type":"organic"}},"WebsiteStatsRangeCompetitorData":{"properties":{"competitor_title":{"type":"string","title":"Competitor Title"},"competitor_stats":{"items":{"$ref":"#/components/schemas/WebsiteStatsRangeData"},"type":"array","title":"Competitor Stats"}},"type":"object","required":["competitor_title","competitor_stats"],"title":"WebsiteStatsRangeCompetitorData","description":"Website stats range competitor data model structure ","competitor_stats":[{"date":"2020-09-30","estimated_traffic":11122},{"date":"2020-09-30","estimated_traffic":11122}],"competitor_title":"mall.cz"},"WebsiteStatsRangeData":{"properties":{"date":{"type":"string","title":"Date"},"result_type":{"anyOf":[{"$ref":"#/components/schemas/ResultTypeEnum"},{"type":"null"}]},"estimated_traffic":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Estimated Traffic"}},"type":"object","required":["date","result_type","estimated_traffic"],"title":"WebsiteStatsRangeData","description":"Website stats range data model structure ","example":{"date":"2020-12-31","estimated_traffic":1,"result_type":"organic"}},"WebsiteTypeEnum":{"type":"string","enum":["exact","prefix","domain","subdomain"],"title":"WebsiteTypeEnum","description":"Available websites types enum "},"WebsitesStatsData":{"properties":{"stats":{"items":{"$ref":"#/components/schemas/WebsiteStatsData"},"type":"array","title":"Stats"},"estimated_traffic_sum":{"type":"integer","title":"Estimated Traffic Sum"},"estimated_traffic_change_sum":{"type":"integer","title":"Estimated Traffic Change Sum"},"number_of_keywords_sum":{"type":"integer","title":"Number Of Keywords Sum"}},"type":"object","required":["stats","estimated_traffic_sum","estimated_traffic_change_sum","number_of_keywords_sum"],"title":"WebsitesStatsData","description":"Websites stats data model structure ","example":{"estimated_traffic_change_sum":4,"estimated_traffic_sum":2,"number_of_keywords_sum":6,"stats":[{"estimated_traffic":1,"number_of_keywords":3,"result_type":"organic"},{"estimated_traffic":1,"estimated_traffic_change":2,"number_of_keywords":3,"result_type":"paid"}]}},"WebsitesStatsRangeData":{"properties":{"stats_range":{"items":{"$ref":"#/components/schemas/WebsiteStatsRangeData"},"type":"array","title":"Stats Range"},"competitors":{"anyOf":[{"items":{"$ref":"#/components/schemas/WebsiteStatsRangeCompetitorData"},"type":"array"},{"type":"null"}],"title":"Competitors"}},"type":"object","required":["stats_range"],"title":"WebsitesStatsRangeData","description":"Websites stats range data model structure ","competitors":[{"competitor_stats":[{"date":"2020-09-30","estimated_traffic":11122},{"date":"2020-09-30","estimated_traffic":11122}],"competitor_title":"mall.cz"}],"stats_range":[{"date":"2020-09-30","estimated_traffic":11122,"result_type":"paid"},{"date":"2020-09-30","estimated_traffic":11122,"result_type":"organic"}]},"WebsitesStatsSuccessResponse":{"properties":{"status":{"type":"string","title":"Status","default":"success","example":"success"},"data":{"anyOf":[{"items":{"$ref":"#/components/schemas/WebsiteStatsData"},"type":"array"},{"$ref":"#/components/schemas/WebsitesStatsRangeData"},{"$ref":"#/components/schemas/WebsitesStatsData"}],"title":"Data"}},"type":"object","required":["data"],"title":"WebsitesStatsSuccessResponse","description":"Websites success data response structure ","example":{"data":[],"status":"success"}}},"securitySchemes":{"Login via URL query parameter: `api_token`":{"type":"apiKey","in":"query","name":"api_token"}}}}