{"note":"OpenAPI conversion -- returning structured metadata","name":"botify-com","description":"Botify API","version":"1.0.0","base_url":"https://api.botify.com/v1","endpoints":26,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Botify API\n@base https://api.botify.com/v1\n@version 1.0.0\n@auth ApiKey Authorization in header\n@endpoints 26\n@hint download_for_search\n@toc analyses(21), projects(5)\n\n@group analyses\n@endpoint GET /analyses/{username}/{project_slug}\n@desc List all analyses for a project\n@optional {page: any # Page Number, size: any # Page Size}\n@returns(200) Successful operation\n\n@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}\n@desc Get an Analysis detail\n@returns(200) Successful operation\n\n@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/crawl_statistics\n@desc Return global statistics for an analysis\n@returns(200) Successful operation\n\n@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/crawl_statistics/time\n@desc Return crawl statistics grouped by time frequency (1 min, 5 mins or 60 min)\n@required {frequency: any # Aggregation frequency}\n@optional {limit: any # max number of elements to retrieve}\n@returns(200) Successful operation\n\n@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/crawl_statistics/urls/{list_type}\n@desc Return a list of 1000 latest URLs crawled (all crawled URLs or only URLS with HTTP errors)\n@returns(200)\n\n@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/features/ganalytics/orphan_urls/{medium}/{source}\n@desc List of Orphan URLs\n@optional {page: any # Page Number, size: any # Page Size}\n@returns(200) Successful operation\n\n@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/features/links/percentiles\n@desc Get inlinks percentiles\n@returns(200) Successful operation\n\n@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/features/pagerank/lost\n@desc Lost pagerank\n@returns(200) Successful operation\n\n@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/features/sitemaps/report\n@desc Get global information of the sitemaps found (sitemaps indexes, invalid sitemaps urls, etc\n@returns(200) Successful operation\n\n@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/features/sitemaps/samples/out_of_config\n@desc Sample list of URLs which were found in your sitemaps but outside of the\n@optional {page: any # Page Number, size: any # Page Size}\n@returns(200) Successful operation\n\n@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/features/sitemaps/samples/sitemap_only\n@desc Sample list of URLs which were found in your sitemaps, within the project\n@optional {page: any # Page Number, size: any # Page Size}\n@returns(200) Successful operation\n\n@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/features/top_domains/domains\n@desc Top domains\n@optional {page: any # Page Number, size: any # Page Size}\n@returns(200) Successful operation\n\n@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/features/top_domains/subdomains\n@desc Top subddomains\n@optional {page: any # Page Number, size: any # Page Size}\n@returns(200) Successful operation\n\n@endpoint POST /analyses/{username}/{project_slug}/{analysis_slug}/urls\n@desc Executes a query and returns a paginated response\n@optional {UrlsQuery: map, area: any # Analysis context to execute the query, page: any # Page Number, size: any # Page Size}\n@returns(200) Successful operation\n\n@endpoint POST /analyses/{username}/{project_slug}/{analysis_slug}/urls/aggs\n@desc Query aggregator\n@optional {UrlsAggsQueries: [map], area: any}\n@returns(200)\n\n@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/urls/datamodel\n@desc Gets an Analysis datamodel\n@optional {area: any}\n@returns(200) Successful operation\n\n@endpoint POST /analyses/{username}/{project_slug}/{analysis_slug}/urls/export\n@desc Creates a new UrlExport object and starts a task that will export the results into a csv\n@optional {UrlsQuery: map, area: any}\n@returns(201) Successful operation\n\n@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/urls/export\n@desc A list of the CSV Exports requests and their current status\n@optional {page: any # Page Number, size: any # Page Size}\n@returns(200) Successful operation\n\n@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/urls/export/{url_export_id}\n@desc Checks the status of an CSVUrlExportJob object\n@returns(200) Successful operation\n\n@endpoint POST /analyses/{username}/{project_slug}/{analysis_slug}/urls/suggested_filters\n@desc Return most frequent segments (= suggested patterns in the previous version)\n@optional {UrlsAggsQuery: map, area: any}\n@returns(201) Successful operation\n\n@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/urls/{url}\n@desc Gets the detail of an URL for an analysis\n@optional {fields: any # comma separated list of fields to return (c.f. URLs Datamodel)}\n@returns(200) Successful operation\n\n@endgroup\n\n@group projects\n@endpoint GET /projects/{username}\n@desc List all active projects for the user\n@optional {page: any # Page Number, size: any # Page Size}\n@returns(200) Successful operation\n\n@endpoint POST /projects/{username}/{project_slug}/features/url_rewriting/rules_validator\n@desc Match and replace parts of a URL based on rules passed in POST data\n@returns(201) Successful operation\n\n@endpoint GET /projects/{username}/{project_slug}/filters\n@desc List all the project's saved filters (each filter's name, ID and filter value)\n@optional {page: any # Page Number, size: any # Page Size}\n@returns(200) Successful operation\n\n@endpoint GET /projects/{username}/{project_slug}/filters/{identifier}\n@desc Retrieves a specific saved filter's name, ID and filter value\n@returns(200) Successful operation\n\n@endpoint POST /projects/{username}/{project_slug}/urls/aggs\n@desc Project Query aggregator\n@optional {UrlsAggsQueries: [map], area: any # Analysis context to execute the queries, last_analysis_slug: any # Last analysis on the trend, nb_analyses: any # Max number of analysis to return}\n@returns(201) Successful operation\n\n@endgroup\n\n@end\n"}