openapi-directory/api/botify.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Botify Saas API","title":"Botify","version":"1.0.0","x-apisguru-categories":["analytics","tools"],"x-logo":{"backgroundColor":"#1A1A1A","url":"https://static.botify.com/images/logos/botify-white.dc4215a12b9c.png"},"x-origin":[{"format":"swagger","url":"https://api.botify.com/v1/swagger.json","version":"2.0"}],"x-providerName":"botify.com"},"externalDocs":{"url":"https://developers.botify.com/"},"security":[{"DjangoRestToken":[]}],"paths":{"/analyses/{username}/{project_slug}":{"get":{"description":"List all analyses for a project","operationId":"getProjectAnalyses","parameters":[{"description":"Page Number","in":"query","name":"page","required":false,"schema":{"type":"integer","default":1}},{"description":"Page Size","in":"query","name":"size","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Return only successfully finished analyses","in":"query","name":"only_success","required":false,"schema":{"type":"boolean"}},{"description":"Which fields to return (comma-separated)","in":"query","name":"fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"properties":{"count":{"type":"integer"},"next":{"type":"string"},"page":{"type":"integer"},"previous":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Analysis"},"type":"array"},"size":{"type":"integer"}},"type":"object"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"List all analyses for a project","tags":["Project"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}}]},"/analyses/{username}/{project_slug}/{analysis_slug}":{"get":{"description":"Get an Analysis detail","operationId":"getAnalysisSummary","parameters":[{"description":"Previous analysis identifier","in":"query","name":"previous_crawl","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisDetail"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Get an Analysis detail","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}}],"put":{"description":"Update an Analysis' attribute","operationId":"updateAnalysis","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisUpdate"}}},"description":"Analysis Update"},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisUpdate"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Update an Analysis' attribute","tags":["Analysis"]}},"/analyses/{username}/{project_slug}/{analysis_slug}/crawl_statistics":{"get":{"description":"Return global statistics for an analysis","operationId":"getCrawlStatistics","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrawlStatistics"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Return global statistics for an analysis","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}}]},"/analyses/{username}/{project_slug}/{analysis_slug}/crawl_statistics/time":{"get":{"description":"Return crawl statistics grouped by time frequency (1 min, 5 mins or 60 min) for an analysis","operationId":"getCrawlStatisticsByFrequency","parameters":[{"description":"max number of elements to retrieve","in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Aggregation frequency","in":"query","name":"frequency","required":true,"schema":{"type":"string","enum":["1mn","5mn","60mn"]}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrawlStatisticsTime"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Return crawl statistics grouped by time frequency (1 min, 5 mins or 60 min)","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}}]},"/analyses/{username}/{project_slug}/{analysis_slug}/crawl_statistics/urls/{list_type}":{"get":{"description":"Return a list of 1000 latest URLs crawled (all crawled URLs or only URLS with HTTP errors)","operationId":"getCrawlStatisticsUrls","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CrawlStatisticsUrls"},"type":"array"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Return a list of 1000 latest URLs crawled (all crawled URLs or only URLS with HTTP errors)","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}},{"description":"URLs list type (crawled URLs or error URLs)","in":"path","name":"list_type","required":true,"schema":{"type":"string","enum":["crawled","errors"]}}]},"/analyses/{username}/{project_slug}/{analysis_slug}/features/ganalytics/orphan_urls/{medium}/{source}":{"get":{"description":"Legacy    List of Orphan URLs. URLs which generated visits from the selected source according to Google Analytics data, but were not crawled with by the Botify crawler (either because no links to them were found on the website, or because the crawler was not allowed to follow these links according to the project settings).   For a search engine (medium: origanic; sources: all, aol, ask, baidu, bing, google, naver, yahoo, yandex) or a social network (medium: social; sources: all, facebook, google+, linkedin, pinterest, reddit, tumblr, twitter)","operationId":"getGanalyticsOrphanURLs","parameters":[{"description":"Page Number","in":"query","name":"page","required":false,"schema":{"type":"integer","default":1}},{"description":"Page Size","in":"query","name":"size","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"properties":{"count":{"type":"integer"},"next":{"type":"string"},"page":{"type":"integer"},"previous":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/CrawlOrphanURLs"},"type":"array"},"size":{"type":"integer"}},"type":"object"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"List of Orphan URLs","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}},{"description":"Type of traffic, value: 'organic' (from search engine)or 'social' (from a social network)","in":"path","name":"medium","required":true,"schema":{"type":"string","enum":["organic","social"]}},{"description":"Traffic source, value: name of the search engine or social network","in":"path","name":"source","required":true,"schema":{"type":"string","enum":["all","aol","ask","baidu","bing","facebook","google","google+","linkedin","naver","pinterest","reddit","tumblr","twitter","yahoo","yandex"]}}]},"/analyses/{username}/{project_slug}/{analysis_slug}/features/links/percentiles":{"get":{"description":"Get inlinks percentiles","operationId":"getLinksPercentiles","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinksPercentiles"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Get inlinks percentiles","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}}]},"/analyses/{username}/{project_slug}/{analysis_slug}/features/pagerank/lost":{"get":{"description":"Lost pagerank","operationId":"getPageRankLost","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageRankLost"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Lost pagerank","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}}]},"/analyses/{username}/{project_slug}/{analysis_slug}/features/search_console/stats":{"get":{"description":"List clicks and impressions per day","operationId":"getKeywordsStats","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordsStats"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"List clicks and impressions per day","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}}]},"/analyses/{username}/{project_slug}/{analysis_slug}/features/sitemaps/report":{"get":{"description":"Get global information of the sitemaps found (sitemaps indexes, invalid sitemaps urls, etc.)","operationId":"getSitemapsReport","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitemapsReport"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Get global information of the sitemaps found (sitemaps indexes, invalid sitemaps urls, etc","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}}]},"/analyses/{username}/{project_slug}/{analysis_slug}/features/sitemaps/samples/out_of_config":{"get":{"description":"Sample list of URLs which were found in your sitemaps but outside of the crawl perimeter defined for the project, for instance domain/subdomain or protocol (HTTP/HTTPS) not allowed in the crawl settings.","operationId":"getSitemapsSamplesOutOfConfig","parameters":[{"description":"Page Number","in":"query","name":"page","required":false,"schema":{"type":"integer","default":1}},{"description":"Page Size","in":"query","name":"size","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"properties":{"count":{"type":"integer"},"next":{"type":"string"},"page":{"type":"integer"},"previous":{"type":"string"},"results":{"items":{"type":"string"},"type":"array"},"size":{"type":"integer"}},"type":"object"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Sample list of URLs which were found in your sitemaps but outside of the","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}}]},"/analyses/{username}/{project_slug}/{analysis_slug}/features/sitemaps/samples/sitemap_only":{"get":{"description":"Sample list of URLs which were found in your sitemaps, within the project allowed scope (allowed domains/subdomains/protocols), but not found by the Botify crawler.","operationId":"getSitemapsSamplesSitemapsOnly","parameters":[{"description":"Page Number","in":"query","name":"page","required":false,"schema":{"type":"integer","default":1}},{"description":"Page Size","in":"query","name":"size","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"properties":{"count":{"type":"integer"},"next":{"type":"string"},"page":{"type":"integer"},"previous":{"type":"string"},"results":{"items":{"type":"string"},"type":"array"},"size":{"type":"integer"}},"type":"object"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Sample list of URLs which were found in your sitemaps, within the project","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}}]},"/analyses/{username}/{project_slug}/{analysis_slug}/features/top_domains/domains":{"get":{"description":"Top domains","operationId":"getLinksTopDomains","parameters":[{"description":"Page Number","in":"query","name":"page","required":false,"schema":{"type":"integer","default":1}},{"description":"Page Size","in":"query","name":"size","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"properties":{"count":{"type":"integer"},"next":{"type":"string"},"page":{"type":"integer"},"previous":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/LinksTopDomains"},"type":"array"},"size":{"type":"integer"}},"type":"object"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Top domains","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}}]},"/analyses/{username}/{project_slug}/{analysis_slug}/features/top_domains/subdomains":{"get":{"description":"Top subddomains","operationId":"getLinksTopSubdomains","parameters":[{"description":"Page Number","in":"query","name":"page","required":false,"schema":{"type":"integer","default":1}},{"description":"Page Size","in":"query","name":"size","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"properties":{"count":{"type":"integer"},"next":{"type":"string"},"page":{"type":"integer"},"previous":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/LinksTopDomains"},"type":"array"},"size":{"type":"integer"}},"type":"object"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Top subddomains","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}}]},"/analyses/{username}/{project_slug}/{analysis_slug}/features/visits/orphan_urls/{medium}/{source}":{"get":{"description":"List of Orphan URLs. URLs which generated visits from the selected source according to Google Analytics data, but were not crawled with by the Botify crawler (either because no links to them were found on the website, or because the crawler was not allowed to follow these links according to the project settings).   For a search engine (medium: origanic; sources: all, aol, ask, baidu, bing, google, naver, yahoo, yandex) or a social network (medium: social; sources: all, facebook, google+, linkedin, pinterest, reddit, tumblr, twitter)","operationId":"getVisitsOrphanURLs","parameters":[{"description":"Page Number","in":"query","name":"page","required":false,"schema":{"type":"integer","default":1}},{"description":"Page Size","in":"query","name":"size","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"properties":{"count":{"type":"integer"},"next":{"type":"string"},"page":{"type":"integer"},"previous":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/CrawlOrphanURLs"},"type":"array"},"size":{"type":"integer"}},"type":"object"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"List of Orphan URLs","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}},{"description":"Type of traffic, value: 'organic' (from search engine)or 'social' (from a social network)","in":"path","name":"medium","required":true,"schema":{"type":"string","enum":["organic","social"]}},{"description":"Traffic source, value: name of the search engine or social network","in":"path","name":"source","required":true,"schema":{"type":"string","enum":["all","aol","ask","baidu","bing","facebook","google","google+","linkedin","naver","pinterest","reddit","tumblr","twitter","yahoo","yandex"]}}]},"/analyses/{username}/{project_slug}/{analysis_slug}/segments":{"get":{"description":"Get the segments feature public metadata of an analysis.","operationId":"getAnalysisSegments","parameters":[{"description":"Page Number","in":"query","name":"page","required":false,"schema":{"type":"integer","default":1}},{"description":"Page Size","in":"query","name":"size","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"properties":{"count":{"type":"integer"},"next":{"type":"string"},"page":{"type":"integer"},"previous":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/AnalysisSegments"},"type":"array"},"size":{"type":"integer"}},"type":"object"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Get the segments feature public metadata of an analysis","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}}]},"/analyses/{username}/{project_slug}/{analysis_slug}/staticfiles/robots-txt-indexes":{"get":{"description":"Return a list of all robots.txt files found on the project's domains.","operationId":"getRobotsTxtIndexesView","parameters":[{"description":"Page Number","in":"query","name":"page","required":false,"schema":{"type":"integer","default":1}},{"description":"Page Size","in":"query","name":"size","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"properties":{"count":{"type":"integer"},"next":{"type":"string"},"page":{"type":"integer"},"previous":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Default"},"type":"array"},"size":{"type":"integer"}},"type":"object"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Return a list of all robots","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}}]},"/analyses/{username}/{project_slug}/{analysis_slug}/staticfiles/robots-txt-indexes/{robots_txt}":{"get":{"description":"Return content of a robots.txt file.","operationId":"getRobotsTxtFileView","parameters":[{"description":"Page Number","in":"query","name":"page","required":false,"schema":{"type":"integer","default":1}},{"description":"Page Size","in":"query","name":"size","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"properties":{"count":{"type":"integer"},"next":{"type":"string"},"page":{"type":"integer"},"previous":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Default"},"type":"array"},"size":{"type":"integer"}},"type":"object"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Return content of a robots","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}},{"description":"Filename","in":"path","name":"robots_txt","required":true,"schema":{"type":"string"}}]},"/analyses/{username}/{project_slug}/{analysis_slug}/urls":{"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}}],"post":{"description":"Executes a query and returns a paginated response","operationId":"getUrls","parameters":[{"description":"Analysis context","in":"query","name":"area","required":false,"schema":{"type":"string","enum":["current","disappeared","new","search_engines_orphans","gsc_keywords","gsc_keywords_by_country"],"default":"current"}},{"description":"Page Number","in":"query","name":"page","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Page Size","in":"query","name":"size","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Previous analysis identifier","in":"query","name":"previous_crawl","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Query"},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"properties":{"count":{"type":"integer"},"next":{"type":"string"},"page":{"type":"integer"},"previous":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/UrlDetail"},"type":"array"},"size":{"type":"integer"}},"type":"object"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Executes a query and returns a paginated response","tags":["Analysis"]}},"/analyses/{username}/{project_slug}/{analysis_slug}/urls/aggs":{"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}}],"post":{"description":"Query aggregator. It accepts multiple queries and dispatches them on ES or BQ.","operationId":"getUrlsAggs","parameters":[{"description":"Analysis context","in":"query","name":"area","required":false,"schema":{"type":"string","enum":["current","disappeared","new","search_engines_orphans","gsc_keywords","gsc_keywords_by_country"],"default":"current"}},{"description":"Previous analysis identifier","in":"query","name":"previous_crawl","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/AggsQueries"},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Aggs"},"type":"array"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Query aggregator","tags":["Analysis"]}},"/analyses/{username}/{project_slug}/{analysis_slug}/urls/datamodel":{"get":{"description":"Gets an Analysis datamodel","operationId":"getUrlsDatamodel","parameters":[{"description":"Analysis context","in":"query","name":"area","required":false,"schema":{"type":"string","enum":["current","disappeared","new","search_engines_orphans","gsc_keywords","gsc_keywords_by_country"],"default":"current"}},{"description":"Previous analysis identifier","in":"query","name":"previous_crawl","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Datamodel"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Gets an Analysis datamodel","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}}]},"/analyses/{username}/{project_slug}/{analysis_slug}/urls/datasets":{"get":{"description":"Gets Analysis Datasets","operationId":"getUrlsDatasets","parameters":[{"description":"Analysis context","in":"query","name":"area","required":false,"schema":{"type":"string","enum":["current","disappeared","new","search_engines_orphans","gsc_keywords","gsc_keywords_by_country"],"default":"current"}},{"description":"Previous analysis identifier","in":"query","name":"previous_crawl","required":false,"schema":{"type":"string"}},{"description":"Include deprecated fields","in":"query","name":"deprecated_fields","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Datasets"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Gets Analysis Datasets","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}}]},"/analyses/{username}/{project_slug}/{analysis_slug}/urls/export":{"get":{"description":"A list of the CSV Exports requests and their current status","operationId":"getUrlsExports","parameters":[{"description":"Page Number","in":"query","name":"page","required":false,"schema":{"type":"integer","default":1}},{"description":"Page Size","in":"query","name":"size","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"properties":{"count":{"type":"integer"},"next":{"type":"string"},"page":{"type":"integer"},"previous":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/CsvExportStatus"},"type":"array"},"size":{"type":"integer"}},"type":"object"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"A list of the CSV Exports requests and their current status","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}}],"post":{"description":"Creates a new UrlExport object and starts a task that will export the results into a csv. Returns the model id that manages the task","operationId":"createUrlsExport","parameters":[{"description":"Analysis context","in":"query","name":"area","required":false,"schema":{"type":"string","enum":["current","disappeared","new","search_engines_orphans","gsc_keywords","gsc_keywords_by_country"],"default":"current"}},{"description":"Previous analysis identifier","in":"query","name":"previous_crawl","required":false,"schema":{"type":"string"}},{"description":"Maximum size of the export (deprecated => size instead)","in":"query","name":"export_size","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Maximum size of the export","in":"query","name":"size","required":false,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"$ref":"#/components/requestBodies/Query"},"responses":{"201":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CsvExportStatus"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Creates a new UrlExport object and starts a task that will export the results into a csv","tags":["Analysis"]}},"/analyses/{username}/{project_slug}/{analysis_slug}/urls/export/{url_export_id}":{"get":{"description":"Checks the status of an CSVUrlExportJob object. Returns json object with the status.","operationId":"getUrlsExportStatus","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CsvExportStatus"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Checks the status of an CSVUrlExportJob object","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}},{"description":"Url Export ID","in":"path","name":"url_export_id","required":true,"schema":{"type":"string"}}]},"/analyses/{username}/{project_slug}/{analysis_slug}/urls/html/{url}":{"get":{"description":"Gets the HTML of an URL for an analysis","operationId":"getUrlHTML","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UrlHTML"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Gets the HTML of an URL for an analysis","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}},{"description":"(Urlencoded) Searched URL","in":"path","name":"url","required":true,"schema":{"type":"string"}}]},"/analyses/{username}/{project_slug}/{analysis_slug}/urls/suggested_filters":{"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}}],"post":{"description":"Return most frequent segments (= suggested patterns in the previous version) for a Botify Query.","operationId":"getUrlsSuggestedFilters","parameters":[{"description":"Analysis context","in":"query","name":"area","required":false,"schema":{"type":"string","enum":["current","new"],"default":"current"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggsQuery"}}},"description":"AggsQuery"},"responses":{"201":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggsQuery"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Return most frequent segments (= suggested patterns in the previous version)","tags":["Analysis"]}},"/analyses/{username}/{project_slug}/{analysis_slug}/urls/{url}":{"get":{"description":"Gets the detail of an URL for an analysis","operationId":"getUrlDetail","parameters":[{"description":"comma separated list of fields to return (c.f. URLs Datamodel)","in":"query","name":"fields","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UrlDetail"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Gets the detail of an URL for an analysis","tags":["Analysis"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"Analysis' identifier","in":"path","name":"analysis_slug","required":true,"schema":{"type":"string"}},{"description":"(Urlencoded) Searched URL","in":"path","name":"url","required":true,"schema":{"type":"string"}}]},"/projects/{username}":{"get":{"description":"List all active projects for the user","operationId":"getUserProjects","parameters":[{"description":"Project's name","in":"query","name":"name","schema":{"type":"string"}},{"description":"Page Number","in":"query","name":"page","required":false,"schema":{"type":"integer","default":1}},{"description":"Page Size","in":"query","name":"size","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"properties":{"count":{"type":"integer"},"next":{"type":"string"},"page":{"type":"integer"},"previous":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Project"},"type":"array"},"size":{"type":"integer"}},"type":"object"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"List all active projects for the user","tags":["User"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}}]},"/projects/{username}/{project_slug}/automations":{"parameters":[{"description":"user to which belongs the project","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"identifies the project","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}}],"post":{"description":"Creates a new JobAutomation from data","operationId":"postJobAutomation","requestBody":{"$ref":"#/components/requestBodies/JobAutomation"},"responses":{"201":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAutomation"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Creates a new JobAutomation from data","tags":["JobAutomation"]}},"/projects/{username}/{project_slug}/automations/from/{job_id}":{"parameters":[{"description":"user to which belongs the project","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"identifies the project","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"the id of the existing job","in":"path","name":"job_id","required":true,"schema":{"type":"string"}}],"post":{"description":"Creates a new JobAutomation from an existing job","operationId":"postJobAutomationFromJob","requestBody":{"$ref":"#/components/requestBodies/JobAutomation"},"responses":{"201":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAutomation"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Creates a new JobAutomation from an existing job","tags":["JobAutomation"]}},"/projects/{username}/{project_slug}/collections":{"get":{"description":"List all collections for a project","operationId":"getProjectCollections","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collection"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"List all collections for a project","tags":["Collections"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}}]},"/projects/{username}/{project_slug}/collections/{collection}":{"get":{"description":"Get the detail of a collection","operationId":"getCollectionDetail","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionDatasets"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Get the detail of a collection","tags":["Collections"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"description":"The collection to query","in":"path","name":"collection","required":true,"schema":{"type":"string"}}]},"/projects/{username}/{project_slug}/filters":{"get":{"description":"List all the project's saved filters (each filter's name, ID and filter value)","operationId":"getSavedFilters","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectSavedFilter"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"List all the project's saved filters (each filter's name, ID and filter value)","tags":["Project"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}}]},"/projects/{username}/{project_slug}/filters/{identifier}":{"get":{"description":"Retrieves a specific saved filter's name, ID and filter value","operationId":"getSavedFilter","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectSavedFilter"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Retrieves a specific saved filter's name, ID and filter value","tags":["Project"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}},{"in":"path","name":"identifier","required":true,"schema":{"type":"string"}}]},"/projects/{username}/{project_slug}/urls/aggs":{"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"Project's identifier","in":"path","name":"project_slug","required":true,"schema":{"type":"string"}}],"post":{"description":"Project Query aggregator. It accepts multiple queries that will be executed on all completed analyses in the project","operationId":"getProjectUrlsAggs","parameters":[{"description":"Analyses context","in":"query","name":"area","required":false,"schema":{"type":"string","enum":["current","disappeared","new","gsc_keywords","gsc_keywords_by_country"],"default":"current"}},{"description":"Last analysis on the trend","in":"query","name":"last_analysis_slug","required":false,"schema":{"type":"string"}},{"description":"Max number of analysis to return","in":"query","name":"nb_analyses","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":20,"default":20}}],"requestBody":{"$ref":"#/components/requestBodies/AggsQueries"},"responses":{"201":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Default"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"Project Query aggregator","tags":["Project"]}},"/users/{username}/projects":{"get":{"description":"List all active projects for the user","operationId":"getAllUserProjects","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"default":{"description":"error payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultPayload"}}}}},"summary":"List all active projects for the user","tags":["Project"]},"parameters":[{"description":"User's identifier","in":"path","name":"username","required":true,"schema":{"type":"string"}}]}},"servers":[{"url":"https://api.botify.com/v1"}],"components":{"requestBodies":{"AggsQueries":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggsQueries"}}},"description":"AggsQueries"},"Query":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Query"}}},"description":"Query"},"JobAutomation":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAutomation"}}},"description":"Job automation creation"}},"securitySchemes":{"DjangoRestToken":{"in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"AdvancedExportStatus":{"properties":{"advanced_export_type":{"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"full_export":{"default":false,"type":"boolean"},"job_id":{"readOnly":true,"type":"string"},"job_status":{"readOnly":true,"type":"string"},"job_url":{"readOnly":true,"type":"string"},"query":{"readOnly":true,"type":"string"},"results":{"readOnly":true,"type":"string"},"user":{"readOnly":true,"type":"string"}},"required":["advanced_export_type"],"type":"object"},"AdvancedExporter":{"properties":{"full_export":{"default":false,"type":"boolean"},"group":{"type":"string"},"lines":{"format":"int64","type":"integer"},"name":{"type":"string"},"type":{"type":"string"}},"required":["type","name","group","lines"],"type":"object"},"AdvancedExporters":{"properties":{"exporters":{"items":{"$ref":"#/components/schemas/AdvancedExporter"},"type":"array"}},"required":["exporters"],"type":"object"},"Aggs":{"properties":{"error":{"$ref":"#/components/schemas/ErrorAgg"},"status":{"format":"int64","type":"integer"}},"required":["status"],"type":"object"},"AggsQueries":{"items":{"$ref":"#/components/schemas/AggsQuery"},"type":"array"},"AggsQuery":{"description":"AggsQuery","properties":{"aggs":{"items":{"type":"object"},"type":"array"},"filters":{"type":"object"}},"type":"object"},"AnalysesUpdateLaunch":{"description":"Launch Analyses Updates","properties":{"analyses":{"items":{"type":"string"},"type":"array"},"refresh_features":{"items":{"type":"string"},"type":"array"}},"required":["analyses","refresh_features"],"type":"object"},"Analysis":{"properties":{"comparable":{"readOnly":true,"type":"string"},"computing_revision":{"readOnly":true,"type":"string"},"config":{"readOnly":true,"type":"string"},"crawl_launch_type":{"readOnly":true,"type":"string"},"date_created":{"format":"date-time","type":"string"},"date_finished":{"format":"date-time","type":"string"},"date_last_modified":{"description":"Date of last modified analysis","format":"date-time","type":"string"},"date_launched":{"format":"date-time","type":"string"},"failures":{"readOnly":true,"type":"string"},"features":{"readOnly":true,"type":"string"},"friendly_name":{"readOnly":true,"type":"string"},"import_keywords_data":{"readOnly":true,"type":"string"},"import_keywords_data_by_country":{"readOnly":true,"type":"string"},"name":{"readOnly":true,"type":"string"},"owner":{"readOnly":true,"type":"string"},"pinned":{"type":"boolean"},"pins_balance":{"readOnly":true,"type":"string"},"red_button_domain":{"type":"string"},"slug":{"readOnly":true,"type":"string"},"status":{"readOnly":true,"type":"string"},"to_be_deleted_at":{"format":"date-time","type":"string"},"url":{"readOnly":true,"type":"string"},"urls_done":{"readOnly":true,"type":"string"},"urls_in_queue":{"readOnly":true,"type":"string"},"user":{"$ref":"#/components/schemas/User"}},"required":["user"],"type":"object"},"AnalysisDetail":{"properties":{"comparable":{"readOnly":true,"type":"string"},"computing_revision":{"readOnly":true,"type":"string"},"config":{"readOnly":true,"type":"string"},"crawl_launch_type":{"readOnly":true,"type":"string"},"date_created":{"format":"date-time","type":"string"},"date_finished":{"format":"date-time","type":"string"},"date_last_modified":{"description":"Date of last modified analysis","format":"date-time","type":"string"},"date_launched":{"format":"date-time","type":"string"},"failures":{"readOnly":true,"type":"string"},"features":{"readOnly":true,"type":"string"},"friendly_name":{"readOnly":true,"type":"string"},"import_keywords_data":{"readOnly":true,"type":"string"},"import_keywords_data_by_country":{"readOnly":true,"type":"string"},"name":{"readOnly":true,"type":"string"},"owner":{"readOnly":t