@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Botify API
@base https://api.botify.com/v1
@version 1.0.0
@auth ApiKey Authorization in header
@endpoints 26
@hint download_for_search
@toc analyses(21), projects(5)

@group analyses
@endpoint GET /analyses/{username}/{project_slug}
@optional {page: any, size: any}
@returns(200)

@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}
@returns(200)

@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/crawl_statistics
@returns(200)

@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/crawl_statistics/time
@required {frequency: any}
@optional {limit: any}
@returns(200)

@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/crawl_statistics/urls/{list_type}
@returns(200)

@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/features/ganalytics/orphan_urls/{medium}/{source}
@optional {page: any, size: any}
@returns(200)

@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/features/links/percentiles
@returns(200)

@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/features/pagerank/lost
@returns(200)

@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/features/sitemaps/report
@returns(200)

@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/features/sitemaps/samples/out_of_config
@optional {page: any, size: any}
@returns(200)

@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/features/sitemaps/samples/sitemap_only
@optional {page: any, size: any}
@returns(200)

@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/features/top_domains/domains
@optional {page: any, size: any}
@returns(200)

@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/features/top_domains/subdomains
@optional {page: any, size: any}
@returns(200)

@endpoint POST /analyses/{username}/{project_slug}/{analysis_slug}/urls
@optional {UrlsQuery: map, area: any, page: any, size: any}
@returns(200)

@endpoint POST /analyses/{username}/{project_slug}/{analysis_slug}/urls/aggs
@optional {UrlsAggsQueries: [map], area: any}
@returns(200)

@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/urls/datamodel
@optional {area: any}
@returns(200)

@endpoint POST /analyses/{username}/{project_slug}/{analysis_slug}/urls/export
@optional {UrlsQuery: map, area: any}
@returns(201)

@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/urls/export
@optional {page: any, size: any}
@returns(200)

@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/urls/export/{url_export_id}
@returns(200)

@endpoint POST /analyses/{username}/{project_slug}/{analysis_slug}/urls/suggested_filters
@optional {UrlsAggsQuery: map, area: any}
@returns(201)

@endpoint GET /analyses/{username}/{project_slug}/{analysis_slug}/urls/{url}
@optional {fields: any}
@returns(200)

@endgroup

@group projects
@endpoint GET /projects/{username}
@optional {page: any, size: any}
@returns(200)

@endpoint POST /projects/{username}/{project_slug}/features/url_rewriting/rules_validator
@returns(201)

@endpoint GET /projects/{username}/{project_slug}/filters
@optional {page: any, size: any}
@returns(200)

@endpoint GET /projects/{username}/{project_slug}/filters/{identifier}
@returns(200)

@endpoint POST /projects/{username}/{project_slug}/urls/aggs
@optional {UrlsAggsQueries: [map], area: any, last_analysis_slug: any, nb_analyses: any}
@returns(201)

@endgroup

@end